enterpriseApplication - Enterprise Application (enterpriseApplication)

Defines the properties of an enterprise application.

NameTypeDefaultDescription
idstringA unique configuration ID.
locationA file, directory or url.Location of an application expressed as an absolute path or a path relative to the server-level apps directory.
namestringName of an application.
autoStartbooleantrueIndicates whether or not the server automatically starts the application.
suppressUncoveredHttpMethodWarningbooleanfalseOption to suppress uncovered HTTP method warning message during application deployment.
defaultClientModulestringDefault client module of an enterprise application.

application-bnd

Defines properties that apply to application bindings.

application-bnd > ejb-ref

Specifies the binding for an EJB Reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the EJB reference.
binding-namestringThe binding name for the EJB reference.

application-bnd > resource-ref

Specifies the binding for a resource reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource reference.
binding-namestringThe binding name for the resource reference.

application-bnd > resource-ref > authentication-alias

The authentication alias for the resource reference.

NameTypeDefaultDescription
nameRefA reference to top level authData element (string).The authentication alias name.

application-bnd > resource-ref > authentication-alias > name

The authentication alias name.

NameTypeDefaultDescription
userstringName of the user to use when connecting to the EIS.
passwordReversably encoded password (string)Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

application-bnd > resource-ref > custom-login-configuration

Specifies custom login configuration properties.

NameTypeDefaultDescription
namestringA name for the custom login configuration.

application-bnd > resource-ref > custom-login-configuration > property

Defines a property for a custom login configuration.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the property.
valuestringThe value of the property.
descriptionstringA description of the property.

application-bnd > resource-env-ref

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource environment reference.
binding-namestringThe binding name for the resource environment reference.

application-bnd > message-destination-ref

Specifies the binding for a message destination reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the message destination reference.
binding-namestringThe binding name for the message destination reference.

application-bnd > data-source

Specifies the binding for a data source.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe data source name.
binding-namestringThe data source binding name.

application-bnd > env-entry

Specifies the binding for an environment entry.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the environment entry.
valuestringThe value of the environment entry.
binding-namestringThe binding name for the environment entry.

application-bnd > security-role

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

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for a security role.

application-bnd > security-role > user

The user for a security role.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the subject.
access-idstringThe access ID for a subject.

application-bnd > security-role > group

The group for a security role.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the subject.
access-idstringThe access ID for a subject.

application-bnd > security-role > special-subject

Name of a special subject possessing a security role.

NameTypeDefaultDescription
idstringA unique configuration ID.
type
  • ALL_AUTHENTICATED_USERS
  • EVERYONE
One of the following special subject types: ALL_AUTHENTICATED_USERS, EVERYONE.
ALL_AUTHENTICATED_USERS
ALL_AUTHENTICATED_USERS
EVERYONE
EVERYONE

application-bnd > security-role > run-as

ID and password of a user that is required to access a bean from another bean.

NameTypeDefaultDescription
useridstringID of a user required to access a bean from another bean.
passwordReversably 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.

web-bnd

Specifies binding properties for a web application.

NameTypeDefaultDescription
moduleNamestringThe module name specifies the individual module that the binding or extension configuration applies to.

web-bnd > ejb-ref

Specifies the binding for an EJB Reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the EJB reference.
binding-namestringThe binding name for the EJB reference.

web-bnd > resource-ref

Specifies the binding for a resource reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource reference.
binding-namestringThe binding name for the resource reference.

web-bnd > resource-ref > authentication-alias

The authentication alias for the resource reference.

NameTypeDefaultDescription
nameRefA reference to top level authData element (string).The authentication alias name.

web-bnd > resource-ref > authentication-alias > name

The authentication alias name.

NameTypeDefaultDescription
userstringName of the user to use when connecting to the EIS.
passwordReversably encoded password (string)Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

web-bnd > resource-ref > custom-login-configuration

Specifies custom login configuration properties.

NameTypeDefaultDescription
namestringA name for the custom login configuration.

web-bnd > resource-ref > custom-login-configuration > property

Defines a property for a custom login configuration.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the property.
valuestringThe value of the property.
descriptionstringA description of the property.

web-bnd > resource-env-ref

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource environment reference.
binding-namestringThe binding name for the resource environment reference.

web-bnd > message-destination-ref

Specifies the binding for a message destination reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the message destination reference.
binding-namestringThe binding name for the message destination reference.

web-bnd > data-source

Specifies the binding for a data source.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe data source name.
binding-namestringThe data source binding name.

web-bnd > env-entry

Specifies the binding for an environment entry.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the environment entry.
valuestringThe value of the environment entry.
binding-namestringThe binding name for the environment entry.

web-bnd > virtual-host

Specifies the virtual host that is used for the web application.

NameTypeDefaultDescription
namestringThe name for the virtual host

application-client-bnd

Defines properties that apply to application clients.

application-client-bnd > ejb-ref

EJB References in an application client.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the EJB reference.
binding-namestringThe binding name for the EJB reference.

application-client-bnd > resource-ref

Resource references in an application client.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource reference.
binding-namestringThe binding name for the resource reference.

application-client-bnd > resource-ref > authentication-alias

The authentication alias for the resource reference.

NameTypeDefaultDescription
nameRefA reference to top level authData element (string).The authentication alias name.

application-client-bnd > resource-ref > authentication-alias > name

The authentication alias name.

NameTypeDefaultDescription
userstringName of the user to use when connecting to the EIS.
passwordReversably encoded password (string)Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

application-client-bnd > resource-ref > custom-login-configuration

Specifies custom login configuration properties.

NameTypeDefaultDescription
namestringA name for the custom login configuration.

application-client-bnd > resource-ref > custom-login-configuration > property

Defines a property for a custom login configuration.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the property.
valuestringThe value of the property.
descriptionstringA description of the property.

application-client-bnd > resource-env-ref

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource environment reference.
binding-namestringThe binding name for the resource environment reference.

application-client-bnd > message-destination-ref

Message destination reference in an application client.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the message destination reference.
binding-namestringThe binding name for the message destination reference.

application-client-bnd > data-source

Defines a data source for an application client.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe data source name.
binding-namestringThe data source binding name.

application-client-bnd > env-entry

Defines an environment entry for an application client.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the environment entry.
valuestringThe value of the environment entry.
binding-namestringThe binding name for the environment entry.

classloader

Defines the settings for an application classloader.

NameTypeDefaultDescription
delegation
  • parentLast
  • parentFirst
parentFirstControls 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.
parentLast
Parent last
parentFirst
Parent first
privateLibraryRefList 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.
commonLibraryRefList of references to top level library elements (comma-separated string).List of library references. Library class instances are shared with other classloaders.
classProviderRefList 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.
apiTypeVisibilitystringspec,ibm-api,api,stableThe types of API packages that this class loader supports. This value is a comma-separated list of any combination of the following API packages: spec, ibm-api, api, stable, third-party.

classloader > privateLibrary

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

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringName of shared library for administrators
descriptionstringDescription of shared library for administrators
filesetRefList of references to top level fileset elements (comma-separated string).Id of referenced Fileset
apiTypeVisibilitystringspec,ibm-api,api,stableThe types of API packages that this class loader supports. This value is a comma-separated list of any combination of the following API packages: spec, ibm-api, api, stable, third-party.

classloader > privateLibrary > fileset

Id of referenced Fileset

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directory${server.config.dir}The base directory to search for files.
caseSensitivebooleantrueBoolean to indicate whether or not the search should be case sensitive (default: true).
includesstring*The comma or space separated list of file name patterns to include in the search results (default: *).
excludesstringThe comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
scanIntervalA period of time with millisecond precision0Scanning 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

Id of referenced folder

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directoryDirectory or folder to be included in the library classpath for locating resource files

classloader > privateLibrary > file

Id of referenced File

NameTypeDefaultDescription
idstringA unique configuration ID.
namePath to a fileFully qualified filename

classloader > commonLibrary

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

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringName of shared library for administrators
descriptionstringDescription of shared library for administrators
filesetRefList of references to top level fileset elements (comma-separated string).Id of referenced Fileset
apiTypeVisibilitystringspec,ibm-api,api,stableThe types of API packages that this class loader supports. This value is a comma-separated list of any combination of the following API packages: spec, ibm-api, api, stable, third-party.

classloader > commonLibrary > fileset

Id of referenced Fileset

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directory${server.config.dir}The base directory to search for files.
caseSensitivebooleantrueBoolean to indicate whether or not the search should be case sensitive (default: true).
includesstring*The comma or space separated list of file name patterns to include in the search results (default: *).
excludesstringThe comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
scanIntervalA period of time with millisecond precision0Scanning 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

Id of referenced folder

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directoryDirectory or folder to be included in the library classpath for locating resource files

classloader > commonLibrary > file

Id of referenced File

NameTypeDefaultDescription
idstringA unique configuration ID.
namePath to a fileFully qualified filename

ejb-jar-bnd

The EJB binding descriptor defines binding information for an EJB module.

NameTypeDefaultDescription
moduleNamestringThe module name specifies the individual module that the binding or extension configuration applies to.

ejb-jar-bnd > session

Binding properties for session beans.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the enterprise bean.
simple-binding-namestringSpecifies the simple binding name for a session bean.
component-idstringThe component ID for a session bean.
remote-home-binding-namestringThe remote home binding name for a session bean.
local-home-binding-namestringThe local home binding name for a session bean.

ejb-jar-bnd > session > ejb-ref

Specifies the binding for an EJB Reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the EJB reference.
binding-namestringThe binding name for the EJB reference.

ejb-jar-bnd > session > resource-ref

Specifies the binding for a resource reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource reference.
binding-namestringThe binding name for the resource reference.

ejb-jar-bnd > session > resource-ref > authentication-alias

The authentication alias for the resource reference.

NameTypeDefaultDescription
nameRefA reference to top level authData element (string).The authentication alias name.

ejb-jar-bnd > session > resource-ref > authentication-alias > name

The authentication alias name.

NameTypeDefaultDescription
userstringName of the user to use when connecting to the EIS.
passwordReversably encoded password (string)Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

ejb-jar-bnd > session > resource-ref > custom-login-configuration

Specifies custom login configuration properties.

NameTypeDefaultDescription
namestringA name for the custom login configuration.

ejb-jar-bnd > session > resource-ref > custom-login-configuration > property

Defines a property for a custom login configuration.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the property.
valuestringThe value of the property.
descriptionstringA description of the property.

ejb-jar-bnd > session > resource-env-ref

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource environment reference.
binding-namestringThe binding name for the resource environment reference.

ejb-jar-bnd > session > message-destination-ref

Specifies the binding for a message destination reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the message destination reference.
binding-namestringThe binding name for the message destination reference.

ejb-jar-bnd > session > data-source

Specifies the binding for a data source.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe data source name.
binding-namestringThe data source binding name.

ejb-jar-bnd > session > env-entry

Specifies the binding for an environment entry.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the environment entry.
valuestringThe value of the environment entry.
binding-namestringThe binding name for the environment entry.

ejb-jar-bnd > message-driven

Binding properties for message driven beans.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the enterprise bean.

ejb-jar-bnd > message-driven > ejb-ref

Specifies the binding for an EJB Reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the EJB reference.
binding-namestringThe binding name for the EJB reference.

ejb-jar-bnd > message-driven > resource-ref

Specifies the binding for a resource reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource reference.
binding-namestringThe binding name for the resource reference.

ejb-jar-bnd > message-driven > resource-ref > authentication-alias

The authentication alias for the resource reference.

NameTypeDefaultDescription
nameRefA reference to top level authData element (string).The authentication alias name.

ejb-jar-bnd > message-driven > resource-ref > authentication-alias > name

The authentication alias name.

NameTypeDefaultDescription
userstringName of the user to use when connecting to the EIS.
passwordReversably encoded password (string)Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

ejb-jar-bnd > message-driven > resource-ref > custom-login-configuration

Specifies custom login configuration properties.

NameTypeDefaultDescription
namestringA name for the custom login configuration.

ejb-jar-bnd > message-driven > resource-ref > custom-login-configuration > property

Defines a property for a custom login configuration.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the property.
valuestringThe value of the property.
descriptionstringA description of the property.

ejb-jar-bnd > message-driven > resource-env-ref

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource environment reference.
binding-namestringThe binding name for the resource environment reference.

ejb-jar-bnd > message-driven > message-destination-ref

Specifies the binding for a message destination reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the message destination reference.
binding-namestringThe binding name for the message destination reference.

ejb-jar-bnd > message-driven > data-source

Specifies the binding for a data source.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe data source name.
binding-namestringThe data source binding name.

ejb-jar-bnd > message-driven > env-entry

Specifies the binding for an environment entry.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the environment entry.
valuestringThe value of the environment entry.
binding-namestringThe binding name for the environment entry.

ejb-jar-bnd > message-driven > jca-adapter

Defines a JCA adapter for a message driven bean.

NameTypeDefaultDescription
activation-spec-binding-namestringSpecifies the binding name for an activation specification.
activation-spec-auth-aliasstringSpecifies the authentication alias for an activation specification.
destination-binding-namestringSpecifies the destination binding name for a JCA adapter.

ejb-jar-bnd > interceptor

Binding properties for interceptors.

NameTypeDefaultDescription
idstringA unique configuration ID.
classstringThe class name for the interceptor.

ejb-jar-bnd > interceptor > ejb-ref

Specifies the binding for an EJB Reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the EJB reference.
binding-namestringThe binding name for the EJB reference.

ejb-jar-bnd > interceptor > resource-ref

Specifies the binding for a resource reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource reference.
binding-namestringThe binding name for the resource reference.

ejb-jar-bnd > interceptor > resource-ref > authentication-alias

The authentication alias for the resource reference.

NameTypeDefaultDescription
nameRefA reference to top level authData element (string).The authentication alias name.

ejb-jar-bnd > interceptor > resource-ref > authentication-alias > name

The authentication alias name.

NameTypeDefaultDescription
userstringName of the user to use when connecting to the EIS.
passwordReversably encoded password (string)Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

ejb-jar-bnd > interceptor > resource-ref > custom-login-configuration

Specifies custom login configuration properties.

NameTypeDefaultDescription
namestringA name for the custom login configuration.

ejb-jar-bnd > interceptor > resource-ref > custom-login-configuration > property

Defines a property for a custom login configuration.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the property.
valuestringThe value of the property.
descriptionstringA description of the property.

ejb-jar-bnd > interceptor > resource-env-ref

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource environment reference.
binding-namestringThe binding name for the resource environment reference.

ejb-jar-bnd > interceptor > message-destination-ref

Specifies the binding for a message destination reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the message destination reference.
binding-namestringThe binding name for the message destination reference.

ejb-jar-bnd > interceptor > data-source

Specifies the binding for a data source.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe data source name.
binding-namestringThe data source binding name.

ejb-jar-bnd > interceptor > env-entry

Specifies the binding for an environment entry.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the environment entry.
valuestringThe value of the environment entry.
binding-namestringThe binding name for the environment entry.

ejb-jar-bnd > message-destination

Binding properties for message destinations.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the message destination.
binding-namestringThe binding name of the message destination.

application-ext

Defines properties to extend applications.

NameTypeDefaultDescription
shared-session-contextbooleanIndicates whether the session context is shared between modules.

web-ext

Extension properties for web applications.

NameTypeDefaultDescription
moduleNamestringThe module name specifies the individual module that the binding or extension configuration applies to.
default-error-pagestringSpecifies a page to be used as the default error page for a web application.
context-rootstringDefines the context root for a web application.
autoload-filtersbooleanDetermines whether filters are loaded automatially.
auto-encode-requestsbooleanDetermines whether requests are automatically encoded.
auto-encode-responsesbooleanDetermines whether responses are automatically encoded.
enable-directory-browsingbooleanSpecifies whether directory browsing is enabled for this web application.
enable-file-servingbooleanSpecifies whether file serving is enabled for this web application.
pre-compile-jspsbooleanSpecifies whether JSP pages are compiled when the web application starts.
enable-serving-servlets-by-class-namebooleanEnables serving servlets by classname.

web-ext > file-serving-attribute

Specifies whether the web application allows files to be served.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe attribute name.
valuestringThe attribute value.

web-ext > invoker-attribute

Specifies attributes for an invoker.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe attribute name.
valuestringThe attribute value.

web-ext > jsp-attribute

Specifies attributes that affect JSP behavior.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe attribute name.
valuestringThe attribute value.

web-ext > mime-filter

Properties for a MIME filter.

NameTypeDefaultDescription
idstringA unique configuration ID.
targetstringThe target for the mime filter.
mime-typestringThe type for the mime filter.

web-ext > resource-ref

Properties for a resource reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource reference.
isolation-level
  • TRANSACTION_READ_UNCOMMITTED
  • TRANSACTION_NONE
  • TRANSACTION_READ_COMMITTED
  • TRANSACTION_SERIALIZABLE
  • TRANSACTION_REPEATABLE_READ
Defines the transaction isolation level.
TRANSACTION_READ_UNCOMMITTED
TRANSACTION_READ_UNCOMMITTED
TRANSACTION_NONE
TRANSACTION_NONE
TRANSACTION_READ_COMMITTED
TRANSACTION_READ_COMMITTED
TRANSACTION_SERIALIZABLE
TRANSACTION_SERIALIZABLE
TRANSACTION_REPEATABLE_READ
TRANSACTION_REPEATABLE_READ
commit-priorityint0Defines the commit priority for the resource reference.
branch-coupling
  • LOOSE
  • TIGHT
Specifies whether loose or tight coupling is used.
LOOSE
LOOSE
TIGHT
TIGHT

ejb-jar-ext

Extension properties for EJB applications.

NameTypeDefaultDescription
moduleNamestringThe module name specifies the individual module that the binding or extension configuration applies to.

ejb-jar-ext > session

Extension properties for session beans.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the enterprise bean.

ejb-jar-ext > session > bean-cache

Cache settings for an EJB.

NameTypeDefaultDescription
activation-policy
  • ONCE
  • TRANSACTION
Specifies the point at which an EJB is placed in the cache.
ONCE
ONCE
TRANSACTION
TRANSACTION

ejb-jar-ext > session > local-transaction

Specifies local transactions for this enterprise bean.

NameTypeDefaultDescription
resolver
  • APPLICATION
  • CONTAINER_AT_BOUNDARY
Defines a resolver for the local transaction. The value can be either APPLICATION or CONTAINER_AT_BOUNDARY.
APPLICATION
APPLICATION
CONTAINER_AT_BOUNDARY
CONTAINER_AT_BOUNDARY
unresolved-action
  • COMMIT
  • ROLLBACK
Defines the behavor for unresolved actions. The value can be either ROLLBACK or COMMIT.
COMMIT
COMMIT
ROLLBACK
ROLLBACK
shareablebooleanfalseDefines whether the local transaction is shareable.

ejb-jar-ext > session > global-transaction

Specifies global transactions for this enterprise bean.

NameTypeDefaultDescription
send-wsat-contextbooleanfalseDetermines whether to send the web services atomic transaction on outgoing requests.
transaction-time-outint0Specifies the timeout for the global transaction.

ejb-jar-ext > session > resource-ref

Specifies resource references for this enterprise bean.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource reference.
isolation-level
  • TRANSACTION_READ_UNCOMMITTED
  • TRANSACTION_NONE
  • TRANSACTION_READ_COMMITTED
  • TRANSACTION_SERIALIZABLE
  • TRANSACTION_REPEATABLE_READ
Defines the transaction isolation level.
TRANSACTION_READ_UNCOMMITTED
TRANSACTION_READ_UNCOMMITTED
TRANSACTION_NONE
TRANSACTION_NONE
TRANSACTION_READ_COMMITTED
TRANSACTION_READ_COMMITTED
TRANSACTION_SERIALIZABLE
TRANSACTION_SERIALIZABLE
TRANSACTION_REPEATABLE_READ
TRANSACTION_REPEATABLE_READ
commit-priorityint0Defines the commit priority for the resource reference.
branch-coupling
  • LOOSE
  • TIGHT
Specifies whether loose or tight coupling is used.
LOOSE
LOOSE
TIGHT
TIGHT

ejb-jar-ext > session > start-at-app-start

Controls whether the bean starts at application start.

NameTypeDefaultDescription
valuebooleanfalseThe value of the start at application start property.

ejb-jar-ext > session > time-out

Specifies a time out value for the session bean.

NameTypeDefaultDescription
valueA period of time with second precision0The value for the time out. 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. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

ejb-jar-ext > message-driven

Extension properties for message driven beans.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the enterprise bean.

ejb-jar-ext > message-driven > bean-cache

Cache settings for an EJB.

NameTypeDefaultDescription
activation-policy
  • ONCE
  • TRANSACTION
Specifies the point at which an EJB is placed in the cache.
ONCE
ONCE
TRANSACTION
TRANSACTION

ejb-jar-ext > message-driven > local-transaction

Specifies local transactions for this enterprise bean.

NameTypeDefaultDescription
resolver
  • APPLICATION
  • CONTAINER_AT_BOUNDARY
Defines a resolver for the local transaction. The value can be either APPLICATION or CONTAINER_AT_BOUNDARY.
APPLICATION
APPLICATION
CONTAINER_AT_BOUNDARY
CONTAINER_AT_BOUNDARY
unresolved-action
  • COMMIT
  • ROLLBACK
Defines the behavor for unresolved actions. The value can be either ROLLBACK or COMMIT.
COMMIT
COMMIT
ROLLBACK
ROLLBACK
shareablebooleanfalseDefines whether the local transaction is shareable.

ejb-jar-ext > message-driven > global-transaction

Specifies global transactions for this enterprise bean.

NameTypeDefaultDescription
send-wsat-contextbooleanfalseDetermines whether to send the web services atomic transaction on outgoing requests.
transaction-time-outint0Specifies the timeout for the global transaction.

ejb-jar-ext > message-driven > resource-ref

Specifies resource references for this enterprise bean.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource reference.
isolation-level
  • TRANSACTION_READ_UNCOMMITTED
  • TRANSACTION_NONE
  • TRANSACTION_READ_COMMITTED
  • TRANSACTION_SERIALIZABLE
  • TRANSACTION_REPEATABLE_READ
Defines the transaction isolation level.
TRANSACTION_READ_UNCOMMITTED
TRANSACTION_READ_UNCOMMITTED
TRANSACTION_NONE
TRANSACTION_NONE
TRANSACTION_READ_COMMITTED
TRANSACTION_READ_COMMITTED
TRANSACTION_SERIALIZABLE
TRANSACTION_SERIALIZABLE
TRANSACTION_REPEATABLE_READ
TRANSACTION_REPEATABLE_READ
commit-priorityint0Defines the commit priority for the resource reference.
branch-coupling
  • LOOSE
  • TIGHT
Specifies whether loose or tight coupling is used.
LOOSE
LOOSE
TIGHT
TIGHT

ejb-jar-ext > message-driven > start-at-app-start

Controls whether the bean starts at application start.

NameTypeDefaultDescription
valuebooleanfalseThe value of the start at application start property.

resourceAdapter

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

NameTypeDefaultDescription
aliasstring${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.
idstringIdentifies the name of the embedded resource adapter module to which this configuration applies.
autoStartbooleanConfigures whether a resource adapter starts automatically upon deployment of the resource adapter or lazily upon injection or lookup of a resource.
contextServiceRefA reference to top level contextService element (string).Configures how context is captured and propagated to threads.

resourceAdapter > contextService

Configures how context is captured and propagated to threads.

NameTypeDefaultDescription
onError
  • IGNORE
  • WARN
  • FAIL
WARNDetermines 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.
WARN
Server will issue 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.
baseContextRefA 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.
jndiNamestringJNDI name

resourceAdapter > contextService > baseContext

Specifies a base context service from which to inherit context that is not already defined on this context service.

NameTypeDefaultDescription
idstringA unique configuration ID.
onError
  • IGNORE
  • WARN
  • FAIL
WARNDetermines 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.
WARN
Server will issue 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.
baseContextRefA 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.
jndiNamestringJNDI name

resourceAdapter > contextService > baseContext > baseContext

Specifies a base context service from which to inherit context that is not already defined on this context service.

resourceAdapter > contextService > baseContext > classloaderContext

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.

resourceAdapter > contextService > baseContext > jeeMetadataContext

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.

resourceAdapter > contextService > baseContext > securityContext

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.

resourceAdapter > contextService > baseContext > syncToOSThreadContext

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.

resourceAdapter > contextService > baseContext > zosWLMContext

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.
defaultTransactionClassstringASYNCBNThe Transaction Class name provided to WLM to classify work when a new WLM context is being created for non-Daemon work.
daemonTransactionClassstringASYNCDMNThe Transaction Class name provided to WLM to classify work when a new WLM context is created for Daemon work.
wlm
  • PropagateOrNew
  • New
  • Propagate
PropagateIndicates how the WLM context should be handled for non-Daemon work.
PropagateOrNew
Use the same WLM context or create a new one if no current context exists.
New
Always create a new WLM context.
Propagate
Use the same WLM Context (if one exists).

resourceAdapter > contextService > classloaderContext

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.

resourceAdapter > contextService > jeeMetadataContext

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.

resourceAdapter > contextService > securityContext

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.

resourceAdapter > contextService > syncToOSThreadContext

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.

resourceAdapter > contextService > zosWLMContext

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.
defaultTransactionClassstringASYNCBNThe Transaction Class name provided to WLM to classify work when a new WLM context is being created for non-Daemon work.
daemonTransactionClassstringASYNCDMNThe Transaction Class name provided to WLM to classify work when a new WLM context is created for Daemon work.
wlm
  • PropagateOrNew
  • New
  • Propagate
PropagateIndicates how the WLM context should be handled for non-Daemon work.
PropagateOrNew
Use the same WLM context or create a new one if no current context exists.
New
Always create a new WLM context.
Propagate
Use the same WLM Context (if one exists).

resourceAdapter > customize

Customizes the configuration properties element for the activation specification, administered object, or connection factory with the specified interface and/or implementation class.

NameTypeDefaultDescription
implementationstringFully qualified implementation class name for which the configuration properties element should be customized.
interfacestringFully qualified interface class name for which the configuration properties element should be customized.
suffixstringOverrides 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.

webservices-bnd

Web service bindings are used to customize web services endpoints and configure security settings for both web services providers and web service clients.

webservices-bnd > webservice-endpoint

A web service endpoint is used to specify the binding for a specified service instance.

NameTypeDefaultDescription
idstringA unique configuration ID.
port-component-namestringThe port component name is used to specify the name of a port component.
addressstringAddress is used to specify the overridden address of a service endpoint.

webservices-bnd > webservice-endpoint-properties

Web service endpoint properties are used to define the default properties for all the web services endpoints in the same module.

NameTypeDefaultDescription
idstringA unique configuration ID.

webservices-bnd > http-publishing

HTTP publishing is used to specify the publishing configurations when using HTTP protocol for all the web services endpoints.

NameTypeDefaultDescription
idstringA unique configuration ID.
context-rootstringThe context root attribute is used to specify the context root of the EJB module in an EJB-based JAX-WS application.

webservices-bnd > http-publishing > webservice-security

The web service security element is used to configure role-based authorization for POJO web services and EJB-based web services.

webservices-bnd > http-publishing > webservice-security > security-constraint

Security constraint attributes are used to associate security constraints with one or more web resource collections. Security constraints only work as complementary configuration to the deployment descriptors or annotations in web applications.

webservices-bnd > http-publishing > webservice-security > security-constraint > web-resource-collection

The web resource collection element is used to identify resources for a security constraint.

NameTypeDefaultDescription
idstringA unique configuration ID.
web-resource-namestringThe name of a web resource collection

webservices-bnd > http-publishing > webservice-security > security-constraint > web-resource-collection > url-pattern

A URL pattern is used to identify a set of resources in a web resource collection.

webservices-bnd > http-publishing > webservice-security > security-constraint > web-resource-collection > http-method

Specifies the HTTP method to which a security constraint applies

webservices-bnd > http-publishing > webservice-security > security-constraint > web-resource-collection > http-method-omission

Specifies an HTTP method to which a security constraint should not apply

webservices-bnd > http-publishing > webservice-security > security-constraint > auth-constraint

The authorization constraint element is used to specify the user roles that should be permitted access a resource collection.

webservices-bnd > http-publishing > webservice-security > security-constraint > auth-constraint > role-name

The role name for an authorization constraint should correspond with the role name of a security role defined in the deployment descriptor.

webservices-bnd > http-publishing > webservice-security > security-constraint > user-data-constraint

The user data constraint element is used to define how data communicated between the client and a container should be protected.

NameTypeDefaultDescription
transport-guaranteeintThe transport guarantee specifies how communication between the client and should take place. If the value is INTEGRAL, the application requires that the data should not change in transit. If the value is CONFIDENTIAL, data should be confidential in transit. The value of NONE indicates that there is not transport guarantee.

webservices-bnd > http-publishing > webservice-security > login-config

A login configuration attribute is used to configure the authentication method and realm name, and takes effect only for the EJB-based web services in a JAR file. If the same attribute is specified in the deployment descriptor file, the value from the deployment descriptor is used.

NameTypeDefaultDescription
auth-methodstringThe authorization method is used to configure the authentication mechanism for a web application.
realm-namestringThe realm name element specifies the realm name to use in HTTP Basic authorization

webservices-bnd > http-publishing > webservice-security > login-config > form-login-config

The form login configuration element specifies the login and error pages that should be used in form based login. If form based authentication is not used, these elements are ignored.

NameTypeDefaultDescription
form-login-pagestringThe form login page element defines the location in the web app where the page that can be used for login can be found. The path begins with a leading / and is interpreted relative to the root of the WAR.
form-error-pagestringThe form-error-page element defines the location in the web app where the error page that is displayed when login is not successful can be found. The path begins with a leading / and is interpreted relative to the root of the WAR.

webservices-bnd > http-publishing > webservice-security > security-role

A security role attribute contains the definition of a security role. It only works as complementary configuration to the deployment descriptors or annotations in web applications.

NameTypeDefaultDescription
role-namestringThe role name for an authorization constraint should correspond with the role name of a security role defined in the deployment descriptor.

webservices-bnd > service-ref

The service reference element is used to define the web services reference configurations for a web services client.

NameTypeDefaultDescription
idstringA unique configuration ID.
port-addressstringThe port address attribute is used to specify the address of the web services port if the referenced web services has only one port.
namestringThe name attribute is used to specify the name of a web services reference.
component-namestringThe component name attribute is used to specify the EJB bean name if the service reference is used in an EJB module.
wsdl-locationstringThe WSDL location attribute is used to specify the URL of a WSDL location to be overridden.

webservices-bnd > service-ref > port

The port element is used to define port configurations that are associated with the web services reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe port name is used to specify the name of the web services port.
namespacestringThe namespace attribute is used to specify the namespace of the web services port. The binding is applied to the port that has the same name and namespace. Otherwise, the binding is applied to the port that has the same name.
addressstringThe address attribute is used to specify the address for the web services port and override the value of port-address attribute that is defined in the service-ref element.
usernamestringThe user name attribute is used to specify the user name for basic authentication.
passwordReversably encoded password (string)The password attribute is used to specify the password for basic authentication. The password can be encoded.
ssl-refstringThe SSL reference attribute refers to an ssl element defined in the server.xml file. If the attribute is not specified but the server supports transport level security the service client uses the default SSL configuration.
key-aliasstringThe key alias attribute is used to specify the alias of a client certificate. If the attribute is not specified and the web service provider supports the client certificate then the first certificate in the keystore is used as the value of this attribute. The attribute can also override the clientKeyAlias attribute that is defined in the ssl element of the server.xml file.

webservices-bnd > service-ref > port > properties

The properties element is used to define the properties for a web services endpoint or client. The attributes can have any name and any value.

webservices-bnd > service-ref > properties

The properties element is used to define the properties for a web services endpoint or client. The attributes can have any name and any value.

managed-bean-bnd

Specifies the bindings for a managed bean.

NameTypeDefaultDescription
moduleNamestringThe module name specifies the individual module that the binding or extension configuration applies to.

managed-bean-bnd > interceptor

Defines interceptors for the managed bean binding.

NameTypeDefaultDescription
idstringA unique configuration ID.
classstringThe class name for the interceptor.

managed-bean-bnd > interceptor > ejb-ref

Specifies the binding for an EJB Reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the EJB reference.
binding-namestringThe binding name for the EJB reference.

managed-bean-bnd > interceptor > resource-ref

Specifies the binding for a resource reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource reference.
binding-namestringThe binding name for the resource reference.

managed-bean-bnd > interceptor > resource-ref > authentication-alias

The authentication alias for the resource reference.

NameTypeDefaultDescription
nameRefA reference to top level authData element (string).The authentication alias name.

managed-bean-bnd > interceptor > resource-ref > authentication-alias > name

The authentication alias name.

NameTypeDefaultDescription
userstringName of the user to use when connecting to the EIS.
passwordReversably encoded password (string)Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

managed-bean-bnd > interceptor > resource-ref > custom-login-configuration

Specifies custom login configuration properties.

NameTypeDefaultDescription
namestringA name for the custom login configuration.

managed-bean-bnd > interceptor > resource-ref > custom-login-configuration > property

Defines a property for a custom login configuration.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the property.
valuestringThe value of the property.
descriptionstringA description of the property.

managed-bean-bnd > interceptor > resource-env-ref

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource environment reference.
binding-namestringThe binding name for the resource environment reference.

managed-bean-bnd > interceptor > message-destination-ref

Specifies the binding for a message destination reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the message destination reference.
binding-namestringThe binding name for the message destination reference.

managed-bean-bnd > interceptor > data-source

Specifies the binding for a data source.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe data source name.
binding-namestringThe data source binding name.

managed-bean-bnd > interceptor > env-entry

Specifies the binding for an environment entry.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the environment entry.
valuestringThe value of the environment entry.
binding-namestringThe binding name for the environment entry.

managed-bean-bnd > managed-bean

Specifies the managed bean for this binding.

NameTypeDefaultDescription
idstringA unique configuration ID.
classstringSpecifies the class name for a managed bean.

managed-bean-bnd > managed-bean > ejb-ref

Specifies the binding for an EJB Reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the EJB reference.
binding-namestringThe binding name for the EJB reference.

managed-bean-bnd > managed-bean > resource-ref

Specifies the binding for a resource reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource reference.
binding-namestringThe binding name for the resource reference.

managed-bean-bnd > managed-bean > resource-ref > authentication-alias

The authentication alias for the resource reference.

NameTypeDefaultDescription
nameRefA reference to top level authData element (string).The authentication alias name.

managed-bean-bnd > managed-bean > resource-ref > authentication-alias > name

The authentication alias name.

NameTypeDefaultDescription
userstringName of the user to use when connecting to the EIS.
passwordReversably encoded password (string)Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

managed-bean-bnd > managed-bean > resource-ref > custom-login-configuration

Specifies custom login configuration properties.

NameTypeDefaultDescription
namestringA name for the custom login configuration.

managed-bean-bnd > managed-bean > resource-ref > custom-login-configuration > property

Defines a property for a custom login configuration.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the property.
valuestringThe value of the property.
descriptionstringA description of the property.

managed-bean-bnd > managed-bean > resource-env-ref

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the resource environment reference.
binding-namestringThe binding name for the resource environment reference.

managed-bean-bnd > managed-bean > message-destination-ref

Specifies the binding for a message destination reference.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name for the message destination reference.
binding-namestringThe binding name for the message destination reference.

managed-bean-bnd > managed-bean > data-source

Specifies the binding for a data source.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe data source name.
binding-namestringThe data source binding name.

managed-bean-bnd > managed-bean > env-entry

Specifies the binding for an environment entry.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the environment entry.
valuestringThe value of the environment entry.
binding-namestringThe binding name for the environment entry.