Resource Adapter (resourceAdapter)

Defines a resource adapter installation.

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

resourceAdapter > appProperties

Provides custom properties to an application.

Expand
resourceAdapter > appProperties > property

Provides a specific custom property to an application.

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

Expand
resourceAdapter > 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.

Expand
resourceAdapter > classloader > classProvider > appProperties

Expand
resourceAdapter > classloader > classProvider > appProperties > property

Expand
resourceAdapter > classloader > classProvider > customize

Expand
resourceAdapter > classloader > classProvider > web-ext

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

Expand
resourceAdapter > classloader > classProvider > web-ext > invoker-attribute

Expand
resourceAdapter > classloader > classProvider > web-ext > jsp-attribute

Expand
resourceAdapter > classloader > classProvider > web-ext > mime-filter

Expand
resourceAdapter > classloader > classProvider > web-ext > resource-ref

Expand
resourceAdapter > classloader > classProvider > webservices-bnd

Expand
resourceAdapter > classloader > classProvider > webservices-bnd > http-publishing

Expand
resourceAdapter > classloader > classProvider > webservices-bnd > http-publishing > webservice-security

Expand
resourceAdapter > classloader > classProvider > webservices-bnd > http-publishing > webservice-security > login-config

Expand
resourceAdapter > classloader > classProvider > webservices-bnd > http-publishing > webservice-security > login-config > form-login-config

Expand
resourceAdapter > classloader > classProvider > webservices-bnd > http-publishing > webservice-security > security-constraint

Expand
resourceAdapter > classloader > classProvider > webservices-bnd > http-publishing > webservice-security > security-constraint > auth-constraint

Expand
resourceAdapter > classloader > classProvider > webservices-bnd > http-publishing > webservice-security > security-constraint > user-data-constraint

Expand
resourceAdapter > classloader > classProvider > webservices-bnd > http-publishing > webservice-security > security-constraint > web-resource-collection

Expand
resourceAdapter > classloader > classProvider > webservices-bnd > http-publishing > webservice-security > security-role

Expand
resourceAdapter > classloader > classProvider > webservices-bnd > service-ref

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

Expand
resourceAdapter > classloader > classProvider > webservices-bnd > webservice-endpoint

Expand
resourceAdapter > classloader > classProvider > webservices-bnd > webservice-endpoint-properties

Expand
resourceAdapter > classloader > commonLibrary

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

Expand
resourceAdapter > classloader > commonLibrary > file

Expand
resourceAdapter > classloader > commonLibrary > fileset

Expand
resourceAdapter > classloader > commonLibrary > folder

Expand
resourceAdapter > classloader > privateLibrary

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

Expand
resourceAdapter > classloader > privateLibrary > file

Expand
resourceAdapter > classloader > privateLibrary > fileset

Expand
resourceAdapter > classloader > privateLibrary > folder

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.

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

Expand
resourceAdapter > web-ext > file-serving-attribute

Specifies whether the web application allows files to be served.

Expand
resourceAdapter > web-ext > invoker-attribute

Specifies attributes for an invoker.

Expand
resourceAdapter > web-ext > jsp-attribute

Specifies attributes that affect JSP behavior.

Expand
resourceAdapter > web-ext > mime-filter

Properties for a MIME filter.

Expand
resourceAdapter > web-ext > resource-ref

Properties for a resource reference.

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

Expand
resourceAdapter > webservices-bnd > http-publishing

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

Expand
resourceAdapter > webservices-bnd > http-publishing > webservice-security

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

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

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

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

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

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

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

Expand
resourceAdapter > webservices-bnd > service-ref

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

Expand
resourceAdapter > webservices-bnd > service-ref > port

Expand
resourceAdapter > webservices-bnd > webservice-endpoint

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

Expand
resourceAdapter > 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.