public class TomcatManager
extends org.codehaus.cargo.util.log.LoggedObject
Constructor and Description |
---|
TomcatManager(URL url)
Creates a Tomcat manager wrapper for the specified URL that uses a username of
admin , an empty password and ISO-8859-1 URL encoding. |
TomcatManager(URL url,
String username)
Creates a Tomcat manager wrapper for the specified URL and username that uses an empty
password and ISO-8859-1 URL encoding.
|
TomcatManager(URL url,
String username,
String password)
Creates a Tomcat manager wrapper for the specified URL, username and password that uses
ISO-8859-1 URL encoding.
|
TomcatManager(URL url,
String username,
String password,
String charset)
Creates a Tomcat manager wrapper for the specified URL, username, password and URL encoding.
|
Modifier and Type | Method and Description |
---|---|
void |
deploy(String path,
InputStream war)
Deploys the specified WAR as a HTTP PUT to the specified context path.
|
void |
deploy(String path,
InputStream war,
boolean update)
Deploys the specified WAR as a HTTP PUT to the specified context path, optionally undeploying
the webapp if it already exists.
|
void |
deploy(String path,
InputStream war,
boolean update,
String tag)
Deploys the specified WAR as a HTTP PUT to the specified context path, optionally undeploying
the webapp if it already exists and using the specified tag name.
|
void |
deploy(String path,
URL war)
Deploys the specified WAR as a URL to the specified context path.
|
void |
deploy(String path,
URL war,
boolean update)
Deploys the specified WAR as a URL to the specified context path, optionally undeploying the
webapp if it already exists.
|
void |
deploy(String path,
URL war,
boolean update,
String tag)
Deploys the specified WAR as a URL to the specified context path, optionally undeploying the
webapp if it already exists and using the specified tag name.
|
void |
deployContext(String path,
URL config)
Deploys the specified context XML configuration to the specified context path.
|
void |
deployContext(String path,
URL config,
boolean update)
Deploys the specified context XML configuration to the specified context path, optionally
undeploying the webapp if it already exists.
|
void |
deployContext(String path,
URL config,
boolean update,
String tag)
Deploys the specified context XML configuration to the specified context path, optionally
undeploying the webapp if it already exists and using the specified tag name.
|
void |
deployContext(String path,
URL config,
URL war)
Deploys the specified context XML configuration and WAR as a URL to the specified context
path.
|
void |
deployContext(String path,
URL config,
URL war,
boolean update)
Deploys the specified context XML configuration and WAR as a URL to the specified context
path, optionally undeploying the webapp if it already exists.
|
void |
deployContext(String path,
URL config,
URL war,
boolean update,
String tag)
Deploys the specified context XML configuration and WAR as a URL to the specified context
path, optionally undeploying the webapp if it already exists and using the specified tag
name.
|
String |
getCharset()
Gets the URL encoding charset to use when communicating with Tomcat manager.
|
String |
getPassword()
Gets the password to use when authenticating with Tomcat manager.
|
TomcatDeployableStatus |
getStatus(String path)
Return the status of the webapp at the specified context path.
|
URL |
getURL()
Gets the full URL of the Tomcat manager instance.
|
String |
getUserAgent()
Gets the user agent name to use when communicating with Tomcat manager.
|
String |
getUserName()
Gets the username to use when authenticating with Tomcat manager.
|
protected void |
invoke(String path)
Invokes Tomcat manager with the specified command.
|
protected String |
invoke(String path,
InputStream data)
Invokes Tomcat manager with the specified command and content data.
|
String |
list()
List currently deployed webapps.
|
void |
reload(String path)
Reloads the webapp at the specified context path.
|
void |
remove(String path)
Removes the webapp at the specified context path.
|
void |
setUserAgent(String userAgent)
Sets the user agent name to use when communicating with Tomcat manager.
|
void |
start(String path)
Starts the webapp at the specified context path.
|
void |
stop(String path)
Stops the webapp at the specified context path.
|
void |
undeploy(String path)
Undeploys the webapp at the specified context path.
|
public TomcatManager(URL url)
admin
, an empty password and ISO-8859-1 URL encoding.url
- the full URL of the Tomcat manager instance to usepublic TomcatManager(URL url, String username)
url
- the full URL of the Tomcat manager instance to useusername
- the username to use when authenticating with Tomcat managerpublic TomcatManager(URL url, String username, String password)
url
- the full URL of the Tomcat manager instance to useusername
- the username to use when authenticating with Tomcat managerpassword
- the password to use when authenticating with Tomcat managerpublic TomcatManager(URL url, String username, String password, String charset)
url
- the full URL of the Tomcat manager instance to useusername
- the username to use when authenticating with Tomcat managerpassword
- the password to use when authenticating with Tomcat managercharset
- the URL encoding charset to use when communicating with Tomcat managerpublic URL getURL()
public String getUserName()
public String getPassword()
public String getCharset()
public String getUserAgent()
public void setUserAgent(String userAgent)
userAgent
- the user agent name to use when communicating with Tomcat managerpublic void deploy(String path, URL war) throws TomcatManagerException, IOException
path
- the webapp context path to deploy towar
- the URL of the WAR to deployTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void deploy(String path, URL war, boolean update) throws TomcatManagerException, IOException
path
- the webapp context path to deploy towar
- the URL of the WAR to deployupdate
- whether to first undeploy the webapp if it already existsTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void deploy(String path, URL war, boolean update, String tag) throws TomcatManagerException, IOException
path
- the webapp context path to deploy towar
- the URL of the WAR to deployupdate
- whether to first undeploy the webapp if it already existstag
- the tag name to useTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void deploy(String path, InputStream war) throws TomcatManagerException, IOException
path
- the webapp context path to deploy towar
- an input stream to the WAR to deployTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void deploy(String path, InputStream war, boolean update) throws TomcatManagerException, IOException
path
- the webapp context path to deploy towar
- an input stream to the WAR to deployupdate
- whether to first undeploy the webapp if it already existsTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void deploy(String path, InputStream war, boolean update, String tag) throws TomcatManagerException, IOException
path
- the webapp context path to deploy towar
- an input stream to the WAR to deployupdate
- whether to first undeploy the webapp if it already existstag
- the tag name to useTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void deployContext(String path, URL config) throws TomcatManagerException, IOException
path
- the webapp context path to deploy toconfig
- the URL of the context XML configuration to deployTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void deployContext(String path, URL config, boolean update) throws TomcatManagerException, IOException
path
- the webapp context path to deploy toconfig
- the URL of the context XML configuration to deployupdate
- whether to first undeploy the webapp if it already existsTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void deployContext(String path, URL config, boolean update, String tag) throws TomcatManagerException, IOException
path
- the webapp context path to deploy toconfig
- the URL of the context XML configuration to deployupdate
- whether to first undeploy the webapp if it already existstag
- the tag name to useTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void deployContext(String path, URL config, URL war) throws TomcatManagerException, IOException
path
- the webapp context path to deploy toconfig
- the URL of the context XML configuration to deploywar
- the URL of the WAR to deployTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void deployContext(String path, URL config, URL war, boolean update) throws TomcatManagerException, IOException
path
- the webapp context path to deploy toconfig
- the URL of the context XML configuration to deploywar
- the URL of the WAR to deployupdate
- whether to first undeploy the webapp if it already existsTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void deployContext(String path, URL config, URL war, boolean update, String tag) throws TomcatManagerException, IOException
path
- the webapp context path to deploy toconfig
- the URL of the context XML configuration to deploywar
- the URL of the WAR to deployupdate
- whether to first undeploy the webapp if it already existstag
- the tag name to useTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void undeploy(String path) throws TomcatManagerException, IOException
path
- the webapp context path to undeployTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void remove(String path) throws TomcatManagerException, IOException
path
- the webapp context path to removeTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void reload(String path) throws TomcatManagerException, IOException
path
- the webapp context path to reloadTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void start(String path) throws TomcatManagerException, IOException
path
- the webapp context path to startTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic void stop(String path) throws TomcatManagerException, IOException
path
- the webapp context path to stopTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occursprotected void invoke(String path) throws TomcatManagerException, IOException
path
- the Tomcat manager command to invokeTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occursprotected String invoke(String path, InputStream data) throws TomcatManagerException, IOException
path
- the Tomcat manager command to invokedata
- an input stream to the content dataTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic String list() throws IOException, TomcatManagerException
TomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occurspublic TomcatDeployableStatus getStatus(String path) throws IOException, TomcatManagerException
path
- the webapp context path to get statusTomcatManagerException
- if the Tomcat manager request failsIOException
- if an i/o error occursCopyright © 2004-2013 Codehaus. All Rights Reserved.