Apache Tomcat

https://tomcat.apache.org/tomcat-10.1-doc/
Admin
Apache Tomcat is a Java-based web server and servlet container that implements the Servlet and JSP...
Tokens:4,589,187
Snippets:71,500
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Start command example

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

Use the start command to start a virtual host. The example starts the host named www.awesomeserver.com.

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

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

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

### GET /deploy?path=/xxx&war={war-url}

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

Installs and starts a new web application attached to context path /xxx, based on the contents of the web application archive found at the specified URL.

```APIDOC
## [GET] /deploy?path=/xxx&war={war-url}

### Description
Installs and starts a new web application attached to context path `/xxx`, based on the contents of the web application archive found at the specified URL.

### Method
GET

### Endpoint
/deploy

### Parameters
#### Query Parameters
- **path** (string) - Required - The context path to attach the application to. Use `path=/` for the ROOT context.
- **war** (URL) - Required - The URL of the web application archive.

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

```

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

### GET /deploy?config={config-url}

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

Installs and starts a new web application based on the contents of the context configuration file found at the specified URL. The docBase attribute of the context configuration file is used to locate the actual WAR or directory containing the application.

```APIDOC
## [GET] /deploy?config={config-url}

### Description
Installs and starts a new web application based on the contents of the context configuration file found at the specified URL. The `docBase` attribute of the context configuration file is used to locate the actual WAR or directory containing the application.

### Method
GET

### Endpoint
/deploy

### Parameters
#### Query Parameters
- **config** (URL) - Required - The URL of the context configuration file.

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

```

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

### GET /start

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

Starts the virtual host with the specified name.

```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.

```

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

### GET /deploy?config={config-url}&war={war-url}

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

Installs and starts a new web application based on the contents of the context configuration file found at {config-url}, overriding the docBase attribute with the contents of the web application archive found at {war-url}.

```APIDOC
## [GET] /deploy?config={config-url}&war={war-url}

### Description
Installs and starts a new web application based on the contents of the context configuration file found at `{config-url}`, overriding the `docBase` attribute with the contents of the web application archive found at `{war-url}`.

### Method
GET

### Endpoint
/deploy

### Parameters
#### Query Parameters
- **config** (URL) - Required - The URL of the context configuration file.
- **war** (URL) - Required - The URL of the web application archive.

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

```

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

### start()

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

Starts a new server instance.

```APIDOC
## start()

### Description
Starts a new server instance.

### Method
start

### Returns
void
```

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

### start

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

Starts a new server instance.

```APIDOC
## start

### Description
Starts a new server instance.

### Method
POST

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response
No return value.
```

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

### Install first Tomcat instance

Source: https://tomcat.apache.org/tomcat-10.1-doc/windows-service-howto.html

Set CATALINA_HOME and CATALINA_BASE environment variables, then run service.bat install with a service name to install an instance.

```batch
set CATALINA_HOME=c:\tomcat_10
set CATALINA_BASE=c:\tomcat_10\instances\instance1
service.bat install instance1
```

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

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

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

Starts a virtual host by name.

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

### Description
Starts a virtual host by name.

### Method
GET

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

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

### Authentication
Basic authentication with username and password (e.g., test:test).

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

### Response
#### Success Response (200)
- **message** (string) - Confirmation message, e.g., "OK - Host www.awesomeserver.com started".

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

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

### GET /start?path=/xxx

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

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

```APIDOC
## [GET] /start?path=/xxx

### Description
Starts the web application attached to context path `/xxx` for this virtual host.

### Method
GET

### Endpoint
/start

### Parameters
#### Query Parameters
- **path** (string) - Required - The context path of the web application to start. Use `path=/` for the ROOT context.

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

```

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

### start()

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

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

```APIDOC
## start()

### Description
Start the Catalina daemon.

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

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

```

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

### start()

Source: https://tomcat.apache.org/tomcat-10.1-doc/api/org/apache/tomcat/dbcp/dbcp2/DataSourceMXBean.html

Starts the data source, initializing it if necessary.

```APIDOC
## start()

### Description
Starts the data source, initializing it if necessary.

### Method
`default void start() throws SQLException`

### Throws
- `SQLException` - if an error occurs initializing the data source.

### Since
2.8.0

```

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

### Example build.properties file

Source: https://tomcat.apache.org/tomcat-10.1-doc/appdev/processes.html

Example build.properties file defining the app path, Tomcat installation directory, and manager credentials. This file is typically not checked into source control.

```properties
# Context path to install this application on
app.path=/hello

# Tomcat installation directory
catalina.home=/usr/local/apache-tomcat-10.1

# Manager webapp username and password
manager.username=myusername
manager.password=mypassword

```

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

### start(int svc)

Source: https://tomcat.apache.org/tomcat-10.1-doc/api/org/apache/catalina/tribes/ChannelInterceptor.html

Starts up the channel.

```APIDOC
## start(int svc)

### Description
Starts up the channel.

### Method
POST

### Endpoint
ChannelInterceptor.start(int svc)

### Parameters
- **svc** (int) - Required - The service level.

### Returns
void

### Example
```java
interceptor.start(svc);
```
```

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

### start()

Source: https://tomcat.apache.org/tomcat-10.1-doc/api/org/apache/tomcat/dbcp/dbcp2/DataSourceMXBean.html

Starts the data source. See BasicDataSource.start().

```APIDOC
## start()

### Description
Starts the data source. See `BasicDataSource.start()`.

### Method
`default void start()`

### Returns
`void` - `BasicDataSource.start()`
```

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

### start()

Source: https://tomcat.apache.org/tomcat-10.1-doc/api/org/apache/catalina/tribes/MembershipService.html

Starts the membership service. If a membership listener is added, the listener will start to receive membership events. Performs a start level 1 and 2.

```APIDOC
## start()

### Description
Starts the membership service. If a membership listener is added, the listener will start to receive membership events. Performs a start level 1 and 2.

### Method
start

### Signature
void start() throws Exception

### Throws
- **Exception** - if the service fails to start.
```

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

### start(int)

Source: https://tomcat.apache.org/tomcat-10.1-doc/api/org/apache/catalina/tribes/membership/McastService.html

Starts the membership service. If a membership listener is added, the listener will start to receive membership events.

```APIDOC
## start(int)

### Description
Starts the membership service. If a membership listener is added, the listener will start to receive membership events.

### Method
start

### Parameters
- `level` (int) - Required - level MBR_RX starts listening for members, level MBR_TX starts broadcasting the server

### Throws
- `Exception` - if the service fails to start.

### Returns
void
```

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

### start(int level)

Source: https://tomcat.apache.org/tomcat-10.1-doc/api/org/apache/catalina/tribes/membership/cloud/CloudMembershipService.html

Starts the membership service.

```APIDOC
## start(int level)

### Description
Starts the membership service.

### Method
POST

### Parameters
- **level** (int) - Required - The start level.

```

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

### start()

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

Starts the sender and registers the transmitter mbean.

```APIDOC
## start()

### Description
Start the sender and register transmitter mbean. This method is specified by the ChannelSender interface.

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

### Parameters
None.

### Throws
- **IOException** - if preprocessing takes place and an error happens

### See Also
- `ChannelSender.start()`
```

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

### Start Tomcat on *nix

Source: https://tomcat.apache.org/tomcat-10.1-doc/RUNNING.txt

Commands to start Tomcat on *nix using startup.sh or catalina.sh start. These commands are used when Tomcat is launched via the standard scripts.

```shell
$CATALINA_HOME/bin/startup.sh
```

```shell
$CATALINA_HOME/bin/catalina.sh start
```

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

### Get heap memory usage example

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

Example get command to fetch the current heap memory data from the Memory MBean.

```http
http://webserver/manager/jmxproxy/?get=java.lang:type=Memory&att=HeapMemoryUsage
```

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

### void load()

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

Starts a new server instance by loading the server configuration and initializing the server.

```APIDOC
## void load()

### Description
Starts a new server instance. This method loads the server configuration and initializes the server.

### Method
`void load()`

### Parameters
None.

### Returns
void
```

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

### init

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

Setup the SSL_CTX.

```APIDOC
## init(kms, tms, sr)

### Description
Setup the SSL_CTX.

### Method
public void init(KeyManager[] kms, TrustManager[] tms, SecureRandom sr) throws KeyManagementException

### 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
```

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

### Set CATALINA_BASE before starting Tomcat

Source: https://tomcat.apache.org/tomcat-10.1-doc/introduction.html

Set the CATALINA_BASE environment variable before starting Tomcat to run multiple instances on one machine. The Unix example uses the catalina.sh script, while the Windows example uses catalina.bat.

```bash
CATALINA_BASE=/tmp/tomcat_base1 bin/catalina.sh start
```

```batch
CATALINA_BASE=C:\tomcat_base1 bin/catalina.bat start
```

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

### getInstalledExtensions() - WsWebSocketContainer

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

Get the installed extensions.

```APIDOC
## getInstalledExtensions()

### Description
Get the installed extensions.

### Method
`getInstalledExtensions()`

### Class
`org.apache.tomcat.websocket.WsWebSocketContainer`

### Returns
`Set<Extension>` - The installed extensions.
```

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

### setupDefaults(Connection, String) - InstanceKeyDataSource

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

Sets up the defaults for a given connection.

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

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

### Method
setupDefaults(Connection, String)

### Class
org.apache.tomcat.dbcp.dbcp2.datasources.InstanceKeyDataSource

### Parameters
- **Connection** - The connection.
- **String** - The connection name.

```

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

### setupDefaults(Connection, String)

Source: https://tomcat.apache.org/tomcat-10.1-doc/api/org/apache/tomcat/dbcp/dbcp2/datasources/PerUserPoolDataSource.html

Sets up defaults for a given connection.

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

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

### Method
`protected void setupDefaults(Connection con, String userName)`

### Parameters
- `con` (Connection) - Required - The connection.
- `userName` (String) - Required - The user name.

```

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

### getStartTime()

Source: https://tomcat.apache.org/tomcat-10.1-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** - Time (in milliseconds since January 1, 1970, 00:00:00) when this context was started

```

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

### load()

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

Starts a new server instance.

```APIDOC
## load()

### Description
Starts a new server instance.

### Method
POST

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response
No return value.
```

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

### Get specific key from heap memory usage

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

Example get command that fetches only the 'used' key from the HeapMemoryUsage CompositeData attribute.

```http
http://webserver/manager/jmxproxy/
 ?get=java.lang:type=Memory&att=HeapMemoryUsage&key=used
```

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

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

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

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

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

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

### Method
init

### Signature
`public void init(ConfigurationSource source, String[] catalinaArguments)`

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

### Returns
void

```

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

### GET /list

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

Lists the virtual hosts installed on the server.

```APIDOC
## [GET] /list

### Description
List the virtual hosts installed on the server. Each host will be listed with the following format host-name#host-aliases.

### Method
GET

### Endpoint
/list

```

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

### getStartupTime

Source: https://tomcat.apache.org/tomcat-10.1-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` - Time (in milliseconds) it took to start this context.
```

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

### Add command example

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

Use the add command to add a new virtual host. The example adds a host named www.awesomeserver.com with aliases and appBase. Note the appBase parameter is missing an equals sign in the example.

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

```text
add: Adding host [www.awesomeserver.com]
```

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

### getInstalledAprVersion()

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

Get the installed APR version string, if available.

```APIDOC
## getInstalledAprVersion

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

### Method
Static method

### Signature
`public static String getInstalledAprVersion()`

### Parameters
None.

### Returns
- the APR version string, or null if APR is not available

```

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

### getMinimumUmask()

Source: https://tomcat.apache.org/tomcat-10.1-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()`

### Parameters
None.

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

```

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

### getInstalledTcnVersion()

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

Get the installed Tomcat Native version string, if available.

```APIDOC
## getInstalledTcnVersion

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

### Method
Static method

### Signature
`public static String getInstalledTcnVersion()`

### Parameters
None.

### Returns
- the version string, or null if APR is not available

```

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

### getInstalledOpenSslVersion()

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

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

```APIDOC
## getInstalledOpenSslVersion

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

### Method
Static method

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

### Parameters
None.

### Returns
- the OpenSSL version string, or null if not available

```

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

### init()

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

Initializes the server with no arguments.

```APIDOC
## init()

### Description
Initializes the server.

### Method
init

### Throws
- `LifecycleException` - Init error
```

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

### getInstalledAprVersion()

Source: https://tomcat.apache.org/tomcat-10.1-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 Signature
`static String getInstalledAprVersion()`

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

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

### List command example

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

Use the list command to see available virtual hosts. The example uses credentials test:test.

```bash
curl -u test:test http://localhost:8080/host-manager/text/list
```

```text
OK - Listed hosts
localhost:
```

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

### initWebappDefaults(Context ctx) (static)

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

Static version of initWebappDefaults(String).

```APIDOC
## initWebappDefaults(Context ctx) (static)

### Description
Static version of initWebappDefaults(String).

### Method
initWebappDefaults

### Signature
`public static void initWebappDefaults(Context ctx)`

### Parameters
- **ctx** (Context) - Required - The context to configure.

### Returns
void

```

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

### initWebappDefaults(Context ctx) (static)

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

Static version of initWebappDefaults(String).

```APIDOC
## initWebappDefaults(Context ctx) (static)

### Description
Static version of initWebappDefaults(String).

### Method
initWebappDefaults

### Parameters
- **ctx** (Context) - Required - The context to set the defaults for.
```

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

### getInstalledOpenSslVersion() - OpenSSLLifecycleListener

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

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

```APIDOC
## getInstalledOpenSslVersion()

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

### Method
`static getInstalledOpenSslVersion()`

### Class
`org.apache.catalina.core.OpenSSLLifecycleListener`

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

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

### getTcnVersionWarning()

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

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. This performs the same version check used during Tomcat startup.

### Method
Static method

### Signature
`public static String getTcnVersionWarning()`

### Parameters
None.

### Returns
- a warning message if the installed version is outdated, or null if the version is acceptable or APR is not available

```

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

### getInstalledTcnVersion()

Source: https://tomcat.apache.org/tomcat-10.1-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 Signature
`static String getInstalledTcnVersion()`

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

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

### init()

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

Prepares the component for starting. This method should be called before start() to initialize necessary resources.

```APIDOC
## init()

### Description
Prepare the component for starting.

### Method
init

### Parameters
None

### Returns
void
```

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

### getInstalledOpenSslVersion()

Source: https://tomcat.apache.org/tomcat-10.1-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 Signature
`static String getInstalledOpenSslVersion()`

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

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

### main(String[] args)

Source: https://tomcat.apache.org/tomcat-10.1-doc/api/org/apache/catalina/util/ServerInfo.html

Main entry point that prints server version, build date, OS, JVM, APR, OpenSSL, and third-party library information to standard output.

```APIDOC
## main(String[] args)

### Description
Main entry point that prints server version, build date, OS, JVM, APR, OpenSSL, and third-party library information to standard output.

### Method
`public static void main(String[] args)`

### Parameters
- **args** (String[]) - Command line arguments (not used).
```

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

### init()

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

Initializes the server.

```APIDOC
## init()

### Description
Initializes the server.

### Method
init

### Signature
`public void init()`

### Parameters
None

### Returns
void

```

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

### getTcnVersionWarning()

Source: https://tomcat.apache.org/tomcat-10.1-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 Signature
`static String getTcnVersionWarning()`

### Returns
- `String` - A warning message, or null if the version is acceptable.
```

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

### setupDefaults

Source: https://tomcat.apache.org/tomcat-10.1-doc/api/org/apache/tomcat/dbcp/dbcp2/datasources/PerUserPoolDataSource.html

Protected method to set up defaults for a connection.

```APIDOC
## setupDefaults

### Description
Sets up the defaults for a given connection. This method is protected and inherited from `InstanceKeyDataSource`.

### Method
setupDefaults

### Parameters
- `con` (Connection) - The target connection.
- `userName` (String) - The user name for the connection.

### Throws
- `SQLException` - if a database access error occurs or this method is called on a closed connection.
```

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

### start()

Source: https://tomcat.apache.org/tomcat-10.1-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. This method should be called after init().

```APIDOC
## start()

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

### Method
start

### Parameters
None

### Returns
void
```

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

### Successful Deploy Response

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

Successful response to the remote deploy command. If installation and startup succeed, the response starts with OK and includes the context path. Otherwise the response starts with FAIL and includes an error message.

```text
OK - Deployed application at context path /foo
```

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

### void load(String[] args)

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

Loads the server configuration and initializes the server using the specified command line arguments.

```APIDOC
## void load(String[] args)

### Description
Loads the server configuration and initializes the server using the specified command line arguments.

### Method
`void load(String[] args)`

### Parameters
- **args** (String[]) - Required - Command line arguments to process.

### Returns
void
```

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

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

Source: https://tomcat.apache.org/tomcat-10.1-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
- **return** (int) - The start line number.

#### Response Example
```
10
```
```
Tokens:
Raw