Spring Boot Application (springBootApplication)

Defines the properties of a Spring Boot application.

NameTypeDefaultDescription

applicationArgument

string

Defines an application argument which is passed to the main method of the start class for a Spring Boot application.

autoStart

boolean

true

Indicates whether or not the server automatically starts the application.

classloaderRef

A reference to top level classloader element (string).

Defines the settings for an application classloader.

id

string

A unique configuration ID.

location

A file, directory or url.
Required

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.

startAfterRef

List of references to top level application elements (comma-separated string).

Specifies applications that are required to start before this application can begin starting.

classloader

Defines the settings for an application classloader.

NameTypeDefaultDescription

apiTypeVisibility

string

spec,ibm-api,api,stable

The 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. If a prefix of + or - is added to API types, those API types are added or removed, respectively, from the default set of API types. Common usage for the prefix, +third-party, results in "spec, ibm-api, api, stable, third-party". The prefix, -api, results in "spec, ibm-api, stable".

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.

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 > classProvider

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.

NameTypeDefaultDescription

autoStart

boolean

Configures whether a resource adapter starts automatically upon deployment of the resource adapter or lazily upon injection or lookup of a resource.

classloaderRef

A reference to top level classloader element (string).

Defines the settings for an application classloader.

id

string

A unique configuration ID.

location

A file, directory or url.
Required

Defines the path of the RAR file to install.

useJandex

boolean

Enables use of Jandex index files if they are supplied in the application

classloader > classProvider > appProperties

Provides custom properties to an application.

classloader > classProvider > appProperties > property

Provides a specific custom property to an application.

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string

Provides name of the application scoped property.

value

string

Provides value of the application scoped property.

classloader > classProvider > customize

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

NameTypeDefaultDescription

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.

classloader > classProvider > web-ext

Extension properties for web applications.

NameTypeDefaultDescription

auto-encode-requests

boolean

Determines whether requests are automatically encoded.

auto-encode-responses

boolean

Determines whether responses are automatically encoded.

autoload-filters

boolean

Determines whether filters are loaded automatially.

context-root

string

Defines the context root for a web application.

default-error-page

string

Specifies a page to be used as the default error page for a web application.

enable-directory-browsing

boolean

Specifies whether directory browsing is enabled for this web application.

enable-file-serving

boolean

Specifies whether file serving is enabled for this web application.

enable-serving-servlets-by-class-name

boolean

Enables serving servlets by classname.

moduleName

string

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

pre-compile-jsps

boolean

Specifies whether JSP pages are compiled when the web application starts.

classloader > classProvider > web-ext > file-serving-attribute

Specifies whether the web application allows files to be served.

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string

The attribute name.

value

string

The attribute value.

classloader > classProvider > web-ext > invoker-attribute

Specifies attributes for an invoker.

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string

The attribute name.

value

string

The attribute value.

classloader > classProvider > web-ext > jsp-attribute

Specifies attributes that affect JSP behavior.

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string

The attribute name.

value

string

The attribute value.

classloader > classProvider > web-ext > mime-filter

Properties for a MIME filter.

NameTypeDefaultDescription

id

string

A unique configuration ID.

mime-type

string

The type for the mime filter.

target

string

The target for the mime filter.

classloader > classProvider > web-ext > resource-ref

Properties for a resource reference.

NameTypeDefaultDescription

branch-coupling

  • LOOSE

  • TIGHT

Specifies whether loose or tight coupling is used.

commit-priority

int

0

Defines the commit priority for the resource reference.

id

string

A unique configuration ID.

isolation-level

  • TRANSACTION_NONE

  • TRANSACTION_READ_COMMITTED

  • TRANSACTION_READ_UNCOMMITTED

  • TRANSACTION_REPEATABLE_READ

  • TRANSACTION_SERIALIZABLE

Defines the transaction isolation level.

name

string

The name for the resource reference.

classloader > classProvider > 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.

classloader > classProvider > webservices-bnd > http-publishing

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

NameTypeDefaultDescription

context-root

string

The context root attribute is used to specify the context root of the EJB module in an EJB-based JAX-WS application.

id

string

A unique configuration ID.

classloader > classProvider > 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.

classloader > classProvider > 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-method

string

The authorization method is used to configure the authentication mechanism for a web application.

realm-name

string

The realm name element specifies the realm name to use in HTTP Basic authorization

classloader > classProvider > 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-error-page

string

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

form-login-page

string

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

classloader > classProvider > 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.

classloader > classProvider > 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.

NameTypeDefaultDescription

role-name

string
This is specified as a child element rather than as an XML attribute.

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

classloader > classProvider > 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-guarantee

int

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

classloader > classProvider > 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

http-method

string

Specifies the HTTP method to which a security constraint applies

http-method-omission

string

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

id

string

A unique configuration ID.

url-pattern

string

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

web-resource-name

string

The name of a web resource collection

classloader > classProvider > 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-name

string

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

classloader > classProvider > webservices-bnd > service-ref

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

NameTypeDefaultDescription

component-name

string

The component name attribute is used to specify the EJB bean name if the service reference is used in an EJB module.

id

string

A unique configuration ID.

name

string

The name attribute is used to specify the name of a web services reference.

port-address

string

The port address attribute is used to specify the address of the web services port if the referenced web services has only one port.

wsdl-location

string

The WSDL location attribute is used to specify the URL of a WSDL location to be overridden.

classloader > classProvider > webservices-bnd > service-ref > port

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

NameTypeDefaultDescription

address

string

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

id

string

A unique configuration ID.

key-alias

string

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

name

string

The port name is used to specify the name of the web services port.

namespace

string

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

password

Reversably encoded password (string)

The password attribute is used to specify the password for basic authentication. The password can be encoded.

ssl-ref

string

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

username

string

The user name attribute is used to specify the user name for basic authentication.

classloader > classProvider > 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.

classloader > classProvider > 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.

classloader > classProvider > webservices-bnd > webservice-endpoint

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

NameTypeDefaultDescription

address

string

Address is used to specify the overridden address of a service endpoint.

id

string

A unique configuration ID.

port-component-name

string

The port component name is used to specify the name of a port component.

classloader > classProvider > 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

id

string

A unique configuration ID.

classloader > commonLibrary

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

NameTypeDefaultDescription

apiTypeVisibility

string

spec,ibm-api,api,stable

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

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

Id of referenced File

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

Path to a file
Required

Fully qualified filename

classloader > commonLibrary > fileset

Id of referenced Fileset

NameTypeDefaultDescription

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

Id of referenced folder

NameTypeDefaultDescription

dir

Path to a directory
Required

Directory or folder to be included in the library classpath for locating resource files

id

string

A unique configuration ID.

classloader > privateLibrary

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

NameTypeDefaultDescription

apiTypeVisibility

string

spec,ibm-api,api,stable

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

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

Id of referenced File

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

Path to a file
Required

Fully qualified filename

classloader > privateLibrary > fileset

Id of referenced Fileset

NameTypeDefaultDescription

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

Id of referenced folder

NameTypeDefaultDescription

dir

Path to a directory
Required

Directory or folder to be included in the library classpath for locating resource files

id

string

A unique configuration ID.

startAfter

Specifies applications that are required to start before this application can begin starting.

NameTypeDefaultDescription

autoStart

boolean

true

Indicates whether or not the server automatically starts the application.

classloaderRef

A reference to top level classloader element (string).

Defines the settings for an application classloader.

context-root

string

Context root of an application.

id

string

A unique configuration ID.

location

A file, directory or url.
Required

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.

startAfterRef

List of references to top level application elements (comma-separated string).

Specifies applications that are required to start before this application can begin starting.

type

string

Type of application archive.

useJandex

boolean

Enables use of Jandex index files if they are supplied in the application

startAfter > appProperties

Provides custom properties to an application.

startAfter > appProperties > property

Provides a specific custom property to an application.

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string

Provides name of the application scoped property.

value

string

Provides value of the application scoped property.

startAfter > application-bnd

Defines properties that apply to application bindings.

startAfter > application-bnd > data-source

Specifies the binding for a data source.

NameTypeDefaultDescription

binding-name

string

The data source binding name.

id

string

A unique configuration ID.

name

string

The data source name.

startAfter > application-bnd > ejb-ref

Specifies the binding for an EJB Reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the EJB reference.

id

string

A unique configuration ID.

name

string

The name for the EJB reference.

startAfter > application-bnd > env-entry

Specifies the binding for an environment entry.

NameTypeDefaultDescription

binding-name

string

The binding name for the environment entry.

id

string

A unique configuration ID.

name

string

The name of the environment entry.

value

string

The value of the environment entry.

startAfter > application-bnd > message-destination-ref

Specifies the binding for a message destination reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the message destination reference.

id

string

A unique configuration ID.

name

string

The name for the message destination reference.

startAfter > application-bnd > resource-env-ref

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource environment reference.

id

string

A unique configuration ID.

name

string

The name for the resource environment reference.

startAfter > application-bnd > resource-ref

Specifies the binding for a resource reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource reference.

id

string

A unique configuration ID.

name

string

The name for the resource reference.

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

The authentication alias for the resource reference.

NameTypeDefaultDescription

nameRef

A reference to top level authData element (string).

The authentication alias name.

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

The authentication alias name.

NameTypeDefaultDescription

krb5Principal

string

The name of the Kerberos principal name or Kerberos service name to be used.

krb5TicketCache

Path to a file

The file location where Kerberos credentials for the Kerberos principal name or service name will be stored. Also known as the Kerberos credential cache (ccache)

password

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

user

string

Name of the user to use when connecting to the EIS.

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

Specifies custom login configuration properties.

NameTypeDefaultDescription

name

string

A name for the custom login configuration.

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

Defines a property for a custom login configuration.

NameTypeDefaultDescription

description

string

A description of the property.

id

string

A unique configuration ID.

name

string

The name of the property.

value

string

The value of the property.

startAfter > application-bnd > security-role

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

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string

The name for a security role.

startAfter > application-bnd > security-role > group

The group for a security role.

NameTypeDefaultDescription

access-id

string

The access ID for a subject.

id

string

A unique configuration ID.

name

string

The name for the subject.

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

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

NameTypeDefaultDescription

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.

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

Name of a special subject possessing a security role.

NameTypeDefaultDescription

id

string

A unique configuration ID.

type

  • ALL_AUTHENTICATED_USERS

  • EVERYONE

One of the following special subject types: ALL_AUTHENTICATED_USERS, EVERYONE.

startAfter > application-bnd > security-role > user

The user for a security role.

NameTypeDefaultDescription

access-id

string

The access ID for a subject.

id

string

A unique configuration ID.

name

string

The name for the subject.

startAfter > application-client-bnd

Defines properties that apply to application clients.

startAfter > application-client-bnd > data-source

Defines a data source for an application client.

NameTypeDefaultDescription

binding-name

string

The data source binding name.

id

string

A unique configuration ID.

name

string

The data source name.

startAfter > application-client-bnd > ejb-ref

EJB References in an application client.

NameTypeDefaultDescription

binding-name

string

The binding name for the EJB reference.

id

string

A unique configuration ID.

name

string

The name for the EJB reference.

startAfter > application-client-bnd > env-entry

Defines an environment entry for an application client.

NameTypeDefaultDescription

binding-name

string

The binding name for the environment entry.

id

string

A unique configuration ID.

name

string

The name of the environment entry.

value

string

The value of the environment entry.

startAfter > application-client-bnd > message-destination-ref

Message destination reference in an application client.

NameTypeDefaultDescription

binding-name

string

The binding name for the message destination reference.

id

string

A unique configuration ID.

name

string

The name for the message destination reference.

startAfter > application-client-bnd > resource-env-ref

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource environment reference.

id

string

A unique configuration ID.

name

string

The name for the resource environment reference.

startAfter > application-client-bnd > resource-ref

Resource references in an application client.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource reference.

id

string

A unique configuration ID.

name

string

The name for the resource reference.

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

The authentication alias for the resource reference.

NameTypeDefaultDescription

nameRef

A reference to top level authData element (string).

The authentication alias name.

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

The authentication alias name.

NameTypeDefaultDescription

krb5Principal

string

The name of the Kerberos principal name or Kerberos service name to be used.

krb5TicketCache

Path to a file

The file location where Kerberos credentials for the Kerberos principal name or service name will be stored. Also known as the Kerberos credential cache (ccache)

password

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

user

string

Name of the user to use when connecting to the EIS.

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

Specifies custom login configuration properties.

NameTypeDefaultDescription

name

string

A name for the custom login configuration.

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

Defines a property for a custom login configuration.

NameTypeDefaultDescription

description

string

A description of the property.

id

string

A unique configuration ID.

name

string

The name of the property.

value

string

The value of the property.

startAfter > application-ext

Defines properties to extend applications.

NameTypeDefaultDescription

shared-session-context

boolean

Indicates whether the session context is shared between modules.

startAfter > classloader

Defines the settings for an application classloader.

NameTypeDefaultDescription

apiTypeVisibility

string

spec,ibm-api,api,stable

The 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. If a prefix of + or - is added to API types, those API types are added or removed, respectively, from the default set of API types. Common usage for the prefix, +third-party, results in "spec, ibm-api, api, stable, third-party". The prefix, -api, results in "spec, ibm-api, stable".

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.

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.

startAfter > classloader > classProvider

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.

NameTypeDefaultDescription

autoStart

boolean

Configures whether a resource adapter starts automatically upon deployment of the resource adapter or lazily upon injection or lookup of a resource.

classloaderRef

A reference to top level classloader element (string).

Defines the settings for an application classloader.

id

string

A unique configuration ID.

location

A file, directory or url.
Required

Defines the path of the RAR file to install.

useJandex

boolean

Enables use of Jandex index files if they are supplied in the application

startAfter > classloader > classProvider > appProperties

Provides custom properties to an application.

startAfter > classloader > classProvider > appProperties > property

Provides a specific custom property to an application.

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string

Provides name of the application scoped property.

value

string

Provides value of the application scoped property.

startAfter > classloader > classProvider > customize

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

NameTypeDefaultDescription

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.

startAfter > classloader > classProvider > web-ext

Extension properties for web applications.

NameTypeDefaultDescription

auto-encode-requests

boolean

Determines whether requests are automatically encoded.

auto-encode-responses

boolean

Determines whether responses are automatically encoded.

autoload-filters

boolean

Determines whether filters are loaded automatially.

context-root

string

Defines the context root for a web application.

default-error-page

string

Specifies a page to be used as the default error page for a web application.

enable-directory-browsing

boolean

Specifies whether directory browsing is enabled for this web application.

enable-file-serving

boolean

Specifies whether file serving is enabled for this web application.

enable-serving-servlets-by-class-name

boolean

Enables serving servlets by classname.

moduleName

string

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

pre-compile-jsps

boolean

Specifies whether JSP pages are compiled when the web application starts.

startAfter > classloader > classProvider > web-ext > file-serving-attribute

Specifies whether the web application allows files to be served.

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string

The attribute name.

value

string

The attribute value.

startAfter > classloader > classProvider > web-ext > invoker-attribute

Specifies attributes for an invoker.

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string

The attribute name.

value

string

The attribute value.

startAfter > classloader > classProvider > web-ext > jsp-attribute

Specifies attributes that affect JSP behavior.

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string

The attribute name.

value

string

The attribute value.

startAfter > classloader > classProvider > web-ext > mime-filter

Properties for a MIME filter.

NameTypeDefaultDescription

id

string

A unique configuration ID.

mime-type

string

The type for the mime filter.

target

string

The target for the mime filter.

startAfter > classloader > classProvider > web-ext > resource-ref

Properties for a resource reference.

NameTypeDefaultDescription

branch-coupling

  • LOOSE

  • TIGHT

Specifies whether loose or tight coupling is used.

commit-priority

int

0

Defines the commit priority for the resource reference.

id

string

A unique configuration ID.

isolation-level

  • TRANSACTION_NONE

  • TRANSACTION_READ_COMMITTED

  • TRANSACTION_READ_UNCOMMITTED

  • TRANSACTION_REPEATABLE_READ

  • TRANSACTION_SERIALIZABLE

Defines the transaction isolation level.

name

string

The name for the resource reference.

startAfter > classloader > classProvider > 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.

startAfter > classloader > classProvider > webservices-bnd > http-publishing

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

NameTypeDefaultDescription

context-root

string

The context root attribute is used to specify the context root of the EJB module in an EJB-based JAX-WS application.

id

string

A unique configuration ID.

startAfter > classloader > classProvider > 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.

startAfter > classloader > classProvider > 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-method

string

The authorization method is used to configure the authentication mechanism for a web application.

realm-name

string

The realm name element specifies the realm name to use in HTTP Basic authorization

startAfter > classloader > classProvider > 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-error-page

string

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

form-login-page

string

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

startAfter > classloader > classProvider > 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.

startAfter > classloader > classProvider > 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.

NameTypeDefaultDescription

role-name

string
This is specified as a child element rather than as an XML attribute.

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

startAfter > classloader > classProvider > 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-guarantee

int

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

startAfter > classloader > classProvider > 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

http-method

string

Specifies the HTTP method to which a security constraint applies

http-method-omission

string

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

id

string

A unique configuration ID.

url-pattern

string

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

web-resource-name

string

The name of a web resource collection

startAfter > classloader > classProvider > 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-name

string

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

startAfter > classloader > classProvider > webservices-bnd > service-ref

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

NameTypeDefaultDescription

component-name

string

The component name attribute is used to specify the EJB bean name if the service reference is used in an EJB module.

id

string

A unique configuration ID.

name

string

The name attribute is used to specify the name of a web services reference.

port-address

string

The port address attribute is used to specify the address of the web services port if the referenced web services has only one port.

wsdl-location

string

The WSDL location attribute is used to specify the URL of a WSDL location to be overridden.

startAfter > classloader > classProvider > webservices-bnd > service-ref > port

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

NameTypeDefaultDescription

address

string

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

id

string

A unique configuration ID.

key-alias

string

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

name

string

The port name is used to specify the name of the web services port.

namespace

string

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

password

Reversably encoded password (string)

The password attribute is used to specify the password for basic authentication. The password can be encoded.

ssl-ref

string

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

username

string

The user name attribute is used to specify the user name for basic authentication.

startAfter > classloader > classProvider > 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.

startAfter > classloader > classProvider > 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.

startAfter > classloader > classProvider > webservices-bnd > webservice-endpoint

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

NameTypeDefaultDescription

address

string

Address is used to specify the overridden address of a service endpoint.

id

string

A unique configuration ID.

port-component-name

string

The port component name is used to specify the name of a port component.

startAfter > classloader > classProvider > 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

id

string

A unique configuration ID.

startAfter > classloader > commonLibrary

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

NameTypeDefaultDescription

apiTypeVisibility

string

spec,ibm-api,api,stable

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

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

startAfter > classloader > commonLibrary > file

Id of referenced File

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

Path to a file
Required

Fully qualified filename

startAfter > classloader > commonLibrary > fileset

Id of referenced Fileset

NameTypeDefaultDescription

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.

startAfter > classloader > commonLibrary > folder

Id of referenced folder

NameTypeDefaultDescription

dir

Path to a directory
Required

Directory or folder to be included in the library classpath for locating resource files

id

string

A unique configuration ID.

startAfter > classloader > privateLibrary

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

NameTypeDefaultDescription

apiTypeVisibility

string

spec,ibm-api,api,stable

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

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

startAfter > classloader > privateLibrary > file

Id of referenced File

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

Path to a file
Required

Fully qualified filename

startAfter > classloader > privateLibrary > fileset

Id of referenced Fileset

NameTypeDefaultDescription

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.

startAfter > classloader > privateLibrary > folder

Id of referenced folder

NameTypeDefaultDescription

dir

Path to a directory
Required

Directory or folder to be included in the library classpath for locating resource files

id

string

A unique configuration ID.

startAfter > ejb-jar-bnd

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

NameTypeDefaultDescription

moduleName

string

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

startAfter > ejb-jar-bnd > interceptor

Binding properties for interceptors.

NameTypeDefaultDescription

class

string

The class name for the interceptor.

id

string

A unique configuration ID.

startAfter > ejb-jar-bnd > interceptor > data-source

Specifies the binding for a data source.

NameTypeDefaultDescription

binding-name

string

The data source binding name.

id

string

A unique configuration ID.

name

string

The data source name.

startAfter > ejb-jar-bnd > interceptor > ejb-ref

Specifies the binding for an EJB Reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the EJB reference.

id

string

A unique configuration ID.

name

string

The name for the EJB reference.

startAfter > ejb-jar-bnd > interceptor > env-entry

Specifies the binding for an environment entry.

NameTypeDefaultDescription

binding-name

string

The binding name for the environment entry.

id

string

A unique configuration ID.

name

string

The name of the environment entry.

value

string

The value of the environment entry.

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

Specifies the binding for a message destination reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the message destination reference.

id

string

A unique configuration ID.

name

string

The name for the message destination reference.

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

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource environment reference.

id

string

A unique configuration ID.

name

string

The name for the resource environment reference.

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

Specifies the binding for a resource reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource reference.

id

string

A unique configuration ID.

name

string

The name for the resource reference.

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

The authentication alias for the resource reference.

NameTypeDefaultDescription

nameRef

A reference to top level authData element (string).

The authentication alias name.

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

The authentication alias name.

NameTypeDefaultDescription

krb5Principal

string

The name of the Kerberos principal name or Kerberos service name to be used.

krb5TicketCache

Path to a file

The file location where Kerberos credentials for the Kerberos principal name or service name will be stored. Also known as the Kerberos credential cache (ccache)

password

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

user

string

Name of the user to use when connecting to the EIS.

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

Specifies custom login configuration properties.

NameTypeDefaultDescription

name

string

A name for the custom login configuration.

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

Defines a property for a custom login configuration.

NameTypeDefaultDescription

description

string

A description of the property.

id

string

A unique configuration ID.

name

string

The name of the property.

value

string

The value of the property.

startAfter > ejb-jar-bnd > message-destination

Binding properties for message destinations.

NameTypeDefaultDescription

binding-name

string

The binding name of the message destination.

id

string

A unique configuration ID.

name

string

The name of the message destination.

startAfter > ejb-jar-bnd > message-driven

Binding properties for message driven beans.

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string
Required

The name for the enterprise bean.

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

Specifies the binding for a data source.

NameTypeDefaultDescription

binding-name

string

The data source binding name.

id

string

A unique configuration ID.

name

string

The data source name.

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

Specifies the binding for an EJB Reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the EJB reference.

id

string

A unique configuration ID.

name

string

The name for the EJB reference.

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

Specifies the binding for an environment entry.

NameTypeDefaultDescription

binding-name

string

The binding name for the environment entry.

id

string

A unique configuration ID.

name

string

The name of the environment entry.

value

string

The value of the environment entry.

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

Defines a JCA adapter for a message driven bean.

NameTypeDefaultDescription

activation-spec-auth-alias

string

Specifies the authentication alias for an activation specification.

activation-spec-binding-name

string
Required

Specifies the binding name for an activation specification.

destination-binding-name

string

Specifies the destination binding name for a JCA adapter.

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

Specifies the binding for a message destination reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the message destination reference.

id

string

A unique configuration ID.

name

string

The name for the message destination reference.

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

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource environment reference.

id

string

A unique configuration ID.

name

string

The name for the resource environment reference.

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

Specifies the binding for a resource reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource reference.

id

string

A unique configuration ID.

name

string

The name for the resource reference.

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

The authentication alias for the resource reference.

NameTypeDefaultDescription

nameRef

A reference to top level authData element (string).

The authentication alias name.

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

The authentication alias name.

NameTypeDefaultDescription

krb5Principal

string

The name of the Kerberos principal name or Kerberos service name to be used.

krb5TicketCache

Path to a file

The file location where Kerberos credentials for the Kerberos principal name or service name will be stored. Also known as the Kerberos credential cache (ccache)

password

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

user

string

Name of the user to use when connecting to the EIS.

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

Specifies custom login configuration properties.

NameTypeDefaultDescription

name

string

A name for the custom login configuration.

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

Defines a property for a custom login configuration.

NameTypeDefaultDescription

description

string

A description of the property.

id

string

A unique configuration ID.

name

string

The name of the property.

value

string

The value of the property.

startAfter > ejb-jar-bnd > session

Binding properties for session beans.

NameTypeDefaultDescription

component-id

string

The component ID for a session bean.

id

string

A unique configuration ID.

local-home-binding-name

string

The local home binding name for a session bean.

name

string
Required

The name for the enterprise bean.

remote-home-binding-name

string

The remote home binding name for a session bean.

simple-binding-name

string

Specifies the simple binding name for a session bean.

startAfter > ejb-jar-bnd > session > data-source

Specifies the binding for a data source.

NameTypeDefaultDescription

binding-name

string

The data source binding name.

id

string

A unique configuration ID.

name

string

The data source name.

startAfter > ejb-jar-bnd > session > ejb-ref

Specifies the binding for an EJB Reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the EJB reference.

id

string

A unique configuration ID.

name

string

The name for the EJB reference.

startAfter > ejb-jar-bnd > session > env-entry

Specifies the binding for an environment entry.

NameTypeDefaultDescription

binding-name

string

The binding name for the environment entry.

id

string

A unique configuration ID.

name

string

The name of the environment entry.

value

string

The value of the environment entry.

startAfter > ejb-jar-bnd > session > interface

Specifies a session interface.

NameTypeDefaultDescription

binding-name

string

Specifies a binding name for an interface.

class

string

The class name for the interface.

id

string

A unique configuration ID.

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

Specifies the binding for a message destination reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the message destination reference.

id

string

A unique configuration ID.

name

string

The name for the message destination reference.

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

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource environment reference.

id

string

A unique configuration ID.

name

string

The name for the resource environment reference.

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

Specifies the binding for a resource reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource reference.

id

string

A unique configuration ID.

name

string

The name for the resource reference.

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

The authentication alias for the resource reference.

NameTypeDefaultDescription

nameRef

A reference to top level authData element (string).

The authentication alias name.

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

The authentication alias name.

NameTypeDefaultDescription

krb5Principal

string

The name of the Kerberos principal name or Kerberos service name to be used.

krb5TicketCache

Path to a file

The file location where Kerberos credentials for the Kerberos principal name or service name will be stored. Also known as the Kerberos credential cache (ccache)

password

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

user

string

Name of the user to use when connecting to the EIS.

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

Specifies custom login configuration properties.

NameTypeDefaultDescription

name

string

A name for the custom login configuration.

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

Defines a property for a custom login configuration.

NameTypeDefaultDescription

description

string

A description of the property.

id

string

A unique configuration ID.

name

string

The name of the property.

value

string

The value of the property.

startAfter > ejb-jar-ext

Extension properties for EJB applications.

NameTypeDefaultDescription

moduleName

string

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

startAfter > ejb-jar-ext > message-driven

Extension properties for message driven beans.

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string
Required

The name for the enterprise bean.

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

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

Specifies global transactions for this enterprise bean.

NameTypeDefaultDescription

send-wsat-context

boolean

false

Determines whether to send the web services atomic transaction on outgoing requests.

transaction-time-out

int

0

Specifies the timeout for the global transaction.

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

shareable

boolean

false

Defines whether the local transaction is shareable.

unresolved-action

  • COMMIT

  • ROLLBACK

Defines the behavor for unresolved actions. The value can be either ROLLBACK or COMMIT.

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

Specifies resource references for this enterprise bean.

NameTypeDefaultDescription

branch-coupling

  • LOOSE

  • TIGHT

Specifies whether loose or tight coupling is used.

commit-priority

int

0

Defines the commit priority for the resource reference.

id

string

A unique configuration ID.

isolation-level

  • TRANSACTION_NONE

  • TRANSACTION_READ_COMMITTED

  • TRANSACTION_READ_UNCOMMITTED

  • TRANSACTION_REPEATABLE_READ

  • TRANSACTION_SERIALIZABLE

Defines the transaction isolation level.

name

string

The name for the resource reference.

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

Controls whether the bean starts at application start.

NameTypeDefaultDescription

value

boolean

false

The value of the start at application start property.

startAfter > ejb-jar-ext > session

Extension properties for session beans.

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string
Required

The name for the enterprise bean.

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

startAfter > ejb-jar-ext > session > global-transaction

Specifies global transactions for this enterprise bean.

NameTypeDefaultDescription

send-wsat-context

boolean

false

Determines whether to send the web services atomic transaction on outgoing requests.

transaction-time-out

int

0

Specifies the timeout for the global transaction.

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

shareable

boolean

false

Defines whether the local transaction is shareable.

unresolved-action

  • COMMIT

  • ROLLBACK

Defines the behavor for unresolved actions. The value can be either ROLLBACK or COMMIT.

startAfter > ejb-jar-ext > session > resource-ref

Specifies resource references for this enterprise bean.

NameTypeDefaultDescription

branch-coupling

  • LOOSE

  • TIGHT

Specifies whether loose or tight coupling is used.

commit-priority

int

0

Defines the commit priority for the resource reference.

id

string

A unique configuration ID.

isolation-level

  • TRANSACTION_NONE

  • TRANSACTION_READ_COMMITTED

  • TRANSACTION_READ_UNCOMMITTED

  • TRANSACTION_REPEATABLE_READ

  • TRANSACTION_SERIALIZABLE

Defines the transaction isolation level.

name

string

The name for the resource reference.

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

Controls whether the bean starts at application start.

NameTypeDefaultDescription

value

boolean

false

The value of the start at application start property.

startAfter > ejb-jar-ext > session > time-out

Specifies a time out value for the session bean.

NameTypeDefaultDescription

value

A period of time with second precision

0

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

startAfter > managed-bean-bnd

Specifies the bindings for a managed bean.

NameTypeDefaultDescription

moduleName

string

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

startAfter > managed-bean-bnd > interceptor

Defines interceptors for the managed bean binding.

NameTypeDefaultDescription

class

string

The class name for the interceptor.

id

string

A unique configuration ID.

startAfter > managed-bean-bnd > interceptor > data-source

Specifies the binding for a data source.

NameTypeDefaultDescription

binding-name

string

The data source binding name.

id

string

A unique configuration ID.

name

string

The data source name.

startAfter > managed-bean-bnd > interceptor > ejb-ref

Specifies the binding for an EJB Reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the EJB reference.

id

string

A unique configuration ID.

name

string

The name for the EJB reference.

startAfter > managed-bean-bnd > interceptor > env-entry

Specifies the binding for an environment entry.

NameTypeDefaultDescription

binding-name

string

The binding name for the environment entry.

id

string

A unique configuration ID.

name

string

The name of the environment entry.

value

string

The value of the environment entry.

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

Specifies the binding for a message destination reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the message destination reference.

id

string

A unique configuration ID.

name

string

The name for the message destination reference.

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

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource environment reference.

id

string

A unique configuration ID.

name

string

The name for the resource environment reference.

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

Specifies the binding for a resource reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource reference.

id

string

A unique configuration ID.

name

string

The name for the resource reference.

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

The authentication alias for the resource reference.

NameTypeDefaultDescription

nameRef

A reference to top level authData element (string).

The authentication alias name.

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

The authentication alias name.

NameTypeDefaultDescription

krb5Principal

string

The name of the Kerberos principal name or Kerberos service name to be used.

krb5TicketCache

Path to a file

The file location where Kerberos credentials for the Kerberos principal name or service name will be stored. Also known as the Kerberos credential cache (ccache)

password

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

user

string

Name of the user to use when connecting to the EIS.

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

Specifies custom login configuration properties.

NameTypeDefaultDescription

name

string

A name for the custom login configuration.

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

Defines a property for a custom login configuration.

NameTypeDefaultDescription

description

string

A description of the property.

id

string

A unique configuration ID.

name

string

The name of the property.

value

string

The value of the property.

startAfter > managed-bean-bnd > managed-bean

Specifies the managed bean for this binding.

NameTypeDefaultDescription

class

string
Required

Specifies the class name for a managed bean.

id

string

A unique configuration ID.

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

Specifies the binding for a data source.

NameTypeDefaultDescription

binding-name

string

The data source binding name.

id

string

A unique configuration ID.

name

string

The data source name.

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

Specifies the binding for an EJB Reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the EJB reference.

id

string

A unique configuration ID.

name

string

The name for the EJB reference.

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

Specifies the binding for an environment entry.

NameTypeDefaultDescription

binding-name

string

The binding name for the environment entry.

id

string

A unique configuration ID.

name

string

The name of the environment entry.

value

string

The value of the environment entry.

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

Specifies the binding for a message destination reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the message destination reference.

id

string

A unique configuration ID.

name

string

The name for the message destination reference.

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

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource environment reference.

id

string

A unique configuration ID.

name

string

The name for the resource environment reference.

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

Specifies the binding for a resource reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource reference.

id

string

A unique configuration ID.

name

string

The name for the resource reference.

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

The authentication alias for the resource reference.

NameTypeDefaultDescription

nameRef

A reference to top level authData element (string).

The authentication alias name.

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

The authentication alias name.

NameTypeDefaultDescription

krb5Principal

string

The name of the Kerberos principal name or Kerberos service name to be used.

krb5TicketCache

Path to a file

The file location where Kerberos credentials for the Kerberos principal name or service name will be stored. Also known as the Kerberos credential cache (ccache)

password

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

user

string

Name of the user to use when connecting to the EIS.

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

Specifies custom login configuration properties.

NameTypeDefaultDescription

name

string

A name for the custom login configuration.

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

Defines a property for a custom login configuration.

NameTypeDefaultDescription

description

string

A description of the property.

id

string

A unique configuration ID.

name

string

The name of the property.

value

string

The value of the property.

startAfter > resourceAdapter

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

NameTypeDefaultDescription

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
Required

Identifies the name of the embedded resource adapter module to which this configuration applies.

startAfter > resourceAdapter > contextService

Configures how context is captured and propagated to threads.

NameTypeDefaultDescription

jndiName

string

JNDI name

onError

  • FAIL

  • IGNORE

  • 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.
FAIL
Server will issue a warning or error message on the first error occurrence and then stop the server.
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.

Advanced Properties

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.

startAfter > resourceAdapter > contextService > baseContext

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

NameTypeDefaultDescription

id

string

A unique configuration ID.

jndiName

string

JNDI name

onError

  • FAIL

  • IGNORE

  • 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.
FAIL
Server will issue a warning or error message on the first error occurrence and then stop the server.
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.

Advanced Properties

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.

startAfter > resourceAdapter > contextService > baseContext > classloaderContext

A unique configuration ID.

NameTypeDefaultDescription

id

string

A unique configuration ID.

startAfter > resourceAdapter > contextService > baseContext > jeeMetadataContext

A unique configuration ID.

NameTypeDefaultDescription

id

string

A unique configuration ID.

startAfter > resourceAdapter > contextService > baseContext > securityContext

A unique configuration ID.

NameTypeDefaultDescription

id

string

A unique configuration ID.

startAfter > resourceAdapter > contextService > classloaderContext

A unique configuration ID.

NameTypeDefaultDescription

id

string

A unique configuration ID.

startAfter > resourceAdapter > contextService > jeeMetadataContext

A unique configuration ID.

NameTypeDefaultDescription

id

string

A unique configuration ID.

startAfter > resourceAdapter > contextService > securityContext

A unique configuration ID.

NameTypeDefaultDescription

id

string

A unique configuration ID.

startAfter > 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

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.

startAfter > web-bnd

Specifies binding properties for a web application.

NameTypeDefaultDescription

moduleName

string

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

startAfter > web-bnd > data-source

Specifies the binding for a data source.

NameTypeDefaultDescription

binding-name

string

The data source binding name.

id

string

A unique configuration ID.

name

string

The data source name.

startAfter > web-bnd > ejb-ref

Specifies the binding for an EJB Reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the EJB reference.

id

string

A unique configuration ID.

name

string

The name for the EJB reference.

startAfter > web-bnd > env-entry

Specifies the binding for an environment entry.

NameTypeDefaultDescription

binding-name

string

The binding name for the environment entry.

id

string

A unique configuration ID.

name

string

The name of the environment entry.

value

string

The value of the environment entry.

startAfter > web-bnd > message-destination-ref

Specifies the binding for a message destination reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the message destination reference.

id

string

A unique configuration ID.

name

string

The name for the message destination reference.

startAfter > web-bnd > resource-env-ref

Specifies the binding for a resource environment reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource environment reference.

id

string

A unique configuration ID.

name

string

The name for the resource environment reference.

startAfter > web-bnd > resource-ref

Specifies the binding for a resource reference.

NameTypeDefaultDescription

binding-name

string

The binding name for the resource reference.

id

string

A unique configuration ID.

name

string

The name for the resource reference.

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

The authentication alias for the resource reference.

NameTypeDefaultDescription

nameRef

A reference to top level authData element (string).

The authentication alias name.

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

The authentication alias name.

NameTypeDefaultDescription

krb5Principal

string

The name of the Kerberos principal name or Kerberos service name to be used.

krb5TicketCache

Path to a file

The file location where Kerberos credentials for the Kerberos principal name or service name will be stored. Also known as the Kerberos credential cache (ccache)

password

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

user

string

Name of the user to use when connecting to the EIS.

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

Specifies custom login configuration properties.

NameTypeDefaultDescription

name

string

A name for the custom login configuration.

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

Defines a property for a custom login configuration.

NameTypeDefaultDescription

description

string

A description of the property.

id

string

A unique configuration ID.

name

string

The name of the property.

value

string

The value of the property.

startAfter > web-bnd > virtual-host

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

NameTypeDefaultDescription

name

string

The name for the virtual host

startAfter > web-ext

Extension properties for web applications.

NameTypeDefaultDescription

auto-encode-requests

boolean

Determines whether requests are automatically encoded.

auto-encode-responses

boolean

Determines whether responses are automatically encoded.

autoload-filters

boolean

Determines whether filters are loaded automatially.

context-root

string

Defines the context root for a web application.

default-error-page

string

Specifies a page to be used as the default error page for a web application.

enable-directory-browsing

boolean

Specifies whether directory browsing is enabled for this web application.

enable-file-serving

boolean

Specifies whether file serving is enabled for this web application.

enable-serving-servlets-by-class-name

boolean

Enables serving servlets by classname.

moduleName

string

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

pre-compile-jsps

boolean

Specifies whether JSP pages are compiled when the web application starts.

startAfter > web-ext > file-serving-attribute

Specifies whether the web application allows files to be served.

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string

The attribute name.

value

string

The attribute value.

startAfter > web-ext > invoker-attribute

Specifies attributes for an invoker.

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string

The attribute name.

value

string

The attribute value.

startAfter > web-ext > jsp-attribute

Specifies attributes that affect JSP behavior.

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string

The attribute name.

value

string

The attribute value.

startAfter > web-ext > mime-filter

Properties for a MIME filter.

NameTypeDefaultDescription

id

string

A unique configuration ID.

mime-type

string

The type for the mime filter.

target

string

The target for the mime filter.

startAfter > web-ext > resource-ref

Properties for a resource reference.

NameTypeDefaultDescription

branch-coupling

  • LOOSE

  • TIGHT

Specifies whether loose or tight coupling is used.

commit-priority

int

0

Defines the commit priority for the resource reference.

id

string

A unique configuration ID.

isolation-level

  • TRANSACTION_NONE

  • TRANSACTION_READ_COMMITTED

  • TRANSACTION_READ_UNCOMMITTED

  • TRANSACTION_REPEATABLE_READ

  • TRANSACTION_SERIALIZABLE

Defines the transaction isolation level.

name

string

The name for the resource reference.

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

startAfter > webservices-bnd > http-publishing

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

NameTypeDefaultDescription

context-root

string

The context root attribute is used to specify the context root of the EJB module in an EJB-based JAX-WS application.

id

string

A unique configuration ID.

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

startAfter > 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-method

string

The authorization method is used to configure the authentication mechanism for a web application.

realm-name

string

The realm name element specifies the realm name to use in HTTP Basic authorization

startAfter > 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-error-page

string

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

form-login-page

string

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

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

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

NameTypeDefaultDescription

role-name

string
This is specified as a child element rather than as an XML attribute.

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

startAfter > 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-guarantee

int

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

startAfter > 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

http-method

string

Specifies the HTTP method to which a security constraint applies

http-method-omission

string

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

id

string

A unique configuration ID.

url-pattern

string

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

web-resource-name

string

The name of a web resource collection

startAfter > 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-name

string

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

startAfter > webservices-bnd > service-ref

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

NameTypeDefaultDescription

component-name

string

The component name attribute is used to specify the EJB bean name if the service reference is used in an EJB module.

id

string

A unique configuration ID.

name

string

The name attribute is used to specify the name of a web services reference.

port-address

string

The port address attribute is used to specify the address of the web services port if the referenced web services has only one port.

wsdl-location

string

The WSDL location attribute is used to specify the URL of a WSDL location to be overridden.

startAfter > webservices-bnd > service-ref > port

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

NameTypeDefaultDescription

address

string

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

id

string

A unique configuration ID.

key-alias

string

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

name

string

The port name is used to specify the name of the web services port.

namespace

string

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

password

Reversably encoded password (string)

The password attribute is used to specify the password for basic authentication. The password can be encoded.

ssl-ref

string

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

username

string

The user name attribute is used to specify the user name for basic authentication.

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

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

startAfter > webservices-bnd > webservice-endpoint

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

NameTypeDefaultDescription

address

string

Address is used to specify the overridden address of a service endpoint.

id

string

A unique configuration ID.

port-component-name

string

The port component name is used to specify the name of a port component.

startAfter > 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

id

string

A unique configuration ID.