Apache Tomcat

https://tomcat.apache.org/tomcat-9.0-doc/
Admin
Apache Tomcat version 9.0 implements the Servlet 4.0 and JavaServer Pages 2.3 specifications from...
Tokens:9,253,830
Snippets:91,978
Trust Score:10
Update:12 hours ago
Show doc for...
Tokens:
Raw
### Start command example

Source: https://tomcat.apache.org/tomcat-9.0-doc/host-manager-howto.html

Use the start command to start a virtual host by name.

```bash
curl -u test:test http://localhost:8080/host-manager/text/start?name=www.awesomeserver.com
```

--------------------------------

### Start command response

Source: https://tomcat.apache.org/tomcat-9.0-doc/host-manager-howto.html

Example response from the start command confirming the host started.

```text
OK - Host www.awesomeserver.com started
```

--------------------------------

### GET /start

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/manager/host/HostManagerServlet.html

Start the virtual host.

```APIDOC
## GET /start

### Description
Start the virtual host.

### Method
GET

### Endpoint
/start

### Parameters
#### Query Parameters
- **name** (string) - Required - The name of the host to start.

### Response
#### Success Response (200)
No specific response body is documented.

```

--------------------------------

### GET /start

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/manager/ManagerServlet.html

Starts the web application attached to the specified context path for this virtual host.

```APIDOC
## GET /start

### Description
Starts the web application attached to the specified context path for this virtual host.

### Method
GET

### Endpoint
/start

### Parameters
#### Query Parameters
- **path** (string) - Required - Context path of the web application to start.

### Request Example
```
GET /start?path=/myapp
```

### Response
#### Success Response (200)
- No specific response body documented.

#### Response Example
```
(No response body documented)
```
```

--------------------------------

### QuickStart: Create a channel, add listeners, start, and send a message

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/tribes/package-summary.html

Shows the basic steps to use the Tribes API: create a GroupChannel, add listeners, start the channel, create a Serializable message, retrieve members, and send the message with default options. The message must implement java.io.Serializable, and for performance reasons, java.io.Externalizable is recommended.

```java
            //create a channel
            Channel myChannel = new GroupChannel();

            //create my listeners
            MyMessageListener msgListener = new MyMessageListener();
            MyMemberListener mbrListener = new MyMemberListener();

            //attach the listeners to the channel
            myChannel.addMembershipListener(mbrListener);
            myChannel.addChannelListener(msgListener);

            //start the channel
            myChannel.start(Channel.DEFAULT);

            //create a message to be sent, message must implement java.io.Serializable
            //for performance reasons you probably want them to implement java.io.Externalizable
            Serializable myMsg = new MyMessage();

            //retrieve my current members
            Member[] group = myChannel.getMembers();

            //send the message
            channel.send(group,myMsg,Channel.SEND_OPTIONS_DEFAULT);

    
```

--------------------------------

### start()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/startup/Bootstrap.html

Starts the Catalina daemon. Throws an Exception on fatal start error.

```APIDOC
## start()

### Description
Start the Catalina daemon.

### Method
start

### Signature
`public void start() throws Exception`

### Throws
- **Exception** - Fatal start error
```

--------------------------------

### start()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/startup/Tomcat.html

Starts the server. This method throws LifecycleException if a start error occurs.

```APIDOC
## start()

### Description
Starts the server.

### Method
start

### Signature
public void start() throws LifecycleException

### Parameters
None

### Returns
void

### Throws
- **LifecycleException** - Start error
```

--------------------------------

### start()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/startup/Catalina.html

Starts a new server instance.

```APIDOC
## start()

### Description
Start a new server instance.

### Method
start

### Signature
`void start()`

### Parameters
None

### Return Type
void
```

--------------------------------

### start()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/startup/Catalina.html

Starts a new server instance.

```APIDOC
## start()

### Description
Starts a new server instance.

### Method
START

### Endpoint
N/A (Java method)

### Parameters
None

### Returns
void

```

--------------------------------

### GET /deploy

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/manager/ManagerServlet.html

Installs and starts a new web application based on the provided configuration or WAR file URL. The endpoint supports multiple query parameter combinations to specify the configuration file, WAR file, context path, or tag.

```APIDOC
## GET /deploy

### Description
Installs and starts a new web application based on the provided configuration or WAR file URL. The endpoint supports multiple query parameter combinations to specify the configuration file, WAR file, context path, or tag.

### Method
GET

### Endpoint
/deploy

### Parameters
#### Query Parameters
- **config** (string) - Optional - URL to a context configuration file. The `docBase` attribute of the configuration file is used to locate the WAR or directory.
- **war** (string) - Optional - URL to a web application archive (WAR) file. Overrides the `docBase` attribute when used with `config`.
- **path** (string) - Optional - Context path to attach the web application to. Use `path=/` for the ROOT context.
- **tag** (string) - Optional - Sub-directory of the temporary directory of this web application where the WAR file named `{baseName}.war` is located.

### Request Example
```
GET /deploy?path=/myapp&war=file:/path/to/myapp.war
```

### Response
#### Success Response (200)
- No specific response body documented.

#### Response Example
```
(No response body documented)
```
```

--------------------------------

### init()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/Lifecycle.html

Prepares the component for starting.

```APIDOC
## init()

### Description
Prepares the component for starting.

### Method
void init()

```

--------------------------------

### getInstalledExtensions

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/tomcat/websocket/WsWebSocketContainer.html

Get the installed extensions.

```APIDOC
## getInstalledExtensions

### Description
Get the installed extensions.

### Method
getInstalledExtensions

### Signature
`Set<Extension> getInstalledExtensions()`

### Parameters
None

### Return Type
Set<Extension>

```

--------------------------------

### getServiceStartTime()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/tribes/membership/McastServiceImpl.html

Gets the service start time.

```APIDOC
## getServiceStartTime()

### Description
Gets the service start time.

### Method
getServiceStartTime

### Signature
public long getServiceStartTime()

### Returns
- **long** - the service start time

```

--------------------------------

### init

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/tomcat/util/net/openssl/OpenSSLContext.html

Setup the SSL_CTX.

```APIDOC
## init

### Description
Setup the SSL_CTX.

### Method
POST

### Endpoint
OpenSSLContext.init(KeyManager[] kms, TrustManager[] tms, SecureRandom sr)

### Parameters
- **kms** (KeyManager[]) - Required - Must contain a KeyManager of the type OpenSSLKeyManager
- **tms** (TrustManager[]) - Required - Must contain a TrustManager of the type X509TrustManager
- **sr** (SecureRandom) - Required - Is not used for this implementation.

### Throws
- **KeyManagementException** - if an error occurs

```

--------------------------------

### getServiceStartTime()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/tribes/membership/McastServiceImpl.html

Gets the time when the service was started.

```APIDOC
## getServiceStartTime()

### Description
Get the service start time.

### Returns
long - The service start time in milliseconds.
```

--------------------------------

### Add command example

Source: https://tomcat.apache.org/tomcat-9.0-doc/host-manager-howto.html

Use the add command to add a new virtual host. The example includes parameters name, aliases, appBase, and deployOnStartup.

```bash
curl -u test:test http://localhost:8080/host-manager/text/add?name=www.awesomeserver.com&aliases=awesomeserver.com&appBase/mnt/appDir&deployOnStartup=true
```

--------------------------------

### Method: setupDefaults(Connection, String)

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/tomcat/dbcp/dbcp2/datasources/SharedPoolDataSource.html

Sets up the defaults for a given connection.

```APIDOC
## Method: setupDefaults(Connection, String)

### Description
Sets up the defaults for a given connection.

### Signature
`protected void setupDefaults(Connection connection, String userName)`

### Parameters
- **connection** (Connection) - Required - The connection to set up.
- **userName** (String) - Required - The user name.

### Returns
void
```

--------------------------------

### getStartTime()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/core/StandardContext.html

Gets the time this context was started.

```APIDOC
## getStartTime()

### Description
Gets the time this context was started.

### Method
GET

### Endpoint
StandardContext.getStartTime()

### Returns
- **long** - The start time.

```

--------------------------------

### getInstalledExtensions()

Source: https://tomcat.apache.org/tomcat-9.0-doc/websocketapi/javax/websocket/WebSocketContainer.html

Gets the installed extensions. This method returns a set of Extension objects representing the WebSocket extensions installed in the container.

```APIDOC
## getInstalledExtensions()

### Description
Gets the installed extensions. This method returns a set of Extension objects representing the WebSocket extensions installed in the container.

### Method
getInstalledExtensions

### Signature
Set<Extension> getInstalledExtensions()

### Returns
- **Set<Extension>** - A set of installed WebSocket extensions.
```

--------------------------------

### init(ConfigurationSource source, String[] catalinaArguments)

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/startup/Tomcat.html

Initialize the server given the specified configuration source and Catalina arguments.

```APIDOC
## init(ConfigurationSource source, String[] catalinaArguments)

### Description
Initialize the server given the specified configuration source and Catalina arguments.

### Method
POST

### Endpoint
Tomcat.init(ConfigurationSource source, String[] catalinaArguments)

### Parameters
#### Path Parameters
- **source** (ConfigurationSource) - Required - The configuration source to use.
- **catalinaArguments** (String[]) - Required - The Catalina arguments.

### Response
#### Success Response (200)
- **Returns** (void) - No return value.
```

--------------------------------

### GET /host-manager/text/start

Source: https://tomcat.apache.org/tomcat-9.0-doc/host-manager-howto.html

Starts a virtual host by name.

```APIDOC
## GET /host-manager/text/start

### Description
Starts a virtual host. The name parameter is required.

### Method
GET

### Endpoint
/host-manager/text/start

### Authentication
Basic authentication required (username:password).

### Parameters
#### Query Parameters
- **name** (String) - Required - Name of the virtual host to be started.

### Request Example
curl -u test:test "http://localhost:8080/host-manager/text/start?name=www.awesomeserver.com"

### Response
#### Success Response (200)
- Response body indicates the host started.

#### Response Example
OK - Host www.awesomeserver.com started

```

--------------------------------

### getStartupTime()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/core/StandardContext.html

Gets the time (in milliseconds) it took to start this context.

```APIDOC
## getStartupTime()

### Description
Gets the time (in milliseconds) it took to start this context.

### Method
GET

### Endpoint
StandardContext.getStartupTime()

### Returns
- **long** - The startup time in milliseconds.

```

--------------------------------

### start

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/tribes/membership/StaticMembershipService.html

Builds and configures the membership provider and returns the configured provider. Throws an Exception if initialization fails.

```APIDOC
## start

### Description
Builds and configures the membership provider.

### Method
start

### Signature
public MembershipProvider start()

### Returns
- **MembershipProvider** - the configured membership provider

### Throws
- **Exception** - if initialization fails
```

--------------------------------

### getInstalledExtensions() - WsWebSocketContainer

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/index-all.html

Method in class org.apache.tomcat.websocket.WsWebSocketContainer. Get the installed extensions.

```APIDOC
## getInstalledExtensions()

### Description
Get the installed extensions.

### Method
GET

### Endpoint
org.apache.tomcat.websocket.WsWebSocketContainer#getInstalledExtensions()

### Response
#### Success Response (200)
- **Set<Extension>** - The set of installed extensions.

```

--------------------------------

### load()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/startup/Catalina.html

Starts a new server instance.

```APIDOC
## load()

### Description
Starts a new server instance.

### Method
`load()`

### Return Type
`void`
```

--------------------------------

### getMinimumUmask()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/security/SecurityListener.html

Gets the minimum umask that must be configured before Tomcat will start.

```APIDOC
## getMinimumUmask()

### Description
Gets the minimum umask that must be configured before Tomcat will start.

### Method
`public String getMinimumUmask()`

### Returns
The 4-digit umask as used by the OS command _umask_.

```

--------------------------------

### load()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/startup/Catalina.html

Starts a new server instance.

```APIDOC
## load()

### Description
Starts a new server instance.

### Method
LOAD

### Endpoint
N/A (Java method)

### Parameters
None

### Returns
void

```

--------------------------------

### getMinimumUmask()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/security/SecurityListener.html

Get the minimum umask that must be configured before Tomcat will start.

```APIDOC
## getMinimumUmask()

### Description
Get the minimum umask that must be configured before Tomcat will start.

### Method
`String getMinimumUmask()`

### Parameters
None.

### Returns
String - the minimum umask
```

--------------------------------

### start()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/tribes/ChannelReceiver.html

Starts listening for incoming messages on the configured host and port. Throws IOException if the listen operation fails.

```APIDOC
## start()

### Description
Starts listening for incoming messages on the host/port.

### Method Signature
`void start() throws IOException`

### Throws
- `IOException` - Listen failed
```

--------------------------------

### getInstalledAprVersion()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/core/AprLifecycleListener.html

Static method to get the installed APR version string, if available.

```APIDOC
## getInstalledAprVersion()

### Description
Get the installed APR version string, if available.

### Method
GET

### Endpoint
AprLifecycleListener.getInstalledAprVersion()

### Parameters
None

### Response
#### Success Response
- **Return Type** (String) - The installed APR version string, or null if not available.

#### Response Example
```
"1.7.0"
```
```

--------------------------------

### start()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/tomcat/util/net/Nio2Endpoint.html

Starts the endpoint, making it ready to accept connections.

```APIDOC
## start()

### Description
Starts the endpoint, making it ready to accept connections.

### Method
start

### Parameters
None

### Returns
void
```

--------------------------------

### getInstalledTcnVersion()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/core/AprLifecycleListener.html

Static method to get the installed Tomcat Native version string, if available.

```APIDOC
## getInstalledTcnVersion()

### Description
Get the installed Tomcat Native version string, if available.

### Method
GET

### Endpoint
AprLifecycleListener.getInstalledTcnVersion()

### Parameters
None

### Response
#### Success Response
- **Return Type** (String) - The installed Tomcat Native version string, or null if not available.

#### Response Example
```
"1.2.30"
```
```

--------------------------------

### start()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/ha/ClusterDeployer.html

Starts the cluster deployer; the owning container will invoke this method.

```APIDOC
## start()

### Description
Starts the cluster deployer; the owning container will invoke this method.

### Method
void start()

### Parameters
None

### Returns
void
```

--------------------------------

### getStartStopExecutor()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/Host.html

Gets the executor used for starting and stopping contexts, primarily for multithreaded deployment.

```APIDOC
## getStartStopExecutor()

### Description
Get the executor that is used for starting and stopping contexts. This is primarily for use by components deploying contexts that want to do this in a multithreaded manner.

### Method
getStartStopExecutor

### Parameters
None

### Returns
ExecutorService - the start/stop executor
```

--------------------------------

### start()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/startup/Bootstrap.html

Starts the Catalina daemon.

```APIDOC
## start()

### Description
Start the Catalina daemon.

### Method
Instance method

### Signature
`public void start()`

```

--------------------------------

### resourcesStart()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/core/StandardContext.html

Allocates resources, including proxy.

```APIDOC
## resourcesStart()

### Description
Allocates resources, including proxy.

### Method
resourcesStart

### Parameters
None

### Returns
boolean
```

--------------------------------

### getInstalledOpenSslVersion()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/core/OpenSSLLifecycleListener.html

Static method to get the installed OpenSSL version string via FFM, if available.

```APIDOC
## getInstalledOpenSslVersion()

### Description
Get the installed OpenSSL version string (via FFM), if available.

### Method
`public static String getInstalledOpenSslVersion()`

### Parameters
None.

### Returns
- **String** - The installed OpenSSL version string, or null if not available.
```

--------------------------------

### start()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/tomcat/dbcp/dbcp2/BasicDataSourceMXBean.html

Starts the data source, initializing the connection pool.

```APIDOC
## start()

### Description
Starts the data source, initializing the connection pool.

### Method
POST

### Endpoint
org.apache.tomcat.dbcp.dbcp2.DataSourceMXBean#start()

### Parameters
None

### Response
#### Success Response
- **Return Type**: void
- **Description**: No return value.

#### Response Example
```
```
```

--------------------------------

### getInstalledAprVersion

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/core/AprLifecycleListener.html

Static method to get the installed APR version string, or null if APR is not available.

```APIDOC
## getInstalledAprVersion

### Description
Returns the installed APR version string, or null if APR is not available.

### Method
GET

### Endpoint
AprLifecycleListener.getInstalledAprVersion()

### Returns
- **String** - The APR version string, or null if APR is not available.
```

--------------------------------

### getInstalledOpenSslVersion()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/core/AprLifecycleListener.html

Static method to get the installed OpenSSL version string (via APR), if available.

```APIDOC
## getInstalledOpenSslVersion()

### Description
Get the installed OpenSSL version string (via APR), if available.

### Method
GET

### Endpoint
AprLifecycleListener.getInstalledOpenSslVersion()

### Parameters
None

### Response
#### Success Response
- **Return Type** (String) - The installed OpenSSL version string, or null if not available.

#### Response Example
```
"OpenSSL 1.1.1k"
```
```

--------------------------------

### start()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/tribes/membership/MembershipServiceBase.html

Starts the membership service.

```APIDOC
## start()

### Description
Starts the membership service.

### Method
Java method

### Signature
`void start()`
```

--------------------------------

### getJspBeginLineNumber()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/index-all.html

Gets the start line number (in the JSP file) of the JSP element responsible for the compilation error.

```APIDOC
## getJspBeginLineNumber()

### Description
Gets the start line number (in the JSP file) of the JSP element responsible for the compilation error.

### Method
GET

### Endpoint
org.apache.jasper.compiler.JavacErrorDetail#getJspBeginLineNumber()

### Parameters
None

### Response
#### Success Response (200)
- **return** (int) - The start line number.

#### Response Example
```json
{
  "jspBeginLineNumber": 10
}
```
```

--------------------------------

### getInstalledAprVersion() - AprLifecycleListener

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/index-all.html

Static method in class org.apache.catalina.core.AprLifecycleListener. Get the installed APR version string, if available.

```APIDOC
## getInstalledAprVersion()

### Description
Get the installed APR version string, if available.

### Method
GET

### Endpoint
org.apache.catalina.core.AprLifecycleListener#getInstalledAprVersion()

### Response
#### Success Response (200)
- **String** - The installed APR version string, or null if not available.

```

--------------------------------

### Context Configuration Examples

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/startup/Tomcat.html

Examples of configuring a context: adding parameters, error pages, and MIME mappings.

```APIDOC
## Context Configuration Examples

### Description
Examples of configuring a context: adding parameters, error pages, and MIME mappings.

### Example
```java
// context-param
ctx.addParameter("name", "value");

// error-page
ErrorPage ep = new ErrorPage();
ep.setErrorCode(500);
ep.setLocation("/error.html");
ctx.addErrorPage(ep);

ctx.addMimeMapping("ext", "type");
```
```

--------------------------------

### void start()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/tribes/transport/ReplicationTransmitter.html

Starts the sender and registers the transmitter MBean.

```APIDOC
## void start()

### Description
Starts the sender and registers the transmitter MBean.

### Method
start

### Returns
void

```

--------------------------------

### getTcnVersionWarning

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/core/AprLifecycleListener.html

Static method to get a warning message if the installed Tomcat Native version is older than recommended.

```APIDOC
## getTcnVersionWarning

### Description
Returns a warning message if the installed Tomcat Native version is older than recommended. This only compares the installed version against the recommended version and does not enforce the required minimum version.

### Method
GET

### Endpoint
AprLifecycleListener.getTcnVersionWarning()

### Returns
- **String** - A warning message if the installed version is outdated, or null if the version is acceptable or APR is not available.
```

--------------------------------

### getInstalledOpenSslVersion

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/core/AprLifecycleListener.html

Static method to get the installed OpenSSL version string (via APR), or null if not available.

```APIDOC
## getInstalledOpenSslVersion

### Description
Returns the installed OpenSSL version string (via APR), or null if not available.

### Method
GET

### Endpoint
AprLifecycleListener.getInstalledOpenSslVersion()

### Returns
- **String** - The OpenSSL version string, or null if not available.
```

--------------------------------

### getInstalledTcnVersion

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/core/AprLifecycleListener.html

Static method to get the installed Tomcat Native version string, or null if APR is not available.

```APIDOC
## getInstalledTcnVersion

### Description
Returns the installed Tomcat Native version string, or null if APR is not available.

### Method
GET

### Endpoint
AprLifecycleListener.getInstalledTcnVersion()

### Returns
- **String** - The version string, or null if APR is not available.
```

--------------------------------

### init()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/startup/Tomcat.html

Initialize the server.

```APIDOC
## init()

### Description
Initialize the server.

### Method
POST

### Endpoint
Tomcat.init()

### Parameters
None

### Response
#### Success Response (200)
- **Returns** (void) - No return value.
```

--------------------------------

### getTcnVersionWarning()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/core/AprLifecycleListener.html

Static method to get a warning message if the installed Tomcat Native version is older than recommended.

```APIDOC
## getTcnVersionWarning()

### Description
Get a warning message if the installed Tomcat Native version is older than recommended.

### Method
GET

### Endpoint
AprLifecycleListener.getTcnVersionWarning()

### Parameters
None

### Response
#### Success Response
- **Return Type** (String) - A warning message, or null if the version is acceptable.

#### Response Example
```
"The installed Tomcat Native version is older than recommended."
```
```

--------------------------------

### getDeployOnStartup()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/Host.html

Gets the deploy on startup flag. If true, child webapps are discovered and deployed when the Host starts.

```APIDOC
## getDeployOnStartup()

### Description
Get the value of the deploy on startup flag. If true, it indicates that this host's child webapps should be discovered and deployed when the Host starts, independently of the auto deploy flag.

### Method
getDeployOnStartup

### Parameters
None

### Returns
boolean - the deploy on startup flag
```

--------------------------------

### start()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/tribes/ChannelReceiver.html

Starts listening for incoming messages on the host/port.

```APIDOC
## start()

### Description
Starts listening for incoming messages on the host/port.

### Method
`void start()`
```

--------------------------------

### start()

Source: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/Lifecycle.html

Prepares for the beginning of active use of the public methods other than property getters/setters and life cycle methods of this component.

```APIDOC
## start()

### Description
Prepares for the beginning of active use of the public methods other than property getters/setters and life cycle methods of this component.

### Method
void start()

```
Tokens:
Raw