This topic applies to WebSphere Application Server Liberty V8.5.5.9 and earlier. For the latest Liberty topics, see the WebSphere Application Server Liberty documentation.
Application (application)
Defines the properties of an application.
Attribute name | Data type | Default value | Description |
---|---|---|---|
autoStart | boolean | true | Indicates whether or not the server automatically starts the application. |
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-bnd
Description: Binds general deployment information included in the application to specific resources.Required: falseData type: Attribute name Data type Default value Description version string Version of the application bindings specification. - application-bnd > security-role
Description: A unique configuration ID.Required: falseData type: Attribute name Data type Default value Description id string A unique configuration ID. name string Name of a security role. - application-bnd > security-role > group
Description: A unique configuration ID.Required: falseData type: Attribute name Data type Default value Description access-id string Group access ID id string A unique configuration ID. name string Name of a group possessing a security role.
- application-bnd > security-role > run-as
Description: A unique configuration ID.Required: falseData type: Attribute name Data type Default value Description id string A unique configuration ID. password Reversably encoded password (string) Password of a user required to access a bean from another bean. The value can be 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-bnd > security-role > special-subject
Description: A unique configuration ID.Required: falseData type: Attribute name Data type Default value Description id string A unique configuration ID. 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-bnd > security-role > user
Description: A unique configuration ID.Required: falseData 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. id string A unique configuration ID. name string Name of a user possessing a security role.
- classloader
Description: Defines the settings for an application classloader.Required: falseData 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. - classloader > commonLibrary
Description: List of library references. Library class instances are shared with other classloaders.Required: falseData 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 id string A unique configuration ID. name string Name of shared library for administrators - classloader > commonLibrary > file
Description: Id of referenced FileRequired: falseData type: Attribute name Data type Default value Description id string A unique configuration ID. name Path to a file Fully qualified filename
- classloader > commonLibrary > fileset
Description: Id of referenced FilesetRequired: falseData 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. id string A unique configuration ID. 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. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
- classloader > commonLibrary > folder
Description: Id of referenced folderRequired: falseData 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 id string A unique configuration ID.
- classloader > privateLibrary
Description: List of library references. Library class instances are unique to this classloader, independent of class instances from other classloaders.Required: falseData 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 id string A unique configuration ID. name string Name of shared library for administrators - classloader > privateLibrary > file
Description: Id of referenced FileRequired: falseData type: Attribute name Data type Default value Description id string A unique configuration ID. name Path to a file Fully qualified filename
- classloader > privateLibrary > fileset
Description: Id of referenced FilesetRequired: falseData 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. id string A unique configuration ID. 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. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
- classloader > privateLibrary > folder
Description: Id of referenced folderRequired: falseData 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 id string A unique configuration ID.
- resourceAdapter
Description: Specifies configuration for a resource adapter that is embedded in an application.Required: falseData 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. - resourceAdapter > contextService
Description: Configures how context is captured and propagated to threads.Required: falseData type: Attribute name Data type Default value Description baseContextRef A reference to top level contextService element (string). Specifies a base context service from which to inherit context that is not already defined on this context service. jndiName string JNDI name onError - IGNORE
- FAIL
- WARN
WARN Determines the action to take in response to configuration errors. For example, if securityContext is configured for this contextService, but the security feature is not enabled, then onError determines whether to fail, raise a warning, or ignore the parts of the configuration which are incorrect. - 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.
- resourceAdapter > contextService > baseContext
Description: Specifies a base context service from which to inherit context that is not already defined on this context service.Required: falseData type: Attribute name Data type Default value Description baseContextRef A reference to top level contextService element (string). Specifies a base context service from which to inherit context that is not already defined on this context service. id string A unique configuration ID. jndiName string JNDI name onError - IGNORE
- FAIL
- WARN
WARN Determines the action to take in response to configuration errors. For example, if securityContext is configured for this contextService, but the security feature is not enabled, then onError determines whether to fail, raise a warning, or ignore the parts of the configuration which are incorrect. - 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.
- resourceAdapter > contextService > baseContext > baseContext
Description: Specifies a base context service from which to inherit context that is not already defined on this context service.Required: falseData type: com.ibm.ws.context.service-factory
- resourceAdapter > contextService > baseContext > classloaderContext
Description: Classloader context propagation configuration.Required: falseData type:
- resourceAdapter > contextService > baseContext > jeeMetadataContext
Description: Makes the namespace of the application component that submits a contextual task available to the task.Required: falseData type:
- resourceAdapter > contextService > baseContext > securityContext
Description: When specified, the security context of the work initiator is propagated to the unit of work.Required: falseData type:
- resourceAdapter > contextService > baseContext > syncToOSThreadContext
Description: When specified, the identity of the runAs Subject for the unit of work is synchronized with the Operating System identity.Required: falseData type:
- resourceAdapter > contextService > baseContext > zosWLMContext
Description: Indicates that the z/OS WLM Context should be managed as part of the thread context.Required: falseData type: Attribute name Data type Default value Description daemonTransactionClass string ASYNCDMN The Transaction Class name provided to WLM to classify work when a new WLM context is created for Daemon work. defaultTransactionClass string ASYNCBN The Transaction Class name provided to WLM to classify work when a new WLM context is being created for non-Daemon work. wlm - Propagate
- PropagateOrNew
- New
Propagate Indicates how the WLM context should be handled for non-Daemon work. - Propagate
- Use the same WLM Context (if one exists).
- PropagateOrNew
- Use the same WLM context or create a new one if no current context exists.
- New
- Always create a new WLM context.
- resourceAdapter > contextService > classloaderContext
Description: Classloader context propagation configuration.Required: falseData type:
- resourceAdapter > contextService > jeeMetadataContext
Description: Makes the namespace of the application component that submits a contextual task available to the task.Required: falseData type:
- resourceAdapter > contextService > securityContext
Description: When specified, the security context of the work initiator is propagated to the unit of work.Required: falseData type:
- resourceAdapter > contextService > syncToOSThreadContext
Description: When specified, the identity of the runAs Subject for the unit of work is synchronized with the Operating System identity.Required: falseData type:
- resourceAdapter > contextService > zosWLMContext
Description: Indicates that the z/OS WLM Context should be managed as part of the thread context.Required: falseData type: Attribute name Data type Default value Description daemonTransactionClass string ASYNCDMN The Transaction Class name provided to WLM to classify work when a new WLM context is created for Daemon work. defaultTransactionClass string ASYNCBN The Transaction Class name provided to WLM to classify work when a new WLM context is being created for non-Daemon work. wlm - Propagate
- PropagateOrNew
- New
Propagate Indicates how the WLM context should be handled for non-Daemon work. - Propagate
- Use the same WLM Context (if one exists).
- PropagateOrNew
- Use the same WLM context or create a new one if no current context exists.
- New
- Always create a new WLM context.
- resourceAdapter > customize
Description: Customizes the configuration properties element for the activation specification, administered object, or connection factory with the specified interface and/or implementation class.Required: falseData type: Attribute name Data type Default value Description implementation string Fully qualified implementation class name for which the configuration properties element should be customized. interface string Fully qualified interface class name for which the configuration properties element should be customized. suffix string Overrides the default suffix for the configuration properties element. For example, "CustomConnectionFactory" in properties.rarModule1.CustomConnectionFactory. The suffix is useful to disambiguate when multiple types of connection factories, administered objects, or endpoint activations are provided by a resource adapter. If a configuration properties element customization omits the suffix or leaves it blank, no suffix is used.