Resource Adapter (resourceAdapter)

Defines a resource adapter installation.

Name Type Default Description

autoStart

boolean

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

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

appProperties

Provides custom properties to an application.

appProperties > property

Provides a specific custom property to an application.

Name Type Default Description

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

Defines the settings for an application classloader.

Name Type Default Description

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.

Name Type Default Description

autoStart

boolean

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

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.

Name Type Default Description

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.

Name Type Default Description

implementation

string

Fully qualified implementation class name for which the configuration properties element should be customized.

interface

string

Fully qualified interface class name for which the configuration properties element should be customized.

suffix

string

Overrides the default suffix for the configuration properties element. For example, "CustomConnectionFactory" in properties.rarModule1.CustomConnectionFactory. The suffix is useful to disambiguate when multiple types of connection factories, administered objects, or endpoint activations are provided by a resource adapter. If a configuration properties element customization omits the suffix or leaves it blank, no suffix is used.

classloader > classProvider > web-ext

Extension properties for web applications.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

id

string

A unique configuration ID.

classloader > commonLibrary

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

Name Type Default Description

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

Name Type Default Description

id

string

A unique configuration ID.

name

Path to a file
Required

Fully qualified filename

classloader > commonLibrary > fileset

Id of referenced Fileset

Name Type Default Description

caseSensitive

boolean

true

Boolean to indicate whether or not the search should be case sensitive (default: true).

dir

Path to a directory

${server.config.dir}

The base directory to search for files.

excludes

string

The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.

id

string

A unique configuration ID.

includes

string

*

The comma or space separated list of file name patterns to include in the search results (default: *).

scanInterval

A period of time with millisecond precision

0

Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

classloader > commonLibrary > folder

Id of referenced folder

Name Type Default Description

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.

Name Type Default Description

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

Name Type Default Description

id

string

A unique configuration ID.

name

Path to a file
Required

Fully qualified filename

classloader > privateLibrary > fileset

Id of referenced Fileset

Name Type Default Description

caseSensitive

boolean

true

Boolean to indicate whether or not the search should be case sensitive (default: true).

dir

Path to a directory

${server.config.dir}

The base directory to search for files.

excludes

string

The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.

id

string

A unique configuration ID.

includes

string

*

The comma or space separated list of file name patterns to include in the search results (default: *).

scanInterval

A period of time with millisecond precision

0

Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

classloader > privateLibrary > folder

Id of referenced folder

Name Type Default Description

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.

customize

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

Name Type Default Description

implementation

string

Fully qualified implementation class name for which the configuration properties element should be customized.

interface

string

Fully qualified interface class name for which the configuration properties element should be customized.

suffix

string

Overrides the default suffix for the configuration properties element. For example, "CustomConnectionFactory" in properties.rarModule1.CustomConnectionFactory. The suffix is useful to disambiguate when multiple types of connection factories, administered objects, or endpoint activations are provided by a resource adapter. If a configuration properties element customization omits the suffix or leaves it blank, no suffix is used.

web-ext

Extension properties for web applications.

Name Type Default Description

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.

web-ext > file-serving-attribute

Specifies whether the web application allows files to be served.

Name Type Default Description

id

string

A unique configuration ID.

name

string

The attribute name.

value

string

The attribute value.

web-ext > invoker-attribute

Specifies attributes for an invoker.

Name Type Default Description

id

string

A unique configuration ID.

name

string

The attribute name.

value

string

The attribute value.

web-ext > jsp-attribute

Specifies attributes that affect JSP behavior.

Name Type Default Description

id

string

A unique configuration ID.

name

string

The attribute name.

value

string

The attribute value.

web-ext > mime-filter

Properties for a MIME filter.

Name Type Default Description

id

string

A unique configuration ID.

mime-type

string

The type for the mime filter.

target

string

The target for the mime filter.

web-ext > resource-ref

Properties for a resource reference.

Name Type Default Description

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.

webservices-bnd

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

webservices-bnd > http-publishing

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

Name Type Default Description

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.

webservices-bnd > http-publishing > webservice-security

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

webservices-bnd > http-publishing > webservice-security > 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.

Name Type Default Description

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

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.

Name Type Default Description

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.

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

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

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

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

Name Type Default Description

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.

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.

Name Type Default Description

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.

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.

Name Type Default Description

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

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.

Name Type Default Description

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.

webservices-bnd > service-ref

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

Name Type Default Description

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.

webservices-bnd > service-ref > port

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

Name Type Default Description

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.

webservices-bnd > service-ref > port > properties

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

webservices-bnd > service-ref > properties

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

webservices-bnd > webservice-endpoint

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

Name Type Default Description

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.

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.

Name Type Default Description

id

string

A unique configuration ID.