TomcatManager

class tomcatmanager.tomcat_manager.TomcatManager

A class for interacting with the Tomcat Manager web application.

Here’s a summary of the recommended way to use this class with proper exception and error handling. For this example, we’ll use the server_info() method.

import tomcatmanager as tm
url = "http://localhost:808099/manager"
user = "ace"
password = "newenglandclamchowder"
tomcat = tm.TomcatManager()
try:
    r = tomcat.connect(url, user, password)
    if r.ok:
        r = tomcat.server_info()
        if r.ok:
            print(r.server_info)
        else:
            print(f"Error: {r.status_message}")
    else:
        print("not connected")
except Exception as err:
    # handle exception
    print("not connected")

Attributes:

`timeout`	Seconds to wait before giving up on network operations.
`url`	Url of the Tomcat Manager web application we are connected to.
`user`	User we successfully authenticated to the Tomcat Manager web application with.
`cert`	Client side SSL/TLS certificates we authenticated to the Tomcat Manager web application with.
`verify`	The certificate authority directory or bundle to use to verify server SSL/TLS certificates.
`tomcat_major_minor`	If connected to a server, this contains an instance of `TomcatMajorMinor` describing the major version of Tomcat we are connected to.
`is_connected`	Does the url point to an actual tomcat server and are the credentials valid?

Methods:

`implements`(method)	Is a method implemented on the tomcat server we are connected to?
`implemented_by`(method, tomcat_major_minor)	Check whether a method is implemented by any version of Tomcat.
`connect`(url[, user, password, cert, verify, ...])	Connect to the manager application running in a Tomcat server.
`disconnect`()	Disconnect from the manager application running in a Tomcat server.
`deploy_localwar`(path, warfile[, version, update])	Deploy a warfile from the local file system to the Tomcat server.
`deploy_serverwar`(path, warfile[, version, ...])	Deploy a warfile from the server file system to the Tomcat server.
`deploy_servercontext`(path, contextfile[, ...])	Deploy a Tomcat application defined by a context file from the server filesystem to the Tomcat server.
`undeploy`(path[, version])	Undeploy an application in the Tomcat server.
`start`(path[, version])	Start an application already deployed in the Tomcat server.
`stop`(path[, version])	Stop an application already deployed in the Tomcat server.
`reload`(path[, version])	Stop and start a Tomcat application.
`sessions`(path[, version])	Get the age of the sessions for an application.
`expire`(path[, version, idle])	Expire idle sessions.
`list`()	Get a list of all applications currently installed.
`server_info`()	Get information about the Tomcat server.
`status_xml`()	Get server status information in XML format.
`vm_info`()	Get diagnostic information about the JVM.
`thread_dump`()	Get a JVM thread dump.
`resources`([type_])	Get the global JNDI resources
`find_leakers`()	Get apps that leak memory.
`ssl_connector_ciphers`()	Get SSL/TLS ciphers configured for each connector.
`ssl_connector_certs`()	Get the SSL certificate chain currently configured for each virtual host
`ssl_connector_trusted_certs`()	Get the trusted certificates currently configured for each virtual host
`ssl_reload`([host])	Reload TLS certificates and keys (but not server.xml) for a specified or all virtual hosts

timeout

Seconds to wait before giving up on network operations. Can be a float or an int. Default is 10. I surely don’t want to wait forever, but if you do, set to 0.

Usage:

>>> import tomcatmanager as tm
>>> tomcat = tm.TomcatManager()
>>> tomcat.timeout = 3.5

Changed in version 3.0.0: Can be a float or int instead of just an int

property url: str

Url of the Tomcat Manager web application we are connected to.