# Serialized Form

## Package org.apache.catalina

### Class org.apache.catalina.ContainerEvent

class ContainerEvent extends EventObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### data

    Object data

The event data associated with this event.

##### type

    String type

The event type this instance represents.

### Class org.apache.catalina.LifecycleEvent

class LifecycleEvent extends EventObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### data

    Object data

The event data associated with this event.

##### type

    String type

The event type this instance represents.

### Exception Class org.apache.catalina.LifecycleException

class LifecycleException extends Exception implements Serializable

serialVersionUID:
  1L

### Class org.apache.catalina.SessionEvent

class SessionEvent extends EventObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### data

    Object data

The event data associated with this event.

##### session

    Session session

The Session on which this event occurred.

##### type

    String type

The event type this instance represents.

## Package org.apache.catalina.authenticator

### Class org.apache.catalina.authenticator.SavedRequest

class SavedRequest extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### body

    ByteChunk body

The body of this request.

##### contentType

    String contentType

The content type of the request, used if this is a POST.

##### cookies

    List<Cookie> cookies

The set of Cookies associated with this Request.

##### decodedRequestURI

    String decodedRequestURI

The decode request URI associated with this Request. Path parameters are also excluded

##### headers

    Map<String, List<String>> headers

The set of Headers associated with this Request. Each key is a header name, while the value is a List containing one or more actual values for this header. The values are returned as an Iterator when you ask for them.

##### locales

    List<Locale> locales

The set of Locales associated with this Request.

##### method

    String method

The request method used on this Request.

##### originalMaxInactiveInterval

    Integer originalMaxInactiveInterval

The original maxInactiveInterval for the session.

##### queryString

    String queryString

The query string associated with this Request.

##### requestURI

    String requestURI

The request URI associated with this Request.

### Class org.apache.catalina.authenticator.SingleSignOnEntry

class SingleSignOnEntry extends Object implements Serializable

serialVersionUID:
  1L

#### Serialization Methods

##### readObject

private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
Custom deserialization to restore the transient principal field.

Parameters:
  `in` - the object input stream
Throws:
  `IOException` - if an I/O error occurs
  `ClassNotFoundException` - if the principal class cannot be found

##### writeObject

private void writeObject(ObjectOutputStream out) throws IOException
Custom serialization to handle the transient principal field.

Parameters:
  `out` - the object output stream
Throws:
  `IOException` - if an I/O error occurs

#### Serialized Fields

##### authType

    String authType

The authentication type (BASIC, CLIENT_CERT, DIGEST or FORM).

##### canReauthenticate

    boolean canReauthenticate

Flag indicating whether re-authentication is supported.

##### password

    String password

The password used for authentication.

##### sessionKeys

    Map<SingleSignOnSessionKey, SingleSignOnSessionKey> sessionKeys

Set of session keys associated with this SSO entry. Backed by ConcurrentHashMap to take advantage of its thread safety features.

##### username

    String username

The username used for authentication.

### Class org.apache.catalina.authenticator.SingleSignOnListener

class SingleSignOnListener extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### ssoId

    String ssoId

The SSO identifier associated with this listener.

### Class org.apache.catalina.authenticator.SingleSignOnSessionKey

class SingleSignOnSessionKey extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### contextName

    String contextName

The context name.

##### hostName

    String hostName

The host name.

##### sessionId

    String sessionId

The session ID.

## Package org.apache.catalina.connector

### Exception Class org.apache.catalina.connector.ClientAbortException

class ClientAbortException extends BadRequestException implements Serializable

serialVersionUID:
  1L

### Class org.apache.catalina.connector.CoyotePrincipal

class CoyotePrincipal extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### name

    String name

The username of the user represented by this Principal.

## Package org.apache.catalina.core

### Class org.apache.catalina.core.ApplicationFilterConfig

class ApplicationFilterConfig extends Object implements Serializable

serialVersionUID:
  1L

#### Serialization Methods

##### readObject

private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException
Restores the transient log field after deserialization.

Parameters:
  `ois` - the object input stream
Throws:
  `ClassNotFoundException` - if the log class cannot be found
  `IOException` - if an I/O error occurs

#### Serialized Fields

##### filterDef

    FilterDef filterDef

The `FilterDef` that defines our associated Filter.

##### oname

    ObjectName oname

JMX registration name

## Package org.apache.catalina.deploy

### Class org.apache.catalina.deploy.NamingResourcesImpl

class NamingResourcesImpl extends LifecycleMBeanBase implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### container

    Object container

Associated container object.

##### ejbs

    Map<String, ContextEjb> ejbs

The EJB resource references for this web application, keyed by name.

##### entries

    Set<String> entries

Set of naming entries, keyed by name.

##### envs

    Map<String, ContextEnvironment> envs

The environment entries for this web application, keyed by name.

##### localEjbs

    Map<String, ContextLocalEjb> localEjbs

The local EJB resource references for this web application, keyed by name.

##### mdrs

    Map<String, MessageDestinationRef> mdrs

The message destination references for this web application, keyed by name.

##### resourceEnvRefs

    HashMap<String, ContextResourceEnvRef> resourceEnvRefs

The resource environment references for this web application, keyed by name.

##### resourceLinks

    HashMap<String, ContextResourceLink> resourceLinks

The resource links for this web application, keyed by name.

##### resourceRequireExplicitRegistration

    boolean resourceRequireExplicitRegistration

Flag that controls whether resources require explicit JMX registration.

##### resources

    HashMap<String, ContextResource> resources

The resource references for this web application, keyed by name.

##### services

    HashMap<String, ContextService> services

The web service references for this web application, keyed by name.

##### support

    PropertyChangeSupport support

The property change support for this component.

##### transaction

    ContextTransaction transaction

The transaction for this webapp.

## Package org.apache.catalina.filters

### Class org.apache.catalina.filters.CorsFilter

class CorsFilter extends GenericFilter implements Serializable

serialVersionUID:
  1L

#### Serialization Methods

##### readObject

private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException
Restores the transient log field after deserialization. Log objects are not Serializable but this Filter is because it extends GenericFilter. Tomcat won't serialize a Filter but in case something else does...

Parameters:
  `ois` - the object input stream
Throws:
  `ClassNotFoundException` - if the log class cannot be found
  `IOException` - if an I/O error occurs

#### Serialized Fields

##### allowedHttpHeaders

    Collection<String> allowedHttpHeaders

A `Collection` of headers consisting of zero or more header field names that are supported by the resource.

##### allowedHttpMethods

    Collection<String> allowedHttpMethods

A `Collection` of methods consisting of zero or more methods that are supported by the resource.

##### allowedOrigins

    Collection<String> allowedOrigins

A `Collection` of origins consisting of zero or more origins that are allowed access to the resource.

##### anyOriginAllowed

    boolean anyOriginAllowed

Determines if any origin is allowed to make request.

##### decorateRequest

    boolean decorateRequest

Determines if the request should be decorated or not.

##### exposedHeaders

    Collection<String> exposedHeaders

A `Collection` of exposed headers consisting of zero or more header field names of headers other than the simple response headers that the resource might use and can be exposed.

##### preflightMaxAge

    long preflightMaxAge

Indicates (in seconds) how long the results of a pre-flight request can be cached in a pre-flight result cache.

##### supportsCredentials

    boolean supportsCredentials

A supports credentials flag that indicates whether the resource supports user credentials in the request. It is true when the resource does and false otherwise.

### Class org.apache.catalina.filters.CsrfPreventionFilter.LruCache

class LruCache extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### cache

    Map<T,T> cache

The internal cache map.

### Class org.apache.catalina.filters.RemoteIpFilter

class RemoteIpFilter extends GenericFilter implements Serializable

serialVersionUID:
  1L

#### Serialization Methods

##### readObject

private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException
Restores the log after deserialization.

Parameters:
  `ois` - the object input stream
Throws:
  `ClassNotFoundException` - if the class is not found
  `IOException` - if an I/O error occurs

#### Serialized Fields

##### changeLocalName

    boolean changeLocalName

Whether to change the local name.

##### changeLocalPort

    boolean changeLocalPort

Whether to change the local port.

##### enableLookups

    boolean enableLookups

Whether DNS lookups are enabled.

##### hostHeader

    String hostHeader

The header used to determine the host.

##### httpServerPort

    int httpServerPort

The default HTTP server port.

##### httpsServerPort

    int httpsServerPort

The default HTTPS server port.

##### internalProxiesCidr

    NetMaskSet internalProxiesCidr

##### internalProxiesRegex

    Pattern internalProxiesRegex

##### portHeader

    String portHeader

The header used to determine the port.

##### protocolHeader

    String protocolHeader

The header used to determine the protocol.

##### protocolHeaderHttpsValue

    String protocolHeaderHttpsValue

The protocol header value that indicates HTTPS.

##### proxiesHeader

    String proxiesHeader

The header used to determine the proxy chain.

##### remoteIpHeader

    String remoteIpHeader

The header used to determine the remote IP address.

##### requestAttributesEnabled

    boolean requestAttributesEnabled

Whether to set request attributes.

##### trustedProxiesCidr

    NetMaskSet trustedProxiesCidr

##### trustedProxiesRegex

    Pattern trustedProxiesRegex

### Class org.apache.catalina.filters.RequestDumperFilter

class RequestDumperFilter extends GenericFilter implements Serializable

serialVersionUID:
  1L

#### Serialization Methods

##### readObject

private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException
Restores the log after deserialization. Log objects are not Serializable but this Filter is because it extends GenericFilter. Tomcat won't serialize a Filter but in case something else does...

Parameters:
  `ois` - the object input stream
Throws:
  `ClassNotFoundException` - if the class is not found
  `IOException` - if an I/O error occurs

## Package org.apache.catalina.ha

### Class org.apache.catalina.ha.ClusterMessageBase

class ClusterMessageBase extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### timestamp

    long timestamp

The timestamp of this message.

## Package org.apache.catalina.ha.authenticator

### Class org.apache.catalina.ha.authenticator.ClusterSingleSignOnListener

class ClusterSingleSignOnListener extends SingleSignOnListener implements Serializable

serialVersionUID:
  1L

## Package org.apache.catalina.ha.deploy

### Class org.apache.catalina.ha.deploy.FileMessage

class FileMessage extends ClusterMessageBase implements Serializable

serialVersionUID:
  2L

#### Serialized Fields

##### contextName

    String contextName

The context name associated with the file.

##### data

    byte[] data

The file data payload.

##### dataLength

    int dataLength

The length of the data.

##### fileName

    String fileName

The name of the file being transferred.

##### messageNumber

    int messageNumber

The message number within the file transfer.

##### totalNrOfMsgs

    long totalNrOfMsgs

The total number of messages in the transfer.

### Class org.apache.catalina.ha.deploy.UndeployMessage

class UndeployMessage extends Object implements Serializable

serialVersionUID:
  2L

#### Serialized Fields

##### address

    Member address

The sender's member address.

##### contextName

    String contextName

The context name to undeploy.

##### timestamp

    long timestamp

The message timestamp.

##### uniqueId

    String uniqueId

The unique identifier for this message.

## Package org.apache.catalina.ha.session

### Class org.apache.catalina.ha.session.DeltaRequest

class DeltaRequest extends Object implements Externalizable

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Throws:
  `IOException`
  `ClassNotFoundException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

### Class org.apache.catalina.ha.session.DeltaSession

class DeltaSession extends StandardSession implements Externalizable

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Throws:
  `IOException`
  `ClassNotFoundException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

### Class org.apache.catalina.ha.session.SessionMessageImpl

class SessionMessageImpl extends ClusterMessageBase implements Serializable

serialVersionUID:
  2L

#### Serialized Fields

##### mContextName

    String mContextName

The context name for the session.

##### mEvtType

    int mEvtType

The event type of the session message.

##### mSession

    byte[] mSession

The serialized session data.

##### mSessionID

    String mSessionID

The session identifier.

##### serializationTimestamp

    long serializationTimestamp

The timestamp when the message was serialized.

##### timestampSet

    boolean timestampSet

Whether the timestamp has been explicitly set.

##### uniqueId

    String uniqueId

The unique identifier for this message.

## Package org.apache.catalina.manager

### Class org.apache.catalina.manager.HTMLManagerServlet

class HTMLManagerServlet extends ManagerServlet implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### htmlSubTitle

    String htmlSubTitle

The HTML subtitle for the manager pages.

##### showProxySessions

    boolean showProxySessions

Whether to show proxy sessions in the output.

### Class org.apache.catalina.manager.JMXProxyServlet

class JMXProxyServlet extends HttpServlet implements Serializable

serialVersionUID:
  1L

### Class org.apache.catalina.manager.ManagerServlet

class ManagerServlet extends HttpServlet implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### configBase

    File configBase

Path where context descriptors should be deployed.

##### debug

    int debug

The debugging detail level for this servlet.

##### oname

    ObjectName oname

The associated deployer ObjectName.

##### versioned

    File versioned

Path used to store revisions of webapps.

### Class org.apache.catalina.manager.StatusManagerServlet

class StatusManagerServlet extends HttpServlet implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### globalRequestProcessors

    List<ObjectName> globalRequestProcessors

Vector of global request processors object names.

##### mBeanServer

    MBeanServer mBeanServer

MBean server.

##### requestProcessors

    List<ObjectName> requestProcessors

Vector of request processors object names.

##### threadPools

    List<ObjectName> threadPools

Vector of thread pools object names.

## Package org.apache.catalina.manager.host

### Class org.apache.catalina.manager.host.HostManagerServlet

class HostManagerServlet extends HttpServlet implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### debug

    int debug

The debugging detail level for this servlet.

### Class org.apache.catalina.manager.host.HTMLHostManagerServlet

class HTMLHostManagerServlet extends HostManagerServlet implements Serializable

serialVersionUID:
  1L

## Package org.apache.catalina.realm

### Class org.apache.catalina.realm.GenericPrincipal

class GenericPrincipal extends Object implements Serializable

serialVersionUID:
  1L

#### Serialization Methods

##### writeReplace

private Object writeReplace()
Returns a serializable replacement for this principal.

#### Serialized Fields

##### attributes

    Map<String,Object> attributes

The additional attributes associated with this Principal.

##### name

    String name

The username of the user represented by this Principal.

##### roles

    String[] roles

The set of roles associated with this user.

##### userPrincipal

    Principal userPrincipal

The authenticated Principal to be exposed to applications.

### Class org.apache.catalina.realm.UserDatabaseRealm.UserDatabasePrincipal

class UserDatabasePrincipal extends GenericPrincipal implements Serializable

serialVersionUID:
  1L

#### Serialization Methods

##### writeReplace

private Object writeReplace() throws ObjectStreamException
Magic method from `Serializable`.

Throws:
  `ObjectStreamException` - Not thrown by this implementation

## Package org.apache.catalina.servlets

### Class org.apache.catalina.servlets.CGIServlet

class CGIServlet extends HttpServlet implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### cgiExecutable

    String cgiExecutable

the executable to use with the script

##### cgiExecutableArgs

    List<String> cgiExecutableArgs

additional arguments for the executable

##### cgiMethods

    Set<String> cgiMethods

The HTTP methods this servlet will pass to the CGI script.

##### cgiMethodsAll

    boolean cgiMethodsAll

Whether all HTTP methods are allowed for CGI scripts.

##### cgiPathPrefix

    String cgiPathPrefix

The CGI search path will start at webAppRootDir + File.separator + cgiPathPrefix (or webAppRootDir alone if cgiPathPrefix is null)

##### cmdLineArgumentsDecodedPattern

    Pattern cmdLineArgumentsDecodedPattern

Limits the decoded form of individual command line arguments. Default varies by platform.

##### cmdLineArgumentsEncodedPattern

    Pattern cmdLineArgumentsEncodedPattern

Limits the encoded form of individual command line arguments. By default, values are limited to those allowed by the RFC. See https://tools.ietf.org/html/rfc3875#section-4.4 Uses \Q...\E to avoid individual quoting.

##### enableCmdLineArguments

    boolean enableCmdLineArguments

Enable creation of script command line arguments from query-string. See https://tools.ietf.org/html/rfc3875#section-4.4 4.4. The Script Command Line

##### envHttpHeadersPattern

    Pattern envHttpHeadersPattern

The regular expression used to select HTTP headers to be passed to the CGI process as environment variables. The name of the environment variable will be the name of the HTTP header converter to upper case, prefixed with `HTTP_` and with all `-` characters converted to `_`.

##### parameterEncoding

    String parameterEncoding

the encoding to use for parameters

##### shellEnv

    Map<String,String> shellEnv

the shell environment variables to be passed to the CGI script

##### stderrTimeout

    long stderrTimeout

The time (in milliseconds) to wait for the reading of stderr to complete before terminating the CGI process.

### Class org.apache.catalina.servlets.DefaultServlet

class DefaultServlet extends HttpServlet implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### allowPartialPut

    boolean allowPartialPut

Flag that indicates whether partial PUTs are permitted.

##### allowPostAsGet

    boolean allowPostAsGet

Will direct (`DispatcherType.REQUEST` or `DispatcherType.ASYNC`) requests using the POST method be processed as GET requests. If not allowed, direct requests using the POST method will be rejected with a 405 (method not allowed).

##### compressionFormats

    DefaultServlet.CompressionFormat[] compressionFormats

List of compression formats to serve and their preference order.

##### contextXsltFile

    String contextXsltFile

Allow customized directory listing per context.

##### debug

    int debug

The debugging detail level for this servlet.

##### directoryRedirectStatusCode

    int directoryRedirectStatusCode

Status code to use for directory redirects.

##### fileEncoding

    String fileEncoding

File encoding to be used when reading static files. If none is specified the platform default is used.

##### globalXsltFile

    String globalXsltFile

Allow customized directory listing per instance.

##### input

    int input

The input buffer size to use when serving resources.

##### listings

    boolean listings

Should we generate directory listings?

##### localXsltFile

    String localXsltFile

Allow customized directory listing per directory.

##### output

    int output

The output buffer size to use when serving resources.

##### readmeFile

    String readmeFile

Allow a readme file to be included.

##### readOnly

    boolean readOnly

Read only flag. By default, it's set to true.

##### sendfileSize

    int sendfileSize

Minimum size for sendfile usage in bytes.

##### showServerInfo

    boolean showServerInfo

Flag to determine if server information is presented.

##### sortListings

    boolean sortListings

Flag to determine if resources should be sorted.

##### useAcceptRanges

    boolean useAcceptRanges

Deprecated.
This option will be removed without replacement in Tomcat 12 onwards where it will effectively be hard coded to `true`.
Should the Accept-Ranges: bytes header be send with static resources?

##### useBomIfPresent

    org.apache.catalina.servlets.DefaultServlet.BomConfig useBomIfPresent

If a file has a BOM, should that be used in preference to fileEncoding? Will default to `DefaultServlet.BomConfig.TRUE` in `DefaultServlet.init()`.

##### useStrongETags

    boolean useStrongETags

Use strong etags whenever possible.

### Record Class org.apache.catalina.servlets.DefaultServlet.CompressionFormat

class CompressionFormat extends Record implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### encoding

    String encoding

The field for the `encoding` record component.

##### extension

    String extension

The field for the `extension` record component.

### Class org.apache.catalina.servlets.WebdavServlet

class WebdavServlet extends DefaultServlet implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### allowSpecialPaths

    boolean allowSpecialPaths

Is access allowed via WebDAV to the special paths (/WEB-INF and /META-INF)?

##### maxDepth

    int maxDepth

Default depth in spec is infinite.

##### maxRequestBodySize

    int maxRequestBodySize

The maximum size of the request body in bytes.

##### resourceLocks

    ConcurrentHashMap<String, org.apache.catalina.servlets.WebdavServlet.LockInfo> resourceLocks

Repository of all locks, keyed by path.

##### serveSubpathOnly

    boolean serveSubpathOnly

Serve resources from the mounted subpath only, restoring the behavior of `DefaultServlet`.

##### sharedLocks

    ConcurrentHashMap<String, org.apache.catalina.servlets.WebdavServlet.LockInfo> sharedLocks

Map of all shared locks, keyed by lock token.

##### store

    WebdavServlet.PropertyStore store

Property store used for storage of dead properties.

##### strictIfProcessing

    boolean strictIfProcessing

Is the if header processing strict.

## Package org.apache.catalina.session

### Class org.apache.catalina.session.StandardSession

class StandardSession extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### attributes

    ConcurrentMap<String,Object> attributes

The collection of user data attributes associated with this Session.

##### creationTime

    long creationTime

The time this session was created, in milliseconds since midnight, January 1, 1970 GMT.

##### id

    String id

The session identifier of this Session.

##### isNew

    boolean isNew

Flag indicating whether this session is new or not.

##### isValid

    boolean isValid

Flag indicating whether this session is valid or not.

##### lastAccessedTime

    long lastAccessedTime

The last accessed time for this Session.

##### maxInactiveInterval

    int maxInactiveInterval

The maximum time interval, in seconds, between client requests before the servlet container may invalidate this session. A negative time indicates that the session should never time out.

##### thisAccessedTime

    long thisAccessedTime

The current accessed time for this session.

### Exception Class org.apache.catalina.session.TooManyActiveSessionsException

class TooManyActiveSessionsException extends IllegalStateException implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### maxActiveSessions

    int maxActiveSessions

The maximum number of active sessions the server will tolerate.

## Package org.apache.catalina.ssi

### Class org.apache.catalina.ssi.SSIFilter

class SSIFilter extends GenericFilter implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### allowExec

    boolean allowExec

When true, allows the exec directive (normally blocked for security).

##### contentTypeRegEx

    Pattern contentTypeRegEx

Regex pattern to match when evaluating content types for SSI processing.

##### debug

    int debug

Debug level for this servlet.

##### expires

    Long expires

Expiration time in seconds for the doc.

##### isVirtualWebappRelative

    boolean isVirtualWebappRelative

When true, virtual paths are interpreted as webapp-relative.

##### shtmlRegEx

    Pattern shtmlRegEx

Default pattern for matching SHTML content type.

### Class org.apache.catalina.ssi.SSIServlet

class SSIServlet extends HttpServlet implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### allowExec

    boolean allowExec

Allow exec (normally blocked for security)

##### buffered

    boolean buffered

Should the output be buffered.

##### debug

    int debug

Debug level for this servlet.

##### expires

    Long expires

Expiration time in seconds for the doc.

##### inputEncoding

    String inputEncoding

Input encoding. If not specified, uses platform default

##### isVirtualWebappRelative

    boolean isVirtualWebappRelative

virtual path can be webapp-relative

##### outputEncoding

    String outputEncoding

Output encoding. If not specified, uses platform default

### Exception Class org.apache.catalina.ssi.SSIStopProcessingException

class SSIStopProcessingException extends Exception implements Serializable

serialVersionUID:
  1L

## Package org.apache.catalina.tribes

### Class org.apache.catalina.tribes.ByteMessage

class ByteMessage extends Object implements Externalizable

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException

Throws:
  `IOException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

### Exception Class org.apache.catalina.tribes.ChannelException

class ChannelException extends Exception implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### faultyMembers

    ArrayList<ChannelException.FaultyMember> faultyMembers

Holds a list of faulty members

### Class org.apache.catalina.tribes.ChannelException.FaultyMember

class FaultyMember extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### cause

    Exception cause

The cause of the failure.

##### member

    Member member

The member that failed.

### Exception Class org.apache.catalina.tribes.RemoteProcessException

class RemoteProcessException extends RuntimeException implements Serializable

serialVersionUID:
  1L

### Class org.apache.catalina.tribes.UniqueId

class UniqueId extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### id

    byte[] id

The raw byte array containing the unique identifier.

## Package org.apache.catalina.tribes.group

### Class org.apache.catalina.tribes.group.AbsoluteOrder.AbsoluteComparator

class AbsoluteComparator extends Object implements Serializable

serialVersionUID:
  1L

### Class org.apache.catalina.tribes.group.RpcMessage

class RpcMessage extends Object implements Externalizable

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Throws:
  `IOException`
  `ClassNotFoundException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

### Class org.apache.catalina.tribes.group.RpcMessage.NoRpcChannelReply

class NoRpcChannelReply extends RpcMessage implements Externalizable

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Throws:
  `IOException`
  `ClassNotFoundException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

## Package org.apache.catalina.tribes.io

### Class org.apache.catalina.tribes.io.ChannelData

class ChannelData extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### address

    Member address

The source or reply-to address for this message

##### message

    XByteBuffer message

The message data, stored in a dynamic buffer

##### options

    int options

The options this message was sent with

##### timestamp

    long timestamp

The timestamp that goes with this message

##### uniqueId

    byte[] uniqueId

A unique message id

### Class org.apache.catalina.tribes.io.XByteBuffer

class XByteBuffer extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### buf

    byte[] buf

Variable to hold the data

##### bufSize

    int bufSize

Current length of data in the buffer

##### discard

    boolean discard

Flag for discarding invalid packages If this flag is set to true, and append(byte[],...) is called, the data added will be inspected, and if it doesn't start with `START_DATA` it will be thrown away.

## Package org.apache.catalina.tribes.membership

### Class org.apache.catalina.tribes.membership.MemberImpl

class MemberImpl extends Object implements Externalizable

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Throws:
  `IOException`
  `ClassNotFoundException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

### Class org.apache.catalina.tribes.membership.StaticMember

class StaticMember extends MemberImpl implements Externalizable

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Throws:
  `IOException`
  `ClassNotFoundException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

### Class org.apache.catalina.tribes.membership.StaticMembershipProvider.MemberMessage

class MemberMessage extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### member

    Member member

The member associated with this message.

##### membershipId

    byte[] membershipId

The membership group identifier.

##### msgtype

    int msgtype

The type of this member message.

## Package org.apache.catalina.tribes.tipis

### Class org.apache.catalina.tribes.tipis.AbstractReplicatedMap

class AbstractReplicatedMap extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### innerMap

    ConcurrentMap<K, AbstractReplicatedMap.MapEntry<K,V>> innerMap

The underlying concurrent map storing entries.

##### log

    Log log

The logger instance.

### Class org.apache.catalina.tribes.tipis.AbstractReplicatedMap.MapMessage

class MapMessage extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### diff

    boolean diff

Whether this is a diff message.

##### diffvalue

    byte[] diffvalue

The diff value data.

##### keydata

    byte[] keydata

The serialized key data.

##### mapId

    byte[] mapId

The map identifier.

##### msgtype

    int msgtype

The message type.

##### nodes

    Member[] nodes

The backup nodes.

##### primary

    Member primary

The primary member.

##### valuedata

    byte[] valuedata

The serialized value data.

### Class org.apache.catalina.tribes.tipis.LazyReplicatedMap

class LazyReplicatedMap extends AbstractReplicatedMap<K,V> implements Serializable

serialVersionUID:
  1L

### Class org.apache.catalina.tribes.tipis.ReplicatedMap

class ReplicatedMap extends AbstractReplicatedMap<K,V> implements Serializable

serialVersionUID:
  1L

## Package org.apache.catalina.util

### Class org.apache.catalina.util.ParameterMap

class ParameterMap extends Object implements Serializable

serialVersionUID:
  2L

#### Serialized Fields

##### delegatedMap

    Map<K,V> delegatedMap

The underlying map to which operations are delegated.

##### locked

    boolean locked

The current lock state of this parameter map.

##### unmodifiableDelegatedMap

    Map<K,V> unmodifiableDelegatedMap

An unmodifiable view of the delegated map.

### Class org.apache.catalina.util.ResourceSet

class ResourceSet extends HashSet<T> implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### locked

    boolean locked

The current lock state of this set.

## Package org.apache.coyote

### Exception Class org.apache.coyote.BadRequestException

class BadRequestException extends IOException implements Serializable

serialVersionUID:
  1L

### Exception Class org.apache.coyote.CloseNowException

class CloseNowException extends IOException implements Serializable

serialVersionUID:
  1L

### Exception Class org.apache.coyote.ProtocolException

class ProtocolException extends RuntimeException implements Serializable

serialVersionUID:
  1L

## Package org.apache.coyote.http11

### Exception Class org.apache.coyote.http11.HeadersTooLargeException

class HeadersTooLargeException extends IllegalStateException implements Serializable

serialVersionUID:
  1L

## Package org.apache.el

### Class org.apache.el.MethodExpressionImpl

class MethodExpressionImpl extends MethodExpression implements Externalizable

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Throws:
  `IOException`
  `ClassNotFoundException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

### Class org.apache.el.MethodExpressionLiteral

class MethodExpressionLiteral extends MethodExpression implements Externalizable

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Throws:
  `IOException`
  `ClassNotFoundException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

### Class org.apache.el.ValueExpressionImpl

class ValueExpressionImpl extends ValueExpression implements Externalizable

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Throws:
  `IOException`
  `ClassNotFoundException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

### Class org.apache.el.ValueExpressionLiteral

class ValueExpressionLiteral extends ValueExpression implements Externalizable

serialVersionUID:
  1L

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Throws:
  `IOException`
  `ClassNotFoundException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

## Package org.apache.el.lang

### Class org.apache.el.lang.FunctionMapperImpl

class FunctionMapperImpl extends FunctionMapper implements Externalizable

serialVersionUID:
  1L

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Throws:
  `IOException`
  `ClassNotFoundException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

### Class org.apache.el.lang.FunctionMapperImpl.Function

class Function extends Object implements Externalizable

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Throws:
  `IOException`
  `ClassNotFoundException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

### Class org.apache.el.lang.VariableMapperImpl

class VariableMapperImpl extends VariableMapper implements Externalizable

serialVersionUID:
  1L

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Throws:
  `IOException`
  `ClassNotFoundException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

## Package org.apache.jasper

### Exception Class org.apache.jasper.JasperException

class JasperException extends ServletException implements Serializable

serialVersionUID:
  1L

## Package org.apache.jasper.el

### Exception Class org.apache.jasper.el.JspELException

class JspELException extends ELException implements Serializable

serialVersionUID:
  1L

### Class org.apache.jasper.el.JspMethodExpression

class JspMethodExpression extends MethodExpression implements Externalizable

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Throws:
  `IOException`
  `ClassNotFoundException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

### Exception Class org.apache.jasper.el.JspMethodNotFoundException

class JspMethodNotFoundException extends MethodNotFoundException implements Serializable

serialVersionUID:
  1L

### Exception Class org.apache.jasper.el.JspPropertyNotFoundException

class JspPropertyNotFoundException extends PropertyNotFoundException implements Serializable

serialVersionUID:
  1L

### Exception Class org.apache.jasper.el.JspPropertyNotWritableException

class JspPropertyNotWritableException extends PropertyNotWritableException implements Serializable

serialVersionUID:
  1L

### Class org.apache.jasper.el.JspValueExpression

class JspValueExpression extends ValueExpression implements Externalizable

#### Serialization Methods

##### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Throws:
  `IOException`
  `ClassNotFoundException`

##### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Throws:
  `IOException`

## Package org.apache.jasper.runtime

### Class org.apache.jasper.runtime.HttpJspBase

class HttpJspBase extends HttpServlet implements Serializable

serialVersionUID:
  1L

## Package org.apache.jasper.servlet

### Class org.apache.jasper.servlet.JspServlet

class JspServlet extends HttpServlet implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### config

    ServletConfig config

The servlet configuration.

##### jspFile

    String jspFile

The JSP file for a JSP configured explicitly as a servlet, in environments where this configuration is translated into an init-param for this servlet.

## Package org.apache.juli.logging

### Exception Class org.apache.juli.logging.LogConfigurationException

class LogConfigurationException extends RuntimeException implements Serializable

serialVersionUID:
  1L

## Package org.apache.naming

### Class org.apache.naming.AbstractRef

class AbstractRef extends Reference implements Serializable

serialVersionUID:
  1L

### Class org.apache.naming.EjbRef

class EjbRef extends AbstractRef implements Serializable

serialVersionUID:
  1L

### Class org.apache.naming.HandlerRef

class HandlerRef extends AbstractRef implements Serializable

serialVersionUID:
  1L

### Class org.apache.naming.LookupRef

class LookupRef extends AbstractRef implements Serializable

serialVersionUID:
  1L

### Class org.apache.naming.ResourceEnvRef

class ResourceEnvRef extends AbstractRef implements Serializable

serialVersionUID:
  1L

### Class org.apache.naming.ResourceLinkRef

class ResourceLinkRef extends AbstractRef implements Serializable

serialVersionUID:
  1L

### Class org.apache.naming.ResourceRef

class ResourceRef extends AbstractRef implements Serializable

serialVersionUID:
  1L

### Class org.apache.naming.ServiceRef

class ServiceRef extends AbstractRef implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### handlers

    List<HandlerRef> handlers

The list to save the handler Reference objects, because they can't be saved in the addrs vector.

### Class org.apache.naming.TransactionRef

class TransactionRef extends AbstractRef implements Serializable

serialVersionUID:
  1L

## Package org.apache.tomcat.dbcp.dbcp2

### Exception Class org.apache.tomcat.dbcp.dbcp2.ListException

class ListException extends Exception implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### exceptionList

    List<Throwable> exceptionList

A list of causes.

### Exception Class org.apache.tomcat.dbcp.dbcp2.SQLExceptionList

class SQLExceptionList extends SQLException implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### causeList

    List<? extends Throwable> causeList

The list of causes.

## Package org.apache.tomcat.dbcp.dbcp2.cpdsadapter

### Class org.apache.tomcat.dbcp.dbcp2.cpdsadapter.DriverAdapterCPDS

class DriverAdapterCPDS extends Object implements Serializable

serialVersionUID:
  -4820523787212147844L

#### Serialized Fields

##### accessToUnderlyingConnectionAllowed

    boolean accessToUnderlyingConnectionAllowed

Controls access to the underlying connection

##### connectionProperties

    Properties connectionProperties

Connection properties passed to JDBC Driver

##### connectionString

    String connectionString

Connection string

##### description

    String description

Description

##### driver

    String driver

Driver class name

##### durationBetweenEvictionRuns

    Duration durationBetweenEvictionRuns

PreparedStatement pool property defaults to `BaseObjectPoolConfig.DEFAULT_DURATION_BETWEEN_EVICTION_RUNS`.

##### getConnectionCalled

    boolean getConnectionCalled

Whether or not getConnection has been called

##### loginTimeout

    int loginTimeout

Login TimeOut in seconds

##### maxIdle

    int maxIdle

PreparedStatement pool property defaults to 10.

##### maxPreparedStatements

    int maxPreparedStatements

Maximum number of prepared statements, defaults to -1, meaning no limit.

##### minEvictableIdleDuration

    Duration minEvictableIdleDuration

PreparedStatement pool property defaults to `BaseObjectPoolConfig.DEFAULT_MIN_EVICTABLE_IDLE_DURATION`.

##### numTestsPerEvictionRun

    int numTestsPerEvictionRun

PreparedStatement pool property defaults to -1.

##### poolPreparedStatements

    boolean poolPreparedStatements

PreparedStatement pool property defaults to false.

##### userName

    String userName

User name

##### userPassword

    char[] userPassword

User password

## Package org.apache.tomcat.dbcp.dbcp2.datasources

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

class InstanceKeyDataSource extends Object implements Serializable

serialVersionUID:
  -6819270431752240878L

#### Serialized Fields

##### dataSource

    ConnectionPoolDataSource dataSource

Underlying source of PooledConnections

##### dataSourceName

    String dataSourceName

DataSource Name used to find the ConnectionPoolDataSource

##### defaultAutoCommit

    Boolean defaultAutoCommit

Connection property defaults to false.

##### defaultBlockWhenExhausted

    boolean defaultBlockWhenExhausted

Pool property defaults to `BaseObjectPoolConfig.DEFAULT_BLOCK_WHEN_EXHAUSTED`.

##### defaultDurationBetweenEvictionRuns

    Duration defaultDurationBetweenEvictionRuns

Pool property defaults to `BaseObjectPoolConfig.DEFAULT_DURATION_BETWEEN_EVICTION_RUNS`.

##### defaultEvictionPolicyClassName

    String defaultEvictionPolicyClassName

Pool property defaults to `BaseObjectPoolConfig.DEFAULT_EVICTION_POLICY_CLASS_NAME`.

##### defaultLifo

    boolean defaultLifo

Pool property defaults to `BaseObjectPoolConfig.DEFAULT_LIFO`.

##### defaultMaxIdle

    int defaultMaxIdle

Pool property defaults to `GenericKeyedObjectPoolConfig.DEFAULT_MAX_IDLE_PER_KEY`.

##### defaultMaxTotal

    int defaultMaxTotal

Pool property defaults to `GenericKeyedObjectPoolConfig.DEFAULT_MAX_TOTAL`.

##### defaultMaxWaitDuration

    Duration defaultMaxWaitDuration

Pool property defaults to `BaseObjectPoolConfig.DEFAULT_MAX_WAIT`.

##### defaultMinEvictableIdleDuration

    Duration defaultMinEvictableIdleDuration

Pool property defaults to `BaseObjectPoolConfig.DEFAULT_MIN_EVICTABLE_IDLE_DURATION`.

##### defaultMinIdle

    int defaultMinIdle

Pool property defaults to `GenericKeyedObjectPoolConfig.DEFAULT_MIN_IDLE_PER_KEY`.

##### defaultNumTestsPerEvictionRun

    int defaultNumTestsPerEvictionRun

Pool property defaults to `BaseObjectPoolConfig.DEFAULT_NUM_TESTS_PER_EVICTION_RUN`.

##### defaultReadOnly

    Boolean defaultReadOnly

Connection property defaults to false.

##### defaultSoftMinEvictableIdleDuration

    Duration defaultSoftMinEvictableIdleDuration

Pool property defaults to `BaseObjectPoolConfig.DEFAULT_SOFT_MIN_EVICTABLE_IDLE_DURATION`.

##### defaultTestOnBorrow

    boolean defaultTestOnBorrow

Pool property defaults to `BaseObjectPoolConfig.DEFAULT_TEST_ON_BORROW`.

##### defaultTestOnCreate

    boolean defaultTestOnCreate

Pool property defaults to `BaseObjectPoolConfig.DEFAULT_TEST_ON_CREATE`.

##### defaultTestOnReturn

    boolean defaultTestOnReturn

Pool property defaults to `BaseObjectPoolConfig.DEFAULT_TEST_ON_RETURN`.

##### defaultTestWhileIdle

    boolean defaultTestWhileIdle

Pool property defaults to `BaseObjectPoolConfig.DEFAULT_TEST_WHILE_IDLE`.

##### defaultTransactionIsolation

    int defaultTransactionIsolation

Connection property defaults to `InstanceKeyDataSource.UNKNOWN_TRANSACTIONISOLATION`.

##### description

    String description

Description

##### getConnectionCalled

    boolean getConnectionCalled

Guards property setters - once true, setters throw IllegalStateException

##### instanceKey

    String instanceKey

Instance key

##### jndiEnvironment

    Properties jndiEnvironment

Environment that may be used to set up a JNDI initial context.

##### loginTimeoutDuration

    Duration loginTimeoutDuration

Login Timeout

##### logWriter

    PrintWriter logWriter

Log stream

##### maxConnDuration

    Duration maxConnDuration

Connection factory property defaults to -1 milliseconds.

##### rollbackAfterValidation

    boolean rollbackAfterValidation

Connection factory property defaults to false.

##### validationQuery

    String validationQuery

Connection factory property defaults to null.

##### validationQueryTimeoutDuration

    Duration validationQueryTimeoutDuration

Connection factory property defaults to -1 seconds.

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

class PerUserPoolDataSource extends InstanceKeyDataSource implements Serializable

serialVersionUID:
  7872747993848065028L

#### Serialization Methods

##### readObject

private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
Deserializes an instance from an ObjectInputStream.

Parameters:
  `in` - The source ObjectInputStream.
Throws:
  `IOException` - Any of the usual Input/Output related exceptions.
  `ClassNotFoundException` - A class of a serialized object cannot be found.

#### Serialized Fields

##### perUserBlockWhenExhausted

    Map<String,Boolean> perUserBlockWhenExhausted

Maps user names to a data source property: BlockWhenExhausted.

##### perUserDefaultAutoCommit

    Map<String,Boolean> perUserDefaultAutoCommit

Maps user names to a data source property: DefaultAutoCommit.

##### perUserDefaultReadOnly

    Map<String,Boolean> perUserDefaultReadOnly

Maps user names to a data source property: DefaultReadOnly.

##### perUserDefaultTransactionIsolation

    Map<String,Integer> perUserDefaultTransactionIsolation

Maps user names to a data source property: DefaultTransactionIsolation.

##### perUserDurationBetweenEvictionRuns

    Map<String,Duration> perUserDurationBetweenEvictionRuns

Maps user names to a data source property: DurationBetweenEvictionRuns.

##### perUserEvictionPolicyClassName

    Map<String,String> perUserEvictionPolicyClassName

Maps user names to a data source property: EvictionPolicyClassName.

##### perUserLifo

    Map<String,Boolean> perUserLifo

Maps user names to a data source property: Lifo.

##### perUserMaxIdle

    Map<String,Integer> perUserMaxIdle

Maps user names to a data source property: MaxIdle.

##### perUserMaxTotal

    Map<String,Integer> perUserMaxTotal

Maps user names to a data source property: MaxTotal.

##### perUserMaxWaitDuration

    Map<String,Duration> perUserMaxWaitDuration

Maps user names to a data source property: MaxWaitDuration.

##### perUserMinEvictableIdleDuration

    Map<String,Duration> perUserMinEvictableIdleDuration

Maps user names to a data source property: MinEvictableIdleDuration.

##### perUserMinIdle

    Map<String,Integer> perUserMinIdle

Maps user names to a data source property: MinIdle.

##### perUserNumTestsPerEvictionRun

    Map<String,Integer> perUserNumTestsPerEvictionRun

Maps user names to a data source property: NumTestsPerEvictionRun.

##### perUserSoftMinEvictableIdleDuration

    Map<String,Duration> perUserSoftMinEvictableIdleDuration

Maps user names to a data source property: SoftMinEvictableIdleDuration.

##### perUserTestOnBorrow

    Map<String,Boolean> perUserTestOnBorrow

Maps user names to a data source property: TestOnBorrow.

##### perUserTestOnCreate

    Map<String,Boolean> perUserTestOnCreate

Maps user names to a data source property: TestOnCreate.

##### perUserTestOnReturn

    Map<String,Boolean> perUserTestOnReturn

Maps user names to a data source property: TestOnReturn.

##### perUserTestWhileIdle

    Map<String,Boolean> perUserTestWhileIdle

Maps user names to a data source property: TestWhileIdle.

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

class SharedPoolDataSource extends InstanceKeyDataSource implements Serializable

serialVersionUID:
  -1458539734480586454L

#### Serialization Methods

##### readObject

private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
Deserializes an instance from an ObjectInputStream.

Parameters:
  `in` - The source ObjectInputStream.
Throws:
  `IOException` - Any of the usual Input/Output related exceptions.
  `ClassNotFoundException` - A class of a serialized object cannot be found.

#### Serialized Fields

##### maxTotal

    int maxTotal

Max total defaults to `GenericKeyedObjectPoolConfig.DEFAULT_MAX_TOTAL`.

## Package org.apache.tomcat.jdbc.pool

### Exception Class org.apache.tomcat.jdbc.pool.PoolExhaustedException

class PoolExhaustedException extends SQLException implements Serializable

serialVersionUID:
  3501536931777262475L

### Class org.apache.tomcat.jdbc.pool.PoolProperties

class PoolProperties extends Object implements Serializable

serialVersionUID:
  -8519283440854213745L

#### Serialized Fields

##### abandonWhenPercentageFull

    int abandonWhenPercentageFull

The percentage threshold for abandoning connections.

##### accessToUnderlyingConnectionAllowed

    boolean accessToUnderlyingConnectionAllowed

Whether to allow access to the underlying connection.

##### alternateUsernameAllowed

    boolean alternateUsernameAllowed

Whether alternate usernames are allowed.

##### commitOnReturn

    boolean commitOnReturn

Whether to commit on connection return.

##### connectionProperties

    String connectionProperties

Additional connection properties.

##### dataSource

    Object dataSource

The underlying data source.

##### dataSourceJNDI

    String dataSourceJNDI

The JNDI name of the data source.

##### dbProperties

    Properties dbProperties

Database-specific properties.

##### defaultAutoCommit

    Boolean defaultAutoCommit

The default auto-commit setting for connections.

##### defaultCatalog

    String defaultCatalog

The default catalog for connections.

##### defaultReadOnly

    Boolean defaultReadOnly

The default read-only setting for connections.

##### defaultTransactionIsolation

    int defaultTransactionIsolation

The default transaction isolation level.

##### driverClassName

    String driverClassName

The JDBC driver class name.

##### fairQueue

    boolean fairQueue

Whether to use a fair queue for connection requests.

##### ignoreExceptionOnPreLoad

    boolean ignoreExceptionOnPreLoad

Whether to ignore exceptions during pre-load.

##### initialSize

    int initialSize

The initial number of connections in the pool.

##### initSQL

    String initSQL

The SQL to execute on connection creation.

##### interceptors

    PoolProperties.InterceptorDefinition[] interceptors

The interceptor definitions.

##### jdbcInterceptors

    String jdbcInterceptors

The JDBC interceptors configuration.

##### jmxEnabled

    boolean jmxEnabled

Whether JMX registration is enabled.

##### logAbandoned

    boolean logAbandoned

Whether to log abandoned connections.

##### logValidationErrors

    boolean logValidationErrors

Whether to log validation errors.

##### maxActive

    int maxActive

The maximum number of active connections.

##### maxAge

    long maxAge

The maximum age of a connection in milliseconds.

##### maxIdle

    int maxIdle

The maximum number of idle connections.

##### maxWait

    int maxWait

The maximum wait time in milliseconds for a connection.

##### minEvictableIdleTimeMillis

    int minEvictableIdleTimeMillis

The minimum idle time before a connection is eligible for eviction.

##### minIdle

    int minIdle

The minimum number of idle connections.

##### name

    String name

The pool name.

##### numTestsPerEvictionRun

    int numTestsPerEvictionRun

The number of connections to test per eviction run.

##### password

    String password

The database password.

##### propagateInterruptState

    boolean propagateInterruptState

Whether to propagate interrupt state.

##### removeAbandoned

    boolean removeAbandoned

Whether to remove abandoned connections.

##### removeAbandonedTimeout

    int removeAbandonedTimeout

The timeout in seconds for abandoned connection removal.

##### rollbackOnReturn

    boolean rollbackOnReturn

Whether to rollback on connection return.

##### suspectTimeout

    int suspectTimeout

The suspect timeout in seconds.

##### testOnBorrow

    boolean testOnBorrow

Whether to validate connections on borrow.

##### testOnConnect

    boolean testOnConnect

Whether to validate connections on creation.

##### testOnReturn

    boolean testOnReturn

Whether to validate connections on return.

##### testWhileIdle

    boolean testWhileIdle

Whether to validate idle connections.

##### timeBetweenEvictionRunsMillis

    int timeBetweenEvictionRunsMillis

The time between eviction runs in milliseconds.

##### url

    String url

The JDBC connection URL.

##### useDisposableConnectionFacade

    boolean useDisposableConnectionFacade

Whether to use a disposable connection facade.

##### useEquals

    boolean useEquals

Whether to use equals for object comparison.

##### useLock

    boolean useLock

Whether to use locking for thread safety.

##### username

    String username

The database username.

##### useStatementFacade

    boolean useStatementFacade

Whether to use a statement facade.

##### validationInterval

    long validationInterval

The validation interval in milliseconds.

##### validationQuery

    String validationQuery

The SQL query used for validation.

##### validationQueryTimeout

    int validationQueryTimeout

The validation query timeout in seconds.

##### validatorClassName

    String validatorClassName

The fully qualified class name of the validator.

### Class org.apache.tomcat.jdbc.pool.PoolProperties.InterceptorDefinition

class InterceptorDefinition extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### className

    String className

Interceptor class name.

##### clazz

    Class<?> clazz

Cached interceptor class.

##### properties

    Map<String, PoolProperties.InterceptorProperty> properties

Map of interceptor properties.

### Class org.apache.tomcat.jdbc.pool.PoolProperties.InterceptorProperty

class InterceptorProperty extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### name

    String name

Property name.

##### value

    String value

Property value.

## Package org.apache.tomcat.jni

### Exception Class org.apache.tomcat.jni.LibraryNotFoundError

class LibraryNotFoundError extends UnsatisfiedLinkError implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### libraryNames

    String libraryNames

The names of the libraries that failed to load.

## Package org.apache.tomcat.util

### Exception Class org.apache.tomcat.util.MultiThrowable

class MultiThrowable extends Throwable implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### throwables

    List<Throwable> throwables

The list of wrapped throwables.

## Package org.apache.tomcat.util.bcel.classfile

### Exception Class org.apache.tomcat.util.bcel.classfile.ClassFormatException

class ClassFormatException extends RuntimeException implements Serializable

serialVersionUID:
  3243149520175287759L

## Package org.apache.tomcat.util.buf

### Class org.apache.tomcat.util.buf.AbstractChunk

class AbstractChunk extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### end

    int end

The end position of the data in the buffer.

##### hasHashCode

    boolean hasHashCode

Indicates whether the hash code has been computed.

##### hashCode

    int hashCode

The cached hash code.

##### isSet

    boolean isSet

Indicates whether the chunk has been initialized.

##### limit

    int limit

The limit on the amount of data in the buffer.

##### start

    int start

The start position of the data in the buffer.

### Class org.apache.tomcat.util.buf.ByteChunk

class ByteChunk extends AbstractChunk implements Serializable

serialVersionUID:
  1L

#### Serialization Methods

##### readObject

private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException
Deserializes this ByteChunk, restoring the charset.

Parameters:
  `ois` - the object input stream
Throws:
  `ClassNotFoundException` - if the class is not found
  `IOException` - if an I/O error occurs

##### writeObject

private void writeObject(ObjectOutputStream oos) throws IOException
Serializes this ByteChunk, writing the charset name.

Parameters:
  `oos` - the object output stream
Throws:
  `IOException` - if an I/O error occurs

#### Serialized Fields

##### buff

    byte[] buff

The underlying byte buffer.

### Exception Class org.apache.tomcat.util.buf.ByteChunk.BufferOverflowException

class BufferOverflowException extends IOException implements Serializable

serialVersionUID:
  1L

### Class org.apache.tomcat.util.buf.CharChunk

class CharChunk extends AbstractChunk implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### buff

    char[] buff

The underlying character buffer.

### Class org.apache.tomcat.util.buf.MessageBytes

class MessageBytes extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### byteC

    ByteChunk byteC

The internal byte chunk for byte array representation.

##### charC

    CharChunk charC

The internal char chunk for character array representation.

##### hasHashCode

    boolean hasHashCode

Whether the hash code has been computed.

##### hashCode

    int hashCode

The cached hash code value.

##### hasLongValue

    boolean hasLongValue

Whether the long value has been computed.

##### longValue

    long longValue

The cached long value.

##### strValue

    String strValue

The cached string value.

##### type

    int type

The primary data type of this MessageBytes instance.

## Package org.apache.tomcat.util.descriptor.web

### Class org.apache.tomcat.util.descriptor.web.ApplicationParameter

class ApplicationParameter extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### description

    String description

The description of this environment entry.

##### name

    String name

The name of this application parameter.

##### override

    boolean override

Does this application parameter allow overrides by the application deployment descriptor?

##### value

    String value

The value of this application parameter.

### Class org.apache.tomcat.util.descriptor.web.ContextEjb

class ContextEjb extends ResourceBase implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### home

    String home

The name of the EJB home implementation class.

##### link

    String link

The link to a Jakarta EE EJB definition.

##### remote

    String remote

The name of the EJB remote implementation class.

### Class org.apache.tomcat.util.descriptor.web.ContextEnvironment

class ContextEnvironment extends ResourceBase implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### override

    boolean override

Does this environment entry allow overrides by the application deployment descriptor?

##### value

    String value

The value of this environment entry.

### Class org.apache.tomcat.util.descriptor.web.ContextHandler

class ContextHandler extends ResourceBase implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### handlerclass

    String handlerclass

The Handler reference class.

##### portNames

    List<String> portNames

The portName.

##### soapHeaders

    Map<String,String> soapHeaders

A list of QName specifying the SOAP Headers the handler will work on. -namespace and localpart values must be found inside the WSDL.

A service-qname is composed by a namespaceURI and a localpart.

soapHeader[0] : namespaceURI soapHeader[1] : localpart

##### soapRoles

    List<String> soapRoles

The soapRole.

### Class org.apache.tomcat.util.descriptor.web.ContextLocalEjb

class ContextLocalEjb extends ResourceBase implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### home

    String home

The name of the EJB home implementation class.

##### link

    String link

The link to a Jakarta EE EJB definition.

##### local

    String local

The name of the EJB local implementation class.

### Class org.apache.tomcat.util.descriptor.web.ContextResource

class ContextResource extends ResourceBase implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### auth

    String auth

The authorization requirement for this resource (`Application` or `Container`).

##### closeMethod

    String closeMethod

The name of the zero argument method to be called when the resource is no longer required to clean-up resources. This method must only speed up the clean-up of resources that would otherwise happen via garbage collection.

##### closeMethodConfigured

    boolean closeMethodConfigured

Whether the close method has been explicitly configured.

##### scope

    String scope

The sharing scope of this resource factory (`Shareable` or `Unshareable`).

##### singleton

    boolean singleton

Is this resource known to be a singleton resource. The default value is true since this is what users expect although the Jakarta EE spec implies that the default should be false.

### Class org.apache.tomcat.util.descriptor.web.ContextResourceEnvRef

class ContextResourceEnvRef extends ResourceBase implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### override

    boolean override

Does this environment entry allow overrides by the application deployment descriptor?

### Class org.apache.tomcat.util.descriptor.web.ContextResourceLink

class ContextResourceLink extends ResourceBase implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### factory

    String factory

The factory to be used for creating the object

##### global

    String global

The global name of this resource.

### Class org.apache.tomcat.util.descriptor.web.ContextService

class ContextService extends ResourceBase implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### displayname

    String displayname

The WebService reference name.

##### handlers

    Map<String, ContextHandler> handlers

A list of Handlers to use for this service-ref. The instantiation of the handler have to be done.

##### jaxrpcmappingfile

    String jaxrpcmappingfile

A file specifying the correlation of the WSDL definition to the interfaces (Service Endpoint Interface, Service Interface).

##### largeIcon

    String largeIcon

A large icon for this WebService.

##### serviceInterface

    String serviceInterface

The fully qualified class name of the JAX-WS Service interface that the client depends on.

##### serviceqname

    String[] serviceqname

Declares the specific WSDL service element that is being referred to. It is not specified if no wsdl-file is declared or if WSDL contains only 1 service element.

A service-qname is composed by a namespaceURI and a localpart. It must be defined if more than 1 service is declared in the WSDL.

serviceqname[0] : namespaceURI serviceqname[1] : localpart

##### smallIcon

    String smallIcon

A small icon for this WebService.

##### wsdlfile

    String wsdlfile

Contains the location (relative to the root of the module) of the web service WSDL description.

### Class org.apache.tomcat.util.descriptor.web.ContextTransaction

class ContextTransaction extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### properties

    Map<String,Object> properties

Holder for our configured properties.

### Class org.apache.tomcat.util.descriptor.web.ErrorPage

class ErrorPage extends XmlEncodingBase implements Serializable

serialVersionUID:
  2L

#### Serialized Fields

##### errorCode

    int errorCode

The error (status) code for which this error page is active. Note that status code 0 is used for the default error page.

##### exceptionType

    String exceptionType

The exception type for which this error page is active.

##### location

    String location

The context-relative location to handle this error or exception.

### Class org.apache.tomcat.util.descriptor.web.FilterDef

class FilterDef extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### asyncSupported

    String asyncSupported

The async-supported setting for this filter.

##### asyncSupportedBoolean

    boolean asyncSupportedBoolean

The async-supported boolean setting for this filter.

##### description

    String description

The description of this filter.

##### displayName

    String displayName

The display name of this filter.

##### filterClass

    String filterClass

The fully qualified name of the Java class that implements this filter.

##### filterName

    String filterName

The name of this filter, which must be unique among the filters defined for a particular web application.

##### largeIcon

    String largeIcon

The large icon associated with this filter.

##### parameters

    Map<String,String> parameters

The set of initialization parameters for this filter, keyed by parameter name.

##### smallIcon

    String smallIcon

The small icon associated with this filter.

### Class org.apache.tomcat.util.descriptor.web.FilterMap

class FilterMap extends XmlEncodingBase implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### dispatcherMapping

    int dispatcherMapping

The dispatcher mapping bitmask for this filter mapping.

##### filterName

    String filterName

The name of the filter associated with this mapping.

##### matchAllServletNames

    boolean matchAllServletNames

The flag that indicates this mapping will match all servlet-names

##### matchAllUrlPatterns

    boolean matchAllUrlPatterns

The flag that indicates this mapping will match all url-patterns

##### servletNames

    String[] servletNames

The servlet name this mapping matches.

##### urlPatterns

    String[] urlPatterns

The URL pattern this mapping matches.

### Class org.apache.tomcat.util.descriptor.web.InjectionTarget

class InjectionTarget extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### targetClass

    String targetClass

The fully qualified class name of the injection target.

##### targetName

    String targetName

The name of the field or method to inject into.

### Class org.apache.tomcat.util.descriptor.web.LoginConfig

class LoginConfig extends XmlEncodingBase implements Serializable

serialVersionUID:
  2L

#### Serialized Fields

##### authMethod

    String authMethod

The authentication method to use for application login. Must be BASIC, DIGEST, FORM, or CLIENT-CERT.

##### errorPage

    String errorPage

The context-relative URI of the error page for form login.

##### loginPage

    String loginPage

The context-relative URI of the login page for form login.

##### realmName

    String realmName

The realm name used when challenging the user for authentication credentials.

### Class org.apache.tomcat.util.descriptor.web.MessageDestination

class MessageDestination extends ResourceBase implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### displayName

    String displayName

The display name of this destination.

##### largeIcon

    String largeIcon

The large icon of this destination.

##### smallIcon

    String smallIcon

The small icon of this destination.

### Class org.apache.tomcat.util.descriptor.web.MessageDestinationRef

class MessageDestinationRef extends ResourceBase implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### link

    String link

The link of this destination ref.

##### usage

    String usage

The usage of this destination ref.

### Class org.apache.tomcat.util.descriptor.web.MultipartDef

class MultipartDef extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### fileSizeThreshold

    String fileSizeThreshold

The file size threshold for switching to disk storage.

##### location

    String location

The location for temporary file storage.

##### maxFileSize

    String maxFileSize

The maximum allowed file size.

##### maxRequestSize

    String maxRequestSize

The maximum allowed request size.

### Class org.apache.tomcat.util.descriptor.web.ResourceBase

class ResourceBase extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### description

    String description

The description of this resource.

##### injectionTargets

    List<InjectionTarget> injectionTargets

The list of injection targets for this resource.

##### lookupName

    String lookupName

The JNDI lookup name for this resource.

##### name

    String name

The name of this resource.

##### properties

    Map<String,Object> properties

Holder for our configured properties.

##### resources

    NamingResources resources

The NamingResources with which we are associated (if any).

##### type

    String type

The name of the resource implementation class.

### Class org.apache.tomcat.util.descriptor.web.SecurityCollection

class SecurityCollection extends XmlEncodingBase implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### description

    String description

Description of this web resource collection.

##### isFromDescriptor

    boolean isFromDescriptor

This security collection was established by a deployment descriptor. Defaults to `true`.

##### methods

    String[] methods

The HTTP methods explicitly covered by this web resource collection.

##### name

    String name

The name of this web resource collection.

##### omittedMethods

    String[] omittedMethods

The HTTP methods explicitly excluded from this web resource collection.

##### patterns

    String[] patterns

The URL patterns protected by this security collection.

### Class org.apache.tomcat.util.descriptor.web.SecurityConstraint

class SecurityConstraint extends XmlEncodingBase implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### allRoles

    boolean allRoles

Was the "all roles" wildcard - `SecurityConstraint.ROLE_ALL_ROLES` - included in the authorization constraints for this security constraint?

##### authConstraint

    boolean authConstraint

Was an authorization constraint included in this security constraint? This is necessary to distinguish the case where an auth-constraint with no roles (signifying no direct access at all) was requested, versus a lack of auth-constraint which implies no access control checking.

##### authenticatedUsers

    boolean authenticatedUsers

Was the "all authenticated users" wildcard - `SecurityConstraint.ROLE_ALL_AUTHENTICATED_USERS` - included in the authorization constraints for this security constraint?

##### authRoles

    String[] authRoles

The set of roles permitted to access resources protected by this security constraint.

##### collections

    SecurityCollection[] collections

The set of web resource collections protected by this security constraint.

##### displayName

    String displayName

The display name of this security constraint.

##### userConstraint

    String userConstraint

The user data constraint for this security constraint. Must be NONE, INTEGRAL, or CONFIDENTIAL.

### Class org.apache.tomcat.util.descriptor.web.SecurityRoleRef

class SecurityRoleRef extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### link

    String link

The optional role link.

##### name

    String name

The (required) role name.

### Class org.apache.tomcat.util.descriptor.web.ServletDef

class ServletDef extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### asyncSupported

    Boolean asyncSupported

Does this servlet support async.

##### description

    String description

The description of this servlet.

##### displayName

    String displayName

The display name of this servlet.

##### enabled

    Boolean enabled

Is this servlet enabled.

##### jspFile

    String jspFile

The name of the JSP file to which this servlet definition applies

##### largeIcon

    String largeIcon

The large icon associated with this servlet.

##### loadOnStartup

    Integer loadOnStartup

The load-on-startup order for this servlet

##### multipartDef

    MultipartDef multipartDef

The multipart configuration, if any, for this servlet

##### overridable

    boolean overridable

Can this ServletDef be overridden by an SCI?

##### parameters

    Map<String,String> parameters

The set of initialization parameters for this servlet, keyed by parameter name.

##### runAs

    String runAs

The run-as configuration for this servlet

##### securityRoleRefs

    Set<SecurityRoleRef> securityRoleRefs

The set of security role references for this servlet

##### servletClass

    String servletClass

The fully qualified name of the Java class that implements this servlet.

##### servletName

    String servletName

The name of this servlet, which must be unique among the servlets defined for a particular web application.

##### smallIcon

    String smallIcon

The small icon associated with this servlet.

## Package org.apache.tomcat.util.digester

### Class org.apache.tomcat.util.digester.ArrayStack

class ArrayStack extends ArrayList<E> implements Serializable

serialVersionUID:
  2130079159931574599L

## Package org.apache.tomcat.util.http

### Exception Class org.apache.tomcat.util.http.InvalidParameterException

class InvalidParameterException extends IllegalStateException implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### errorCode

    int errorCode

The HTTP error code associated with this exception.

### Class org.apache.tomcat.util.http.ServerCookie

class ServerCookie extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### name

    MessageBytes name

The cookie name.

##### value

    MessageBytes value

The cookie value.

## Package org.apache.tomcat.util.http.fileupload

### Exception Class org.apache.tomcat.util.http.fileupload.FileItemStream.ItemSkippedException

class ItemSkippedException extends IOException implements Serializable

serialVersionUID:
  -7280778431581963740L

### Exception Class org.apache.tomcat.util.http.fileupload.FileUploadException

class FileUploadException extends IOException implements Serializable

serialVersionUID:
  -4222909057964038517L

### Exception Class org.apache.tomcat.util.http.fileupload.InvalidFileNameException

class InvalidFileNameException extends RuntimeException implements Serializable

serialVersionUID:
  7922042602454350470L

#### Serialized Fields

##### name

    String name

The file name causing the exception.

### Exception Class org.apache.tomcat.util.http.fileupload.MultipartStream.IllegalBoundaryException

class IllegalBoundaryException extends IOException implements Serializable

serialVersionUID:
  -161533165102632918L

### Exception Class org.apache.tomcat.util.http.fileupload.MultipartStream.MalformedStreamException

class MalformedStreamException extends IOException implements Serializable

serialVersionUID:
  6466926458059796677L

## Package org.apache.tomcat.util.http.fileupload.impl

### Exception Class org.apache.tomcat.util.http.fileupload.impl.FileCountLimitExceededException

class FileCountLimitExceededException extends FileUploadException implements Serializable

serialVersionUID:
  2408766352570556046L

#### Serialized Fields

##### limit

    long limit

The file count limit that was exceeded.

### Exception Class org.apache.tomcat.util.http.fileupload.impl.FileSizeLimitExceededException

class FileSizeLimitExceededException extends SizeException implements Serializable

serialVersionUID:
  8150776562029630058L

#### Serialized Fields

##### fieldName

    String fieldName

Field name of the item, which caused the exception.

##### fileName

    String fileName

File name of the item, which caused the exception.

### Exception Class org.apache.tomcat.util.http.fileupload.impl.FileUploadIOException

class FileUploadIOException extends IOException implements Serializable

serialVersionUID:
  -7047616958165584154L

#### Serialized Fields

##### cause

    FileUploadException cause

The exceptions cause; we overwrite the parent classes field, which is available since Java 1.4 only.

### Exception Class org.apache.tomcat.util.http.fileupload.impl.InvalidContentTypeException

class InvalidContentTypeException extends FileUploadException implements Serializable

serialVersionUID:
  -9073026332015646668L

### Exception Class org.apache.tomcat.util.http.fileupload.impl.IOFileUploadException

class IOFileUploadException extends FileUploadException implements Serializable

serialVersionUID:
  1749796615868477269L

#### Serialized Fields

##### cause

    IOException cause

The exceptions cause; we overwrite the parent classes field, which is available since Java 1.4 only.

### Exception Class org.apache.tomcat.util.http.fileupload.impl.SizeException

class SizeException extends FileUploadException implements Serializable

serialVersionUID:
  -8776225574705254126L

#### Serialized Fields

##### actual

    long actual

The actual size of the request.

##### permitted

    long permitted

The maximum permitted size of the request.

### Exception Class org.apache.tomcat.util.http.fileupload.impl.SizeLimitExceededException

class SizeLimitExceededException extends SizeException implements Serializable

serialVersionUID:
  -2474893167098052828L

## Package org.apache.tomcat.util.http.fileupload.util

### Class org.apache.tomcat.util.http.fileupload.util.FileItemHeadersImpl

class FileItemHeadersImpl extends Object implements Serializable

serialVersionUID:
  -4455695752627032559L

#### Serialized Fields

##### headerNameToValueListMap

    Map<String, List<String>> headerNameToValueListMap

Map of `String` keys to a `List` of `String` instances.

## Package org.apache.tomcat.util.modeler

### Class org.apache.tomcat.util.modeler.AttributeInfo

class AttributeInfo extends FeatureInfo implements Serializable

serialVersionUID:
  -2511626862303972143L

#### Serialized Fields

##### displayName

    String displayName

Human-readable display name for this attribute.

##### getMethod

    String getMethod

Name of the getter method for this attribute.

##### is

    boolean is

Whether this is a boolean attribute with an "is" getter.

##### readable

    boolean readable

Whether this attribute can be read by management applications.

##### setMethod

    String setMethod

Name of the setter method for this attribute.

##### writeable

    boolean writeable

Whether this attribute can be written by management applications.

### Class org.apache.tomcat.util.modeler.BaseAttributeFilter

class BaseAttributeFilter extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### names

    Set<String> names

The set of attribute names that are accepted by this filter. If this list is empty, all attribute names are accepted.

### Class org.apache.tomcat.util.modeler.FeatureInfo

class FeatureInfo extends Object implements Serializable

serialVersionUID:
  -911529176124712296L

#### Serialized Fields

##### description

    String description

Human-readable description of this feature.

##### info

    MBeanFeatureInfo info

The underlying JMX MBeanFeatureInfo object.

##### name

    String name

The name of this feature.

##### type

    String type

The fully qualified Java class name of this element.

### Class org.apache.tomcat.util.modeler.ManagedBean

class ManagedBean extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### attributes

    Map<String, AttributeInfo> attributes

The map of attribute descriptors by name.

##### className

    String className

The fully qualified name of the Java class of the MBean.

##### description

    String description

The human-readable description of this MBean.

##### domain

    String domain

The ObjectName domain in which this MBean should be registered.

##### group

    String group

The group to which this MBean belongs.

##### mBeanInfoLock

    ReadWriteLock mBeanInfoLock

Lock for thread-safe access to the MBeanInfo cache.

##### name

    String name

The name of this managed bean.

##### notifications

    NotificationInfo[] notifications

The collection of notifications for this MBean.

##### operations

    Map<String, OperationInfo> operations

The map of operation descriptors by key.

##### type

    String type

The fully qualified name of the Java class of the resource implementation class.

### Class org.apache.tomcat.util.modeler.NotificationInfo

class NotificationInfo extends FeatureInfo implements Serializable

serialVersionUID:
  -6319885418912650856L

#### Serialized Fields

##### notifTypes

    String[] notifTypes

Array of notification types.

##### notifTypesLock

    ReadWriteLock notifTypesLock

Lock for notification types access.

### Class org.apache.tomcat.util.modeler.OperationInfo

class OperationInfo extends FeatureInfo implements Serializable

serialVersionUID:
  4418342922072614875L

#### Serialized Fields

##### impact

    String impact

Impact of the operation.

##### parameters

    ParameterInfo[] parameters

Array of parameters.

##### parametersLock

    ReadWriteLock parametersLock

Lock for parameter access.

##### role

    String role

Role of the operation.

### Class org.apache.tomcat.util.modeler.ParameterInfo

class ParameterInfo extends FeatureInfo implements Serializable

serialVersionUID:
  2222796006787664020L

## Package org.apache.tomcat.util.net

### Class org.apache.tomcat.util.net.SSLHostConfig

class SSLHostConfig extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### caCertificateFile

    String caCertificateFile

The path to the CA certificate file.

##### caCertificatePath

    String caCertificatePath

The path to the CA certificate directory.

##### certificateRevocationListFile

    String certificateRevocationListFile

The path to the certificate revocation list file.

##### certificateRevocationListPath

    String certificateRevocationListPath

The path to the certificate revocation list directory.

##### certificates

    Set<SSLHostConfigCertificate> certificates

The set of certificate configurations.

##### certificateVerification

    SSLHostConfig.CertificateVerification certificateVerification

The client certificate verification mode.

##### certificateVerificationDepth

    int certificateVerificationDepth

The depth for certificate chain verification.

##### certificateVerificationDepthConfigured

    boolean certificateVerificationDepthConfigured

Whether the certificate verification depth was explicitly configured.

##### cipherList

    LinkedHashSet<Cipher> cipherList

The parsed cipher list for TLS 1.2 and below.

##### ciphers

    String ciphers

The cipher configuration for TLS 1.2 and below (OpenSSL format).

##### cipherSuiteList

    LinkedHashSet<Cipher> cipherSuiteList

The parsed cipher suite list for TLS 1.3.

##### cipherSuites

    String cipherSuites

The cipher suite configuration for TLS 1.3.

##### cipherSuitesFromCiphers

    String cipherSuitesFromCiphers

##### configType

    SSLHostConfig.Type configType

The detected configuration type (JSSE or OpenSSL).

##### defaultCertificate

    SSLHostConfigCertificate defaultCertificate

The default certificate configuration.

##### disableCompression

    boolean disableCompression

Whether TLS compression is disabled.

##### disableSessionTickets

    boolean disableSessionTickets

Whether TLS session tickets are disabled.

##### enabledCiphers

    String[] enabledCiphers

The ciphers enabled by the SSL engine.

##### enabledProtocols

    String[] enabledProtocols

The protocols enabled by the SSL engine.

##### explicitlyRequestedProtocols

    Set<String> explicitlyRequestedProtocols

The set of protocols explicitly requested by the user.

##### groupList

    LinkedHashSet<Group> groupList

The parsed group list.

##### groups

    String groups

The configured TLS named groups.

##### honorCipherOrder

    boolean honorCipherOrder

Whether to honor the server's cipher order preference.

##### hostName

    String hostName

The name of the virtual host.

##### insecureRenegotiation

    boolean insecureRenegotiation

Whether insecure renegotiation is allowed.

##### jsseCipherNames

    List<String> jsseCipherNames

The JSSE cipher names derived from the configuration.

##### keyManagerAlgorithm

    String keyManagerAlgorithm

The key manager algorithm.

##### ocspEnabled

    boolean ocspEnabled

Whether OCSP stapling is enabled.

##### ocspSoftFail

    boolean ocspSoftFail

Whether OCSP soft fail is enabled.

##### ocspTimeout

    int ocspTimeout

The OCSP request timeout in milliseconds.

##### ocspVerifyFlags

    int ocspVerifyFlags

The OCSP verification flags.

##### oname

    ObjectName oname

The JMX object name.

##### openSslConf

    OpenSSLConf openSslConf

The OpenSSL configuration.

##### protocols

    Set<String> protocols

The set of enabled SSL/TLS protocols.

##### revocationEnabled

    boolean revocationEnabled

Whether CRL/OCSP revocation checking is enabled.

##### sessionCacheSize

    int sessionCacheSize

The SSL session cache size.

##### sessionTimeout

    int sessionTimeout

The SSL session timeout in seconds.

##### sslProtocol

    String sslProtocol

The JSSE SSL protocol name.

##### tls13RenegotiationAvailable

    boolean tls13RenegotiationAvailable

Whether TLS 1.3 renegotiation is available.

##### trustConfigType

    SSLHostConfig.Type trustConfigType

The detected trust configuration type (JSSE or OpenSSL).

##### trustManagerClassName

    String trustManagerClassName

The trust manager class name.

##### truststoreAlgorithm

    String truststoreAlgorithm

The truststore algorithm.

##### truststoreFile

    String truststoreFile

The truststore file path.

##### truststorePassword

    String truststorePassword

The truststore password.

##### truststoreProvider

    String truststoreProvider

The truststore provider.

##### truststoreType

    String truststoreType

The truststore type.

### Class org.apache.tomcat.util.net.SSLHostConfigCertificate

class SSLHostConfigCertificate extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### certificateChainFile

    String certificateChainFile

The path to the certificate chain file.

##### certificateFile

    String certificateFile

The path to the certificate file.

##### certificateKeyAlias

    String certificateKeyAlias

The alias of the key entry in the keystore.

##### certificateKeyFile

    String certificateKeyFile

The path to the private key file.

##### certificateKeyPassword

    String certificateKeyPassword

The password for the certificate's private key.

##### certificateKeyPasswordFile

    String certificateKeyPasswordFile

The path to the file containing the certificate key password.

##### certificateKeystoreFile

    String certificateKeystoreFile

The path to the keystore file.

##### certificateKeystorePassword

    String certificateKeystorePassword

The password used to access the keystore.

##### certificateKeystorePasswordFile

    String certificateKeystorePasswordFile

The path to the file containing the keystore password.

##### certificateKeystoreProvider

    String certificateKeystoreProvider

The provider of the keystore.

##### certificateKeystoreType

    String certificateKeystoreType

The type of the keystore.

##### oname

    ObjectName oname

The JMX object name for this certificate.

##### sslHostConfig

    SSLHostConfig sslHostConfig

The parent SSL host configuration.

##### storeType

    org.apache.tomcat.util.net.SSLHostConfigCertificate.StoreType storeType

The type of certificate store (KEYSTORE or PEM).

##### type

    SSLHostConfigCertificate.Type type

The type of this certificate.

## Package org.apache.tomcat.util.net.openssl

### Class org.apache.tomcat.util.net.openssl.OpenSSLConf

class OpenSSLConf extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### commands

    List<OpenSSLConfCmd> commands

The list of OpenSSL configuration commands.

### Class org.apache.tomcat.util.net.openssl.OpenSSLConfCmd

class OpenSSLConfCmd extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### name

    String name

The command name.

##### value

    String value

The command value.

## Package org.apache.tomcat.util.threads

### Exception Class org.apache.tomcat.util.threads.StopPooledThreadException

class StopPooledThreadException extends RuntimeException implements Serializable

serialVersionUID:
  1L

### Class org.apache.tomcat.util.threads.TaskQueue

class TaskQueue extends LinkedBlockingQueue<Runnable> implements Serializable

serialVersionUID:
  1L

## Package org.apache.tomcat.websocket

### Exception Class org.apache.tomcat.websocket.AuthenticationException

class AuthenticationException extends Exception implements Serializable

serialVersionUID:
  5709887412240096441L

### Exception Class org.apache.tomcat.websocket.ReadBufferOverflowException

class ReadBufferOverflowException extends IOException implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### minBufferSize

    int minBufferSize

The minimum buffer size required.

### Exception Class org.apache.tomcat.websocket.WsIOException

class WsIOException extends IOException implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### closeReason

    CloseReason closeReason

The WebSocket close reason.

## Package org.apache.tomcat.websocket.server

### Class org.apache.tomcat.websocket.server.WsFilter

class WsFilter extends GenericFilter implements Serializable

serialVersionUID:
  1L

### Record Class org.apache.tomcat.websocket.server.WsHttpSessionBindingListener

class WsHttpSessionBindingListener extends Record implements Serializable

#### Serialized Fields

##### key

    String key

The field for the `key` record component.