Java Servlets 3.1

This feature enables support for HTTP Servlets written to the Java Servlet 3.1 specification. We can package servlets in Java EE specified WAR or EAR files. If servlet security is required, we should also configure an appSecurity feature. Without a security feature, any security constraints for the application are ignored.

Enable this feature

To enable the Java Servlets 3.1 feature, add the following element declaration inside the featureManager element in the server.xml file:

<feature>servlet-3.1</feature>

Developing a feature that depends on this feature

If we are developing a feature that depends on the Java Servlets 3.1 feature, include the following item in the Subsystem-Content header in the feature manifest file for the new feature:

com.ibm.websphere.appserver.servlet-3.1; type="osgi.subsystem.feature"

Features that enable this feature

• Java API for WebSocket 1.0

API packages provided by this feature

• com.ibm.websphere.servlet.container

• com.ibm.websphere.servlet.context

• com.ibm.websphere.servlet.error

• com.ibm.websphere.servlet.event

• com.ibm.websphere.servlet.session

• com.ibm.websphere.webcontainer

• com.ibm.wsspi.servlet.session

• javax.servlet

• javax.servlet.annotation

• javax.servlet.descriptor

• javax.servlet.http

• javax.servlet.resources

SPI packages provided by this feature

• com.ibm.websphere.servlet.filter

• com.ibm.websphere.servlet.response

• com.ibm.ws.webcontainer.extension

• com.ibm.wsspi.webcontainer

• com.ibm.wsspi.webcontainer.collaborator

• com.ibm.wsspi.webcontainer.extension

• com.ibm.wsspi.webcontainer.filter

• com.ibm.wsspi.webcontainer.metadata

• com.ibm.wsspi.webcontainer.osgi.extension

• com.ibm.wsspi.webcontainer.servlet

• com.ibm.wsspi.webcontainer.webapp

Feature configuration elements

We can use the following elements in the server.xml file to configure the Java Servlets 3.1 feature:

• application

  • application-bnd

    • security-role

      • group

      • run-as

      • special-subject

      • user

  • classloader

    • commonLibrary

      • file

      • fileset

      • folder

    • privateLibrary

      • file

      • fileset

      • folder

  • resourceAdapter

• applicationMonitor

• channelfw

• classloading

• enterpriseApplication

  • application-bnd

    • security-role

      • group

      • run-as

      • special-subject

      • user

  • classloader

    • commonLibrary

      • file

      • fileset

      • folder

    • privateLibrary

      • file

      • fileset

      • folder

  • resourceAdapter

• httpAccessLogging

• httpDispatcher

  • trustedHeaderOrigin

• httpEncoding

• httpEndpoint

  • accessLogging

  • httpOptions

  • sslOptions

  • tcpOptions

• httpOptions

• httpProxyRedirect

• httpSession

• library

  • file

  • fileset

  • folder

• mimeTypes

  • type

• pluginConfiguration

  • httpEndpoint

    • accessLogging

    • httpOptions

    • sslOptions

    • tcpOptions

• tcpOptions

• virtualHost

  • allowFromEndpoint

    • accessLogging

    • httpOptions

    • sslOptions

    • tcpOptions

  • hostAlias

• webApplication

  • application-bnd

    • security-role

      • group

      • run-as

      • special-subject

      • user

  • classloader

    • commonLibrary

      • file

      • fileset

      • folder

    • privateLibrary

      • file

      • fileset

      • folder

• webContainer

application

Defines the properties of an application.

Attribute name	Data type	Default value	Description
autoStart	boolean	true	Indicates whether or not the server should start the application automatically when the server starts.
context-root	string		Context root of an application.
id	string		A unique configuration ID.
location	A file, directory or url.		Location of an application expressed as an absolute path or a path relative to the server-level apps directory.
name	string		Name of an application.
suppressUncoveredHttpMethodWarning	boolean	false	Option to suppress uncovered HTTP method warning message during application deployment.
type	string		Type of application archive.

application > application-bnd

Description: Binds general deployment information included in the application to specific resources.

Required: false

Data type:

Attribute name	Data type	Default value	Description
version	string		Version of the application bindings specification.

application > application-bnd > security-role

Description: A role that is mapped to users and groups in a domain user registry.

Required: false

Data type:

Attribute name	Data type	Default value	Description
name	string		Name of a security role.

application > application-bnd > security-role > group

Description: A group possessing a security role.

Required: false

Data type:

Attribute name	Data type	Default value	Description
access-id	string		Group access ID
name	string		Name of a group possessing a security role.

application > application-bnd > security-role > run-as

Description: ID and password of a user required to access a bean from another bean.

Required: false

Data type:

Attribute name	Data type	Default value	Description
password	Reversably encoded password (string)		Password of a user required to access a bean from another bean. Stored in clear text or encoded form. To encode the password, use the securityUtility tool with the encode option.
userid	string		ID of a user required to access a bean from another bean.

application > application-bnd > security-role > special-subject

Description: Name of a special-subject possessing a security role.

Required: false

Data type:

Attribute name	Data type	Default value	Description
type	EVERYONE ALL_AUTHENTICATED_USERS		One of the following special subject types: ALL_AUTHENTICATED_USERS, EVERYONE. EVERYONE Everyone ALL_AUTHENTICATED_USERS All authenticated users

application > application-bnd > security-role > user

Description: A user possessing a security role.

Required: false

Data type:

Attribute name	Data type	Default value	Description
access-id	string		A user access ID in the general form user:realmName/userUniqueId. A value will be generated if one is not specified.
name	string		Name of a user possessing a security role.

application > classloader

Description: Defines the settings for an application classloader.

Required: false

Data type:

Attribute name	Data type	Default value	Description
apiTypeVisibility	string	spec,ibm-api,api	The types of API package this class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party.
classProviderRef	List of references to top level resourceAdapter elements (comma-separated string).		List of class provider references. When searching for classes or resources, this class loader will delegate to the specified class providers after searching its own class path.
commonLibraryRef	List of references to top level library elements (comma-separated string).		List of library references. Library class instances are shared with other classloaders.
delegation	parentFirst parentLast	parentFirst	Controls whether parent classloader is used before or after this classloader. If parent first is selected then delegate to immediate parent before searching the classpath. If parent last is selected then search the classpath before delegating to the immediate parent. parentFirst Parent first parentLast Parent last
privateLibraryRef	List of references to top level library elements (comma-separated string).		List of library references. Library class instances are unique to this classloader, independent of class instances from other classloaders.

application > classloader > commonLibrary

Description: List of library references. Library class instances are shared with other classloaders.

Required: false

Data type:

Attribute name	Data type	Default value	Description
apiTypeVisibility	string	spec,ibm-api,api	The types of API package this library's class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party.
description	string		Description of shared library for administrators
filesetRef	List of references to top level fileset elements (comma-separated string).		Id of referenced Fileset
name	string		Name of shared library for administrators

application > classloader > commonLibrary > file

Description: Id of referenced File

Required: false

Data type:

Attribute name	Data type	Default value	Description
name	Path to a file		Fully qualified filename

application > classloader > commonLibrary > fileset

Description: Id of referenced Fileset

Required: false

Data type:

Attribute name	Data type	Default value	Description
caseSensitive	boolean	true	Boolean to indicate whether or not the search should be case sensitive (default: true).
dir	Path to a directory	${server.config.dir}	The base directory to search for files.
excludes	string		The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
includes	string	*	The comma or space separated list of file name patterns to include in the search results (default: *).
scanInterval	A period of time with millisecond precision	0	Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

application > classloader > commonLibrary > folder

Description: Id of referenced folder

Required: false

Data type:

Attribute name	Data type	Default value	Description
dir	Path to a directory		Directory or folder to be included in the library classpath for locating resource files

application > classloader > privateLibrary

Description: List of library references. Library class instances are unique to this classloader, independent of class instances from other classloaders.

Required: false

Data type:

Attribute name	Data type	Default value	Description
apiTypeVisibility	string	spec,ibm-api,api	The types of API package this library's class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party.
description	string		Description of shared library for administrators
filesetRef	List of references to top level fileset elements (comma-separated string).		Id of referenced Fileset
name	string		Name of shared library for administrators

application > classloader > privateLibrary > file

Description: Id of referenced File

Required: false

Data type:

Attribute name	Data type	Default value	Description
name	Path to a file		Fully qualified filename

application > classloader > privateLibrary > fileset

Description: Id of referenced Fileset

Required: false

Data type:

Attribute name	Data type	Default value	Description
caseSensitive	boolean	true	Boolean to indicate whether or not the search should be case sensitive (default: true).
dir	Path to a directory	${server.config.dir}	The base directory to search for files.
excludes	string		The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
includes	string	*	The comma or space separated list of file name patterns to include in the search results (default: *).
scanInterval	A period of time with millisecond precision	0	Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

application > classloader > privateLibrary > folder

Description: Id of referenced folder

Required: false

Data type:

Attribute name	Data type	Default value	Description
dir	Path to a directory		Directory or folder to be included in the library classpath for locating resource files

application > resourceAdapter

Description: Specifies configuration for a resource adapter that is embedded in an application.

Required: false

Data type:

Attribute name	Data type	Default value	Description
alias	string	${id}	Overrides the default identifier for the resource adapter. The identifier is used in the name of the resource adapter's configuration properties element, which in turn is used in determining the name of configuration properties elements for any resources provided by the resource adapter. The resource adapter's configuration properties element name has the format, properties.<APP_NAME>.<ALIAS>, where <APP_NAME> is the name of the application and <ALIAS> is the configured alias. If unspecified, the alias defaults to the module name of the resource adapter.
autoStart	boolean		Configures whether a resource adapter starts automatically upon deployment of the resource adapter or lazily upon injection or lookup of a resource.
contextServiceRef	A reference to top level contextService element (string).		Configures how context is captured and propagated to threads.
id	string		Identifies the name of the embedded resource adapter module to which this configuration applies.
schema.properties	schemaPropertiesType		Collection of properties for the interceptor.

applicationMonitor

Defines how the server responds to application additions, updates, and deletions.

Attribute name	Data type	Default value	Description
dropins	Path to a directory	dropins	Location of the application drop-in directory expressed as an absolute path or a path relative to the server directory.
dropinsEnabled	boolean	true	Monitor the drop-in directory for application additions, updates, and deletions.
pollingRate	A period of time with millisecond precision	500ms	Rate at which the server checks for application additions, updates, and deletions. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
updateTrigger	mbean polled disabled	polled	Application update method or trigger. mbean Server will only update applications when prompted by an MBean called by an external program such as an integrated development environment or a management application. polled Server will scan for application changes at the polling interval and update any applications that have detectable changes. disabled Disables all update monitoring. Application changes will not be applied while the server is running.

channelfw

Defines channel and chain management settings.

Attribute name	Data type	Default value	Description
chainQuiesceTimeout	A period of time with millisecond precision	30s	Default amount of time to wait while quiescing chains. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
chainStartRetryAttempts	int Minimum: 0	60	Number of retry attempts to make per chain.
chainStartRetryInterval	A period of time with millisecond precision	5s	Time interval between start retries. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
warningWaitTime	A period of time with millisecond precision	10s	Amount of time to wait before notifying of a missing factory configuration. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

classloading

Global classloading

Attribute name	Data type	Default value	Description
useJarUrls	boolean	false	Whether to use jar: or wsjar: URLs for referencing files in archives

enterpriseApplication

Defines the properties of an enterprise application.

Attribute name	Data type	Default value	Description
autoStart	boolean	true	Indicates whether or not the server should start the application automatically when the server starts.
id	string		A unique configuration ID.
location	A file, directory or url.		Location of an application expressed as an absolute path or a path relative to the server-level apps directory.
name	string		Name of an application.
suppressUncoveredHttpMethodWarning	boolean	false	Option to suppress uncovered HTTP method warning message during application deployment.

enterpriseApplication > application-bnd

Description: Binds general deployment information included in the application to specific resources.

Required: false

Data type:

Attribute name	Data type	Default value	Description
version	string		Version of the application bindings specification.

enterpriseApplication > application-bnd > security-role

Description: A role that is mapped to users and groups in a domain user registry.

Required: false

Data type:

Attribute name	Data type	Default value	Description
name	string		Name of a security role.

enterpriseApplication > application-bnd > security-role > group

Description: A group possessing a security role.

Required: false

Data type:

Attribute name	Data type	Default value	Description
access-id	string		Group access ID
name	string		Name of a group possessing a security role.

enterpriseApplication > application-bnd > security-role > run-as

Description: ID and password of a user required to access a bean from another bean.

Required: false

Data type:

Attribute name	Data type	Default value	Description
password	Reversably encoded password (string)		Password of a user required to access a bean from another bean. Stored in clear text or encoded form. To encode the password, use the securityUtility tool with the encode option.
userid	string		ID of a user required to access a bean from another bean.

enterpriseApplication > application-bnd > security-role > special-subject

Description: Name of a special-subject possessing a security role.

Required: false

Data type:

Attribute name	Data type	Default value	Description
type	EVERYONE ALL_AUTHENTICATED_USERS		One of the following special subject types: ALL_AUTHENTICATED_USERS, EVERYONE. EVERYONE Everyone ALL_AUTHENTICATED_USERS All authenticated users

enterpriseApplication > application-bnd > security-role > user

Description: A user possessing a security role.

Required: false

Data type:

Attribute name	Data type	Default value	Description
access-id	string		A user access ID in the general form user:realmName/userUniqueId. A value will be generated if one is not specified.
name	string		Name of a user possessing a security role.

enterpriseApplication > classloader

Description: Defines the settings for an application classloader.

Required: false

Data type:

Attribute name	Data type	Default value	Description
apiTypeVisibility	string	spec,ibm-api,api	The types of API package this class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party.
classProviderRef	List of references to top level resourceAdapter elements (comma-separated string).		List of class provider references. When searching for classes or resources, this class loader will delegate to the specified class providers after searching its own class path.
commonLibraryRef	List of references to top level library elements (comma-separated string).		List of library references. Library class instances are shared with other classloaders.
delegation	parentFirst parentLast	parentFirst	Controls whether parent classloader is used before or after this classloader. If parent first is selected then delegate to immediate parent before searching the classpath. If parent last is selected then search the classpath before delegating to the immediate parent. parentFirst Parent first parentLast Parent last
privateLibraryRef	List of references to top level library elements (comma-separated string).		List of library references. Library class instances are unique to this classloader, independent of class instances from other classloaders.

enterpriseApplication > classloader > commonLibrary

Description: List of library references. Library class instances are shared with other classloaders.

Required: false

Data type:

Attribute name	Data type	Default value	Description
apiTypeVisibility	string	spec,ibm-api,api	The types of API package this library's class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party.
description	string		Description of shared library for administrators
filesetRef	List of references to top level fileset elements (comma-separated string).		Id of referenced Fileset
name	string		Name of shared library for administrators

enterpriseApplication > classloader > commonLibrary > file

Description: Id of referenced File

Required: false

Data type:

Attribute name	Data type	Default value	Description
name	Path to a file		Fully qualified filename

enterpriseApplication > classloader > commonLibrary > fileset

Description: Id of referenced Fileset

Required: false

Data type:

Attribute name	Data type	Default value	Description
caseSensitive	boolean	true	Boolean to indicate whether or not the search should be case sensitive (default: true).
dir	Path to a directory	${server.config.dir}	The base directory to search for files.
excludes	string		The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
includes	string	*	The comma or space separated list of file name patterns to include in the search results (default: *).
scanInterval	A period of time with millisecond precision	0	Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

enterpriseApplication > classloader > commonLibrary > folder

Description: Id of referenced folder

Required: false

Data type:

Attribute name	Data type	Default value	Description
dir	Path to a directory		Directory or folder to be included in the library classpath for locating resource files

enterpriseApplication > classloader > privateLibrary

Description: List of library references. Library class instances are unique to this classloader, independent of class instances from other classloaders.

Required: false

Data type:

Attribute name	Data type	Default value	Description
apiTypeVisibility	string	spec,ibm-api,api	The types of API package this library's class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party.
description	string		Description of shared library for administrators
filesetRef	List of references to top level fileset elements (comma-separated string).		Id of referenced Fileset
name	string		Name of shared library for administrators

enterpriseApplication > classloader > privateLibrary > file

Description: Id of referenced File

Required: false

Data type:

Attribute name	Data type	Default value	Description
name	Path to a file		Fully qualified filename

enterpriseApplication > classloader > privateLibrary > fileset

Description: Id of referenced Fileset

Required: false

Data type:

Attribute name	Data type	Default value	Description
caseSensitive	boolean	true	Boolean to indicate whether or not the search should be case sensitive (default: true).
dir	Path to a directory	${server.config.dir}	The base directory to search for files.
excludes	string		The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
includes	string	*	The comma or space separated list of file name patterns to include in the search results (default: *).
scanInterval	A period of time with millisecond precision	0	Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

enterpriseApplication > classloader > privateLibrary > folder

Description: Id of referenced folder

Required: false

Data type:

Attribute name	Data type	Default value	Description
dir	Path to a directory		Directory or folder to be included in the library classpath for locating resource files

enterpriseApplication > resourceAdapter

Description: Specifies configuration for a resource adapter that is embedded in an application.

Required: false

Data type:

Attribute name	Data type	Default value	Description
alias	string	${id}	Overrides the default identifier for the resource adapter. The identifier is used in the name of the resource adapter's configuration properties element, which in turn is used in determining the name of configuration properties elements for any resources provided by the resource adapter. The resource adapter's configuration properties element name has the format, properties.<APP_NAME>.<ALIAS>, where <APP_NAME> is the name of the application and <ALIAS> is the configured alias. If unspecified, the alias defaults to the module name of the resource adapter.
autoStart	boolean		Configures whether a resource adapter starts automatically upon deployment of the resource adapter or lazily upon injection or lookup of a resource.
contextServiceRef	A reference to top level contextService element (string).		Configures how context is captured and propagated to threads.
id	string		Identifies the name of the embedded resource adapter module to which this configuration applies.
schema.properties	schemaPropertiesType		Collection of properties for the interceptor.

httpAccessLogging

HTTP access logs contain a record of all inbound HTTP client requests.

Attribute name	Data type	Default value	Description
enabled	boolean	true	Enable access logging.
filePath	Path to a file	${server.output.dir}/logs/http_access.log	Directory path and name of the access log file. Standard variable substitutions, such as ${server.output.dir}, can be used when specifying the directory path.
id	string		A unique configuration ID.
logFormat	string	%h %u %{t}W "%r" %s %b	Log format used when logging client access information.
maxFileSize	int Minimum: 0	20	Maximum size of a log file, in megabytes, before being rolled over; a value of 0 means no limit.
maxFiles	int Minimum: 0	2	Maximum number of log files that will be kept, before the oldest file is removed; a value of 0 means no limit.

httpDispatcher

HTTP Dispatcher configuration.

Attribute name	Data type	Default value	Description
appOrContextRootMissingMessage	string		Message to return to the client when the application in the requested URI can not be found.
enableWelcomePage	boolean	true	Enables the default Liberty profile welcome page when no application is bound to a context root of "/". The default value is true.

httpDispatcher > trustedHeaderOrigin

Description: Private headers are used by the web server plug-in to provide information about the original request. These headers take precedence over the http Host header, and are used to select a virtual host to service a request. The default value is '*', which will trust incoming private headers from any source. Specify 'none' to disable private headers and rely only on the http Host header, or specify a list of IP addresses to restrict private header processing to specific trusted sources.

Required: false

Data type: string

httpEncoding

HTTP transport encoding settings

Attribute name	Data type	Default value	Description
converter.Big5	string	Cp950	Big5 Chinese converter
converter.EUC-JP	string	Cp33722C	EUC Japanese converter (EUC-JP)
converter.EUC-KR	string	Cp970	EUC Korean converter (EUC-KR)
converter.EUC-TW	string	Cp964	EUC Chinese (Taiwan) converter (EUC-TW)
converter.EUC_KR	string	Cp970	EUC Korean converter (EUC_KR)
converter.GB2312	string	EUC_CN	GB2312 Chinese converter
converter.ISO-2022-KR	string	ISO2022KR	ISO-2022 Korean converter (ISO-2022-KR)
converter.Shift_JIS	string	Cp943C	Shift_JIS Japanese converter
encoding.ar	string	ISO-8859-6	Arabic language encoding (ar)
encoding.be	string	ISO-8859-5	Belarusian language encoding (be)
encoding.bg	string	ISO-8859-5	Bulgarian language encoding (bg)
encoding.bn	string	UTF-8	Bengali language encoding (bn)
encoding.ca	string	ISO-8859-1	Catalan language encoding (ca)
encoding.cs	string	ISO-8859-2	Czech language encoding (cs)
encoding.da	string	ISO-8859-1	Danish language encoding (da)
encoding.de	string	ISO-8859-1	German language encoding (de)
encoding.el	string	ISO-8859-7	Greek language encoding (el)
encoding.en	string	ISO-8859-1	English language encoding (en)
encoding.es	string	ISO-8859-1	Spanish language encoding (es)
encoding.et	string	ISO-8859-4	Estonian language encoding (et)
encoding.eu	string	ISO-8859-1	Basque language encoding (eu)
encoding.fa	string	ISO-8859-6	Persian language encoding (fa)
encoding.fi	string	ISO-8859-1	Finnish language encoding (fi)
encoding.fo	string	ISO-8859-2	Faroese language encoding (fo)
encoding.fr	string	ISO-8859-1	French language encoding (fr)
encoding.he	string	ISO-8859-8	Hebrew language encoding (he)
encoding.hi	string	UTF-8	Hindi language encoding (hi)
encoding.hr	string	ISO-8859-2	Croatian language encoding (hr)
encoding.hu	string	ISO-8859-2	Hungarian language encoding (hu)
encoding.hy	string	UTF-8	Armenian language encoding (hy)
encoding.is	string	ISO-8859-1	Icelandic language encoding (is)
encoding.it	string	ISO-8859-1	Italian language encoding (it)
encoding.iw	string	ISO-8859-8	Hebrew language encoding (iw)
encoding.ja	string	Shift_JIS	Japanese language encoding (ja)
encoding.ji	string	ISO-8859-8	Yiddish language encoding (ji)
encoding.ka	string	UTF-8	Georgian language encoding (ka)
encoding.ko	string	EUC-KR	Korean language encoding (ko)
encoding.lt	string	ISO-8859-2	Lithuanian language encoding (lt)
encoding.lv	string	ISO-8859-4	Latvian language encoding (lv)
encoding.mk	string	ISO-8859-5	Macedonian language encoding (mk)
encoding.mr	string	UTF-8	Marathi language encoding (mr)
encoding.ms	string	ISO-8859-6	Malay language encoding (ms)
encoding.mt	string	ISO-8859-3	Maltese language encoding (mt)
encoding.nl	string	ISO-8859-1	Dutch language encoding (nl)
encoding.no	string	ISO-8859-1	Norwegian language encoding (no)
encoding.pl	string	ISO-8859-2	Polish language encoding (pl)
encoding.pt	string	ISO-8859-1	Portuguese language encoding (pt)
encoding.ro	string	ISO-8859-2	Romanian language encoding (ro)
encoding.ru	string	ISO-8859-5	Russian language encoding (ru)
encoding.sa	string	UTF-8	Sanskrit language encoding (sa)
encoding.sh	string	ISO-8859-2	Serbo-Croatian language encoding (sh)
encoding.sk	string	ISO-8859-2	Slovak language encoding (sk)
encoding.sl	string	ISO-8859-2	Slovenian language encoding (sl)
encoding.sq	string	ISO-8859-2	Albanian language encoding (sq)
encoding.sr	string	ISO-8859-5	Serbian language encoding (sr)
encoding.sv	string	ISO-8859-1	Swedish language encoding (sv)
encoding.ta	string	UTF-8	Tamil language encoding (ta)
encoding.th	string	windows-874	Thai language encoding (th)
encoding.tr	string	ISO-8859-9	Turkish language encoding (tr)
encoding.uk	string	ISO-8859-5	Ukrainian language encoding (uk)
encoding.vi	string	windows-1258	Vietnamese language encoding (vi)
encoding.yi	string	ISO-8859-8	Yiddish language encoding (yi)
encoding.zh	string	GB2312	Chinese language encoding (zh)
encoding.zh_TW	string	Big5	Chinese language encoding (zh_TW)

httpEndpoint

Configuration properties for an HTTP endpoint.

Attribute name	Data type	Default value	Description
accessLoggingRef	A reference to top level httpAccessLogging element (string).		HTTP access logging configuration for the endpoint.
enabled	boolean	true	Toggle the availability of an endpoint. When true, this endpoint will be activated by the dispatcher to handle HTTP requests.
host	string	localhost	IP address, DNS host name with domain name suffix, or just the DNS host name, used by a client to request a resource. Use '*' for available network interfaces.
httpOptionsRef	A reference to top level httpOptions element (string).	defaultHttpOptions	HTTP protocol options for the endpoint.
httpPort	int Minimum: -1 Maximum: 65535		The port used for client HTTP requests. Use -1 to disable this port.
httpsPort	int Minimum: -1 Maximum: 65535		The port used for client HTTP requests secured with SSL (https). Use -1 to disable this port.
id	string		A unique configuration ID.
onError	IGNORE FAIL WARN	WARN	Action to take after a failure to start an endpoint. IGNORE Server will not issue any warning and error messages when it incurs a configuration error. FAIL Server will issue a warning or error message on the first error occurrence and then stop the server. WARN Server will issue warning and error messages when it incurs a configuration error.
sslOptionsRef	A reference to top level sslOptions element (string).		SSL protocol options for the endpoint.
tcpOptionsRef	A reference to top level tcpOptions element (string).	defaultTCPOptions	TCP protocol options for the endpoint.

httpEndpoint > accessLogging

Description: HTTP access logging configuration for the endpoint.

Required: false

Data type:

Attribute name	Data type	Default value	Description
enabled	boolean	true	Enable access logging.
filePath	Path to a file	${server.output.dir}/logs/http_access.log	Directory path and name of the access log file. Standard variable substitutions, such as ${server.output.dir}, can be used when specifying the directory path.
logFormat	string	%h %u %{t}W "%r" %s %b	Log format used when logging client access information.
maxFileSize	int Minimum: 0	20	Maximum size of a log file, in megabytes, before being rolled over; a value of 0 means no limit.
maxFiles	int Minimum: 0	2	Maximum number of log files that will be kept, before the oldest file is removed; a value of 0 means no limit.

httpEndpoint > httpOptions

Description: HTTP protocol options for the endpoint.

Required: false

Data type:

Attribute name	Data type	Default value	Description
keepAliveEnabled	boolean	true	Enables persistent connections (HTTP keepalive). If true, connections are kept alive for reuse by multiple sequential requests and responses. If false, connections are closed after the response is sent.
maxKeepAliveRequests	int Minimum: -1	100	Maximum number of persistent requests allowed on a single HTTP connection if persistent connections are enabled. A value of -1 means unlimited.
persistTimeout	A period of time with second precision	30s	Amount of time that a socket will be allowed to remain idle between requests. This setting only applies if persistent connections are enabled. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
readTimeout	A period of time with second precision	60s	Amount of time to wait for a read request to complete on a socket after the first read occurs. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
removeServerHeader	boolean	false	Removes server implementation information from HTTP headers and also disables the default Liberty profile welcome page.
writeTimeout	A period of time with second precision	60s	Amount of time to wait on a socket for each portion of the response data to be transmitted. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

httpEndpoint > sslOptions

Description: SSL protocol options for the endpoint.

Required: false

Data type:

Attribute name	Data type	Default value	Description
sessionTimeout	A period of time with second precision	1d	Amount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
sslRef	string		The default SSL configuration repertoire. The default value is defaultSSLSettings.
suppressHandshakeErrors	boolean	false	Disable logging of SSL handshake errors. SSL handshake errors can occur during normal operation, however these messages can be useful when SSL is behaving unexpectedly.

httpEndpoint > tcpOptions

Description: TCP protocol options for the endpoint.

Required: false

Data type:

Attribute name	Data type	Default value	Description
inactivityTimeout	A period of time with millisecond precision	60s	Amount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
soReuseAddr	boolean	true	Enables immediate rebind to a port with no active listener.

httpOptions

HTTP protocol configuration.

Attribute name	Data type	Default value	Description
id	string		A unique configuration ID.
keepAliveEnabled	boolean	true	Enables persistent connections (HTTP keepalive). If true, connections are kept alive for reuse by multiple sequential requests and responses. If false, connections are closed after the response is sent.
maxKeepAliveRequests	int Minimum: -1	100	Maximum number of persistent requests allowed on a single HTTP connection if persistent connections are enabled. A value of -1 means unlimited.
persistTimeout	A period of time with second precision	30s	Amount of time that a socket will be allowed to remain idle between requests. This setting only applies if persistent connections are enabled. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
readTimeout	A period of time with second precision	60s	Amount of time to wait for a read request to complete on a socket after the first read occurs. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
removeServerHeader	boolean	false	Removes server implementation information from HTTP headers and also disables the default Liberty profile welcome page.
writeTimeout	A period of time with second precision	60s	Amount of time to wait on a socket for each portion of the response data to be transmitted. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

httpProxyRedirect

Configures port redirection. HTTP Proxy Redirect is used when redirecting HTTP requests from a non-secure port (for example, 80) to an SSL-enabled secured port (for example, 443).

Attribute name	Data type	Default value	Description
enabled	boolean	true	This attribute determines whether or not the server should redirect ports specified in this configuration element. The default is true.
host	string	*	The host name used for this proxy redirect. The server redirects HTTP requests only if the incoming request specifies a host name that matches this value. The default is * (all hosts).
httpPort	int Minimum: 1 Maximum: 65535		The (non-secure) port to redirect from. Incoming HTTP requests on this port are redirected to the specified HTTPS port.
httpsPort	int Minimum: 1 Maximum: 65535		The (secure) port to redirect to. Incoming HTTP requests that use the HTTP port are redirected to this port.
id	string		A unique configuration ID.

httpSession

Configuration for HTTP session management.

Attribute name	Data type	Default value	Description
allowOverflow	boolean	true	Allows the number of sessions in memory to exceed the value of the Max in-memory session count property.
alwaysEncodeUrl	boolean	false	The Servlet 2.5 specification specifies to not encode the URL on a response.encodeURL call if it is not necessary. To support backward compatibility when URL encoding is enabled, set this property to true to call the encodeURL method. The URL is always encoded, even if the browser supports cookies.
cloneId	string		The clone identifier of the cluster member. Within a cluster, this identifier must be unique to maintain session affinity. When set, this name overwrites the default name generated by the server.
cloneSeparator	string	:	The single character used to separate the session identifier from the clone identifier in session cookies. The default value should usually be used. On some Wireless Application Protocol (WAP) devices, a colon (:) is not allowed, so a plus sign (+) should be used instead. Different values should rarely be used. We should understand the clone character requirements of other products running on the system before using this property to change the clone separator character. The fact that any character can be specified as the value for this property does not imply that the character we specify will function correctly. This fact also does not imply that IBM is responsible for fixing any problem that might arise from using an alternative character.
cookieDomain	string		Domain field of a session tracking cookie.
cookieHttpOnly	boolean	true	That session cookies include the HttpOnly field. Browsers that support the HttpOnly field do not enable cookies to be accessed by client-side scripts. Using the HttpOnly field will help prevent cross-site scripting attacks.
cookieMaxAge	A period of time with second precision	-1	Maximum amount of time that a cookie can reside on the client browser. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
cookieName	string	JSESSIONID	A unique name for a session management cookie.
cookiePath	string	/	A cookie is sent to the URL designated in the path.
cookieSecure	boolean	false	That the session cookies include the secure field.
cookiesEnabled	boolean	true	That session tracking uses cookies to carry session identifiers.
debugCrossover	boolean	false	Enable this option to perform additional checks to verify that only the session associated with the request is accessed or referenced, and log messages if any discrepancies are detected. Disable this option to skip the additional checks.
forceInvalidationMultiple	int	3	If the requests normally are not bound by a response time limit, specify 0 to indicate that the session manager should wait indefinitely until a request is complete before attempting to invalidate the session. Otherwise, set this property to a positive integer to delay the invalidation of active sessions. Active timed out sessions will not be invalidated by the first invalidation interval pass, but will be invalidated by the interval pass based on this value. For example, a value of 2 would invalidate an active session on the second invalidation interval pass after the session timeout has expired.
idLength	int	23	Length of the session identifier.
idReuse	boolean	false	In a multi-JVM environment that is not configured for session persistence, setting this property to "true" enables the session manager to use the same session information for all of a user's requests even if the web applications that are handling these requests are governed by different JVMs. The default value for this property is false. Set this property to true to enable the session manager to use the session identifier sent from a browser to preserve session data across web applications running in an environment that is not configured for session persistence.
invalidateOnUnauthorizedSessionRequestException	boolean	false	Set this property to true if, in response to an unauthorized request, we want the session manager to invalidate a session instead of issuing an UnauthorizedSessionRequestException. When a session is invalidated, the requester can create a new session, but does not have access to any of the previously saved session data. This allows a single user to continue processing requests to other applications after a logout while still protecting session data.
invalidationTimeout	A period of time with second precision	30m	Amount of time a session can go unused before it is no longer valid. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
maxInMemorySessionCount	int	1000	Maximum number of sessions to maintain in memory for each web module.
noAdditionalInfo	boolean	false	Forces removal of information that is not needed in session identifiers.
protocolSwitchRewritingEnabled	boolean	false	Adds the session identifier to a URL when the URL requires a switch from HTTP to HTTPS or from HTTPS to HTTP.
reaperPollInterval	A period of time with second precision	-1	The wake-up interval, in seconds, for the process that removes invalid sessions. The minimum value is 30 seconds. If a value less than the minimum is entered, an appropriate value is automatically determined and used. This value overrides the default installation value, which is between 30 and 360 seconds, based off the session timeout value. Because the default session timeout is 30 minutes, the reaper interval is usually between 2 and 3 minutes. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
rewriteId	string	jsessionid	Use this property to change the key used with URL rewriting.
securityIntegrationEnabled	boolean	true	Enables security integration, which causes the session management facility to associate the identity of users with their HTTP sessions.
securityUserIgnoreCase	boolean	false	Indicates that the session security identity and the client security identity should be considered a match even if their cases are different. For example, when this property is set to true, the session security identity USER1 matches the client security identities User1 and user1.
sslTrackingEnabled	boolean	false	That session tracking uses SSL information as a session identifier.
urlRewritingEnabled	boolean	false	That the session management facility uses rewritten URLs to carry the session identifiers.
useContextRootAsCookiePath	boolean	false	That the cookie path equals the context root of the web module instead of /

library

Shared Library

Attribute name	Data type	Default value	Description
apiTypeVisibility	string	spec,ibm-api,api	The types of API package this library's class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party.
description	string		Description of shared library for administrators
filesetRef	List of references to top level fileset elements (comma-separated string).		Id of referenced Fileset
id	string		A unique configuration ID.
name	string		Name of shared library for administrators

library > file

Description: Id of referenced File

Required: false

Data type:

Attribute name	Data type	Default value	Description
name	Path to a file		Fully qualified filename

library > fileset

Description: Id of referenced Fileset

Required: false

Data type:

Attribute name	Data type	Default value	Description
caseSensitive	boolean	true	Boolean to indicate whether or not the search should be case sensitive (default: true).
dir	Path to a directory	${server.config.dir}	The base directory to search for files.
excludes	string		The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
includes	string	*	The comma or space separated list of file name patterns to include in the search results (default: *).
scanInterval	A period of time with millisecond precision	0	Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

library > folder

Description: Id of referenced folder

Required: false

Data type:

Attribute name	Data type	Default value	Description
dir	Path to a directory		Directory or folder to be included in the library classpath for locating resource files

mimeTypes

Definition of mime types shared by all http virtual hosts

mimeTypes > type

Description: Definition of mime type as id=value. Use the extension as the id, and the associated type as the value.

Required: false

Data type: string

pluginConfiguration

Generate plugin configuration

Attribute name	Data type	Default value	Description
connectTimeout	A period of time with second precision	5s	Identifies the maximum amount of time that the application server should maintain a connection with the web server. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
extendedHandshake	boolean	false	If true, the web server plugin uses an extended handshake to determine if the application server is running.
httpEndpointRef	A reference to top level httpEndpoint element (string).	defaultHttpEndpoint	Specify the identifier of the http endpoint to include in the generated plugin-cfg.xml file. The endpoint defines the server in the cluster. The default value is 'defaultHttpEndpoint'.
ipv6Preferred	boolean	false	IPv6 is preferred
pluginInstallRoot	string	.	Web container plugin installation location in file system
serverIOTimeout	A period of time with second precision	900s	Identifies the maximum amount of time that the web server plugin waits to send a request or receive a response from the application server. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
sslCertlabel	string	LibertyCert	SSL cert label
sslKeyringLocation	string	keyring.kdb	Location of SSL keyring
sslStashfileLocation	string	keyring.sth	Location of SSL stashfile
waitForContinue	boolean	false	If false (the default value), the web server plugin sends the "Expect: 100-continue" header with HTTP requests that have a message body. When set to true, the web server plugin sends the "Expect: 100-continue" header with every HTTP request. Consider setting this value to true if we have a firewall between the web server and the application server, and are sensitive to requests retries with no request body.
webserverPort	int Minimum: -1 Maximum: 65535	80	Web server HTTP port
webserverSecurePort	int Minimum: -1 Maximum: 65535	443	Web server HTTPS port
wsServerIOTimeout	A period of time with second precision		Identifies the maximum amount of time that the web server plugin waits to send a request or receive a websocket response from the application server. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
wsServerIdleTimeout	A period of time with second precision		Identifies the maximum amount of time that the web server plugin waits to terminate an idle websocket connection. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

pluginConfiguration > httpEndpoint

Description: Specify the identifier of the http endpoint to include in the generated plugin-cfg.xml file. The endpoint defines the server in the cluster. The default value is 'defaultHttpEndpoint'.

Required: false

Data type:

Attribute name	Data type	Default value	Description
accessLoggingRef	A reference to top level httpAccessLogging element (string).		HTTP access logging configuration for the endpoint.
enabled	boolean	true	Toggle the availability of an endpoint. When true, this endpoint will be activated by the dispatcher to handle HTTP requests.
host	string	localhost	IP address, DNS host name with domain name suffix, or just the DNS host name, used by a client to request a resource. Use '*' for available network interfaces.
httpOptionsRef	A reference to top level httpOptions element (string).	defaultHttpOptions	HTTP protocol options for the endpoint.
httpPort	int Minimum: -1 Maximum: 65535		The port used for client HTTP requests. Use -1 to disable this port.
httpsPort	int Minimum: -1 Maximum: 65535		The port used for client HTTP requests secured with SSL (https). Use -1 to disable this port.
onError	IGNORE FAIL WARN	WARN	Action to take after a failure to start an endpoint. IGNORE Server will not issue any warning and error messages when it incurs a configuration error. FAIL Server will issue a warning or error message on the first error occurrence and then stop the server. WARN Server will issue warning and error messages when it incurs a configuration error.
sslOptionsRef	A reference to top level sslOptions element (string).		SSL protocol options for the endpoint.
tcpOptionsRef	A reference to top level tcpOptions element (string).	defaultTCPOptions	TCP protocol options for the endpoint.

pluginConfiguration > httpEndpoint > accessLogging

Description: HTTP access logging configuration for the endpoint.

Required: false

Data type:

Attribute name	Data type	Default value	Description
enabled	boolean	true	Enable access logging.
filePath	Path to a file	${server.output.dir}/logs/http_access.log	Directory path and name of the access log file. Standard variable substitutions, such as ${server.output.dir}, can be used when specifying the directory path.
logFormat	string	%h %u %{t}W "%r" %s %b	Log format used when logging client access information.
maxFileSize	int Minimum: 0	20	Maximum size of a log file, in megabytes, before being rolled over; a value of 0 means no limit.
maxFiles	int Minimum: 0	2	Maximum number of log files that will be kept, before the oldest file is removed; a value of 0 means no limit.

pluginConfiguration > httpEndpoint > httpOptions

Description: HTTP protocol options for the endpoint.

Required: false

Data type:

Attribute name	Data type	Default value	Description
keepAliveEnabled	boolean	true	Enables persistent connections (HTTP keepalive). If true, connections are kept alive for reuse by multiple sequential requests and responses. If false, connections are closed after the response is sent.
maxKeepAliveRequests	int Minimum: -1	100	Maximum number of persistent requests allowed on a single HTTP connection if persistent connections are enabled. A value of -1 means unlimited.
persistTimeout	A period of time with second precision	30s	Amount of time that a socket will be allowed to remain idle between requests. This setting only applies if persistent connections are enabled. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
readTimeout	A period of time with second precision	60s	Amount of time to wait for a read request to complete on a socket after the first read occurs. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
removeServerHeader	boolean	false	Removes server implementation information from HTTP headers and also disables the default Liberty profile welcome page.
writeTimeout	A period of time with second precision	60s	Amount of time to wait on a socket for each portion of the response data to be transmitted. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

pluginConfiguration > httpEndpoint > sslOptions

Description: SSL protocol options for the endpoint.

Required: false

Data type:

Attribute name	Data type	Default value	Description
sessionTimeout	A period of time with second precision	1d	Amount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
sslRef	string		The default SSL configuration repertoire. The default value is defaultSSLSettings.
suppressHandshakeErrors	boolean	false	Disable logging of SSL handshake errors. SSL handshake errors can occur during normal operation, however these messages can be useful when SSL is behaving unexpectedly.

pluginConfiguration > httpEndpoint > tcpOptions

Description: TCP protocol options for the endpoint.

Required: false

Data type:

Attribute name	Data type	Default value	Description
inactivityTimeout	A period of time with millisecond precision	60s	Amount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
soReuseAddr	boolean	true	Enables immediate rebind to a port with no active listener.

tcpOptions

Defines TCP protocol settings.

Attribute name	Data type	Default value	Description
id	string		A unique configuration ID.
inactivityTimeout	A period of time with millisecond precision	60s	Amount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
soReuseAddr	boolean	true	Enables immediate rebind to a port with no active listener.

virtualHost

A virtual host provides a logical grouping for configuring web applications to a particular host name. The default virtual host (default_host) is suitable for most simple configurations.

Attribute name	Data type	Default value	Description
allowFromEndpointRef	List of references to top level httpEndpoint elements (comma-separated string).		Specify the identifier of one or more HTTP endpoints to restrict inbound traffic for this virtual host to the specified endpoints.
enabled	boolean	true	Enable this virtual host.
id	string		A unique configuration ID.

virtualHost > allowFromEndpoint

Description: Specify the identifier of one or more HTTP endpoints to restrict inbound traffic for this virtual host to the specified endpoints.

Required: false

Data type:

Attribute name	Data type	Default value	Description
accessLoggingRef	A reference to top level httpAccessLogging element (string).		HTTP access logging configuration for the endpoint.
enabled	boolean	true	Toggle the availability of an endpoint. When true, this endpoint will be activated by the dispatcher to handle HTTP requests.
host	string	localhost	IP address, DNS host name with domain name suffix, or just the DNS host name, used by a client to request a resource. Use '*' for available network interfaces.
httpOptionsRef	A reference to top level httpOptions element (string).	defaultHttpOptions	HTTP protocol options for the endpoint.
httpPort	int Minimum: -1 Maximum: 65535		The port used for client HTTP requests. Use -1 to disable this port.
httpsPort	int Minimum: -1 Maximum: 65535		The port used for client HTTP requests secured with SSL (https). Use -1 to disable this port.
onError	IGNORE FAIL WARN	WARN	Action to take after a failure to start an endpoint. IGNORE Server will not issue any warning and error messages when it incurs a configuration error. FAIL Server will issue a warning or error message on the first error occurrence and then stop the server. WARN Server will issue warning and error messages when it incurs a configuration error.
sslOptionsRef	A reference to top level sslOptions element (string).		SSL protocol options for the endpoint.
tcpOptionsRef	A reference to top level tcpOptions element (string).	defaultTCPOptions	TCP protocol options for the endpoint.

virtualHost > allowFromEndpoint > accessLogging

Description: HTTP access logging configuration for the endpoint.

Required: false

Data type:

Attribute name	Data type	Default value	Description
enabled	boolean	true	Enable access logging.
filePath	Path to a file	${server.output.dir}/logs/http_access.log	Directory path and name of the access log file. Standard variable substitutions, such as ${server.output.dir}, can be used when specifying the directory path.
logFormat	string	%h %u %{t}W "%r" %s %b	Log format used when logging client access information.
maxFileSize	int Minimum: 0	20	Maximum size of a log file, in megabytes, before being rolled over; a value of 0 means no limit.
maxFiles	int Minimum: 0	2	Maximum number of log files that will be kept, before the oldest file is removed; a value of 0 means no limit.

virtualHost > allowFromEndpoint > httpOptions

Description: HTTP protocol options for the endpoint.

Required: false

Data type:

Attribute name	Data type	Default value	Description
keepAliveEnabled	boolean	true	Enables persistent connections (HTTP keepalive). If true, connections are kept alive for reuse by multiple sequential requests and responses. If false, connections are closed after the response is sent.
maxKeepAliveRequests	int Minimum: -1	100	Maximum number of persistent requests allowed on a single HTTP connection if persistent connections are enabled. A value of -1 means unlimited.
persistTimeout	A period of time with second precision	30s	Amount of time that a socket will be allowed to remain idle between requests. This setting only applies if persistent connections are enabled. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
readTimeout	A period of time with second precision	60s	Amount of time to wait for a read request to complete on a socket after the first read occurs. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
removeServerHeader	boolean	false	Removes server implementation information from HTTP headers and also disables the default Liberty profile welcome page.
writeTimeout	A period of time with second precision	60s	Amount of time to wait on a socket for each portion of the response data to be transmitted. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

virtualHost > allowFromEndpoint > sslOptions

Description: SSL protocol options for the endpoint.

Required: false

Data type:

Attribute name	Data type	Default value	Description
sessionTimeout	A period of time with second precision	1d	Amount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
sslRef	string		The default SSL configuration repertoire. The default value is defaultSSLSettings.
suppressHandshakeErrors	boolean	false	Disable logging of SSL handshake errors. SSL handshake errors can occur during normal operation, however these messages can be useful when SSL is behaving unexpectedly.

virtualHost > allowFromEndpoint > tcpOptions

Description: TCP protocol options for the endpoint.

Required: false

Data type:

Attribute name	Data type	Default value	Description
inactivityTimeout	A period of time with millisecond precision	60s	Amount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
soReuseAddr	boolean	true	Enables immediate rebind to a port with no active listener.

virtualHost > hostAlias

Description: Associate a host and port with this virtual host, using the host:port syntax. The specified host can be an IP address, DNS hostname with a domain name suffix, the DNS hostname, or * for a wildcard match on all hostnames. Note that IPv6 addresses must be enclosed in [].

Required: false

Data type: string

webApplication

Defines the properties of a web application.

Attribute name	Data type	Default value	Description
autoStart	boolean	true	Indicates whether or not the server should start the application automatically when the server starts.
contextRoot	string		Context root of an application.
id	string		A unique configuration ID.
location	A file, directory or url.		Location of an application expressed as an absolute path or a path relative to the server-level apps directory.
name	string		Name of an application.
suppressUncoveredHttpMethodWarning	boolean	false	Option to suppress uncovered HTTP method warning message during application deployment.

webApplication > application-bnd

Description: Binds general deployment information included in the application to specific resources.

Required: false

Data type:

Attribute name	Data type	Default value	Description
version	string		Version of the application bindings specification.

webApplication > application-bnd > security-role

Description: A role that is mapped to users and groups in a domain user registry.

Required: false

Data type:

Attribute name	Data type	Default value	Description
name	string		Name of a security role.

webApplication > application-bnd > security-role > group

Description: A group possessing a security role.

Required: false

Data type:

Attribute name	Data type	Default value	Description
access-id	string		Group access ID
name	string		Name of a group possessing a security role.

webApplication > application-bnd > security-role > run-as

Description: ID and password of a user required to access a bean from another bean.

Required: false

Data type:

Attribute name	Data type	Default value	Description
password	Reversably encoded password (string)		Password of a user required to access a bean from another bean. Stored in clear text or encoded form. To encode the password, use the securityUtility tool with the encode option.
userid	string		ID of a user required to access a bean from another bean.

webApplication > application-bnd > security-role > special-subject

Description: Name of a special-subject possessing a security role.

Required: false

Data type:

Attribute name	Data type	Default value	Description
type	EVERYONE ALL_AUTHENTICATED_USERS		One of the following special subject types: ALL_AUTHENTICATED_USERS, EVERYONE. EVERYONE Everyone ALL_AUTHENTICATED_USERS All authenticated users

webApplication > application-bnd > security-role > user

Description: A user possessing a security role.

Required: false

Data type:

Attribute name	Data type	Default value	Description
access-id	string		A user access ID in the general form user:realmName/userUniqueId. A value will be generated if one is not specified.
name	string		Name of a user possessing a security role.

webApplication > classloader

Description: Defines the settings for an application classloader.

Required: false

Data type:

Attribute name	Data type	Default value	Description
apiTypeVisibility	string	spec,ibm-api,api	The types of API package this class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party.
classProviderRef	List of references to top level resourceAdapter elements (comma-separated string).		List of class provider references. When searching for classes or resources, this class loader will delegate to the specified class providers after searching its own class path.
commonLibraryRef	List of references to top level library elements (comma-separated string).		List of library references. Library class instances are shared with other classloaders.
delegation	parentFirst parentLast	parentFirst	Controls whether parent classloader is used before or after this classloader. If parent first is selected then delegate to immediate parent before searching the classpath. If parent last is selected then search the classpath before delegating to the immediate parent. parentFirst Parent first parentLast Parent last
privateLibraryRef	List of references to top level library elements (comma-separated string).		List of library references. Library class instances are unique to this classloader, independent of class instances from other classloaders.

webApplication > classloader > commonLibrary

Description: List of library references. Library class instances are shared with other classloaders.

Required: false

Data type:

Attribute name	Data type	Default value	Description
apiTypeVisibility	string	spec,ibm-api,api	The types of API package this library's class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party.
description	string		Description of shared library for administrators
filesetRef	List of references to top level fileset elements (comma-separated string).		Id of referenced Fileset
name	string		Name of shared library for administrators

webApplication > classloader > commonLibrary > file

Description: Id of referenced File

Required: false

Data type:

Attribute name	Data type	Default value	Description
name	Path to a file		Fully qualified filename

webApplication > classloader > commonLibrary > fileset

Description: Id of referenced Fileset

Required: false

Data type:

Attribute name	Data type	Default value	Description
caseSensitive	boolean	true	Boolean to indicate whether or not the search should be case sensitive (default: true).
dir	Path to a directory	${server.config.dir}	The base directory to search for files.
excludes	string		The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
includes	string	*	The comma or space separated list of file name patterns to include in the search results (default: *).
scanInterval	A period of time with millisecond precision	0	Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

webApplication > classloader > commonLibrary > folder

Description: Id of referenced folder

Required: false

Data type:

Attribute name	Data type	Default value	Description
dir	Path to a directory		Directory or folder to be included in the library classpath for locating resource files

webApplication > classloader > privateLibrary

Description: List of library references. Library class instances are unique to this classloader, independent of class instances from other classloaders.

Required: false

Data type:

Attribute name	Data type	Default value	Description
apiTypeVisibility	string	spec,ibm-api,api	The types of API package this library's class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party.
description	string		Description of shared library for administrators
filesetRef	List of references to top level fileset elements (comma-separated string).		Id of referenced Fileset
name	string		Name of shared library for administrators

webApplication > classloader > privateLibrary > file

Description: Id of referenced File

Required: false

Data type:

Attribute name	Data type	Default value	Description
name	Path to a file		Fully qualified filename

webApplication > classloader > privateLibrary > fileset

Description: Id of referenced Fileset

Required: false

Data type:

Attribute name	Data type	Default value	Description
caseSensitive	boolean	true	Boolean to indicate whether or not the search should be case sensitive (default: true).
dir	Path to a directory	${server.config.dir}	The base directory to search for files.
excludes	string		The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
includes	string	*	The comma or space separated list of file name patterns to include in the search results (default: *).
scanInterval	A period of time with millisecond precision	0	Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

webApplication > classloader > privateLibrary > folder

Description: Id of referenced folder

Required: false

Data type:

Attribute name	Data type	Default value	Description
dir	Path to a directory		Directory or folder to be included in the library classpath for locating resource files

webContainer

Configuration for the web container.

Attribute name	Data type	Default value	Description
allowIncludeSendError	boolean	false	Allow RequestDispatch to send errors on Include methods. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.allowincludesenderror.
asyncMaxSizeTaskPool	int	5000	Maximum size of tasks in the Async task pool before automatically purging canceled tasks. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.asyncmaxsizetaskpool.
asyncPurgeInterval	int	30000	Time interval to wait between each required purge of the cancelled task pool. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.asyncpurgeinterval.
asyncTimeoutDefault	int	30000	Async servlet timeout value used when a timeout value has not been explcitly specified. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.asynctimeoutdefault.
asyncTimerThreads	int	2	Maximum number of threads to use for async servlet timeout processing. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.asynctimerthreads.
channelWriteType	string	async	When set to 'sync', responses will be written synchronously; otherwise, responses will be written asychronously. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.channelwritetype.
copyAttributesKeySet	boolean	false	Web container will return an enumeration of a copy of the list of attributes to the servlet to avoid a concurrent access error by the servlet. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.copyattributeskeyset.
decodeUrlAsUtf8	boolean	true	Decode URLs using an encoding setting of UTF-8.
decodeUrlPlusSign	boolean	false	Decode the plus sign when it is part of the URL. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.decodeurlplussign.
defaultHeadRequestBehavior	boolean	false	Restore the behavior where the HEAD request is not subject to the security constraint defined for the GET method. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.DefaultHeadRequestBehavior.
defaultTraceRequestBehavior	boolean	false	Restore HTTP TRACE processing. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.DefaultTraceRequestBehavior.
deferServletLoad	boolean	true	Defer servlet loading and initialization until the first request.
directoryBrowsingEnabled	boolean	false	Enable directory browsing of an application.
disableXPoweredBy	boolean	false	Disable setting the X-Powered-By header. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.disablexpoweredby.
disallowAllFileServing	boolean	false	Disables all file serving by applications. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.disallowAllFileServing.
disallowServeServletsByClassName	boolean	false	Disallows the use of serveServletsByClassnameEnabled on the application server level. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.disallowserveservletsbyclassname.
dispatcherRethrowsEr	boolean	true	Web container will re-throw errors allowing interested resources to process them. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.dispatcherRethrowser.
doNotServeByClassName	string		A semi-colon delimited list of classes to be completely disallowed from being served by classname. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.donotservebyclassname.
enableDefaultIsElIgnoredInTag	boolean	false	Always evaluate whether to ignore EL expressions in tag files. If parent JSP files have different isELIgnored settings, the setting will be re-evaluated in the tag file. The equivalent custom property in the full profile application server is com.ibm.ws.jsp.enabledefaultiselignoredintag.
enableErrorExceptionTypeFirst	boolean	false	Web container is updated to search and use the exception-type before the error-code. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.enableErrorExceptionTypeFirst.
enableJspMappingOverride	boolean	false	Allow the JSP mapping to be overridden so the application can serve the JSP contents itself. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.enablejspmappingoverride.
enableMultiReadOfPostData	boolean	false	Retain post data for multiple read accesses. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.enablemultireadofpostdata.
exposeWebInfOnDispatch	boolean	false	If true, a servlet can access files in the WEB-INF directory. If false (default), a servlet cannot access files the WEB-INF directory.
fileServingEnabled	boolean	true	Enable file serving if this setting was not explicitly specified for the application.
fileWrapperEvents	boolean	false	Web container will generate SMF and PMI data when serving the static files. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.fileWrapperEvents.
httpsIndicatorHeader	string		For SSL offloading, set to the name of the HTTP header variable inserted by the SSL accelerator/proxy/load balancer.
ignoreSessiononStaticFileRequest	boolean	false	Improves performance by preventing the web container from accessing a session for static file requests involving filters. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.IgnoreSessiononStaticFileRequest.
invokeFilterInitAtStartup	boolean	true	Web container will call the filter's init() method at application startup. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.invokeFilterInitAtStartup.
listeners	string		A comma separated list of listener classes.
logServletContainerInitializerClassLoadingErrors	boolean	false	Log servlet container class loading errors as warnings rather than logging them only when debug is enabled. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.logservletcontainerinitializerclassloadingerrors.
metaInfResourcesCacheSize	int	20	Initial size (number of entries) of the meta-inf resource cache. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.metainfresourcescachesize.name.
parseUtf8PostData	boolean	false	Web container will detect non URL encoded UTF-8 post data and include it in the parameter values. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.parseutf8postdata.
serveServletsByClassnameEnabled	boolean	false	Enable servlets to be accessed in a web application using a class name if not explicitly specified.
setContentLengthOnClose	boolean	true	Toggle to set content length when an application explicitly closes the response. The default value is true; however, set this value to false if an application response contains double-byte characters.
skipMetaInfResourcesProcessing	boolean	false	Do not search the meta-inf directory for application resources. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.skipmetainfresourcesprocessing.
suppressHtmlRecursiveErrorOutput	boolean	false	Suppresses the exception information from appearing in the HTML output when there is a recursive error that cannot be handled by an application's configured error page. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.suppressHtmlRecursiveErrorOutput.
symbolicLinksCacheSize	int	1000	Initial size of the symbolic link cache. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.SymbolicLinksCacheSize.
tolerateSymbolicLinks	boolean	false	Enables the web container to support the use of symbolic links. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.TolerateSymbolicLinks.
xPoweredBy	string		Alternative string for the X-Powered-By header setting. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.xpoweredby. There is no default value for this property. If the property is not set, the value of the X-Powered-By header is set to Servlet/<servlet spec version>, as defined by the Servlet specification.