Defines the properties of an enterprise application.
Name | Type | Default | Description |
---|---|---|---|
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. |
|
defaultClientModule |
string |
Default client module of an enterprise application. |
|
id |
string |
A unique configuration ID. |
|
location |
A file, directory or url. |
Location of an application expressed as an absolute path or a path relative to the server-level apps directory. |
|
name |
string |
Name of an application. |
|
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. |
|
useJandex |
boolean |
Enables use of Jandex index files if they are supplied in the application |
Provides custom properties to an application.
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. |
Defines properties that apply to application bindings.
Specifies the binding for a data source.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
Specifies the binding for an EJB Reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Specifies the binding for an environment entry.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a message destination reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
A role that is mapped to users and groups in a domain user registry.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for a security role. |
The group for a security role.
Name | Type | Default | Description |
---|---|---|---|
access-id |
string |
The access ID for a subject. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the subject. |
ID and password of a user that is required to access a bean from another bean.
Name | Type | Default | Description |
---|---|---|---|
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. |
Name of a special subject possessing a security role.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
type |
|
One of the following special subject types: ALL_AUTHENTICATED_USERS, EVERYONE. |
The user for a security role.
Name | Type | Default | Description |
---|---|---|---|
access-id |
string |
The access ID for a subject. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the subject. |
Defines properties that apply to application clients.
Defines a data source for an application client.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
EJB References in an application client.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Defines an environment entry for an application client.
Name | Type | Default | Description |
---|---|---|---|
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. |
Message destination reference in an application client.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Resource references in an application client.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
Defines properties to extend applications.
Name | Type | Default | Description |
---|---|---|---|
shared-session-context |
boolean |
Indicates whether the session context is shared between modules. |
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 |
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. |
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. |
|
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. |
Defines the path of the RAR file to install. |
|
useJandex |
boolean |
Enables use of Jandex index files if they are supplied in the application |
Provides custom properties to an application.
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. |
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. |
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. |
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. |
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. |
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. |
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. |
Properties for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
branch-coupling |
|
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 |
|
Defines the transaction isolation level. |
|
name |
string |
The name for the resource reference. |
Web service bindings are used to customize web services endpoints and configure security settings for both web services providers and web service clients.
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. |
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 |
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. |
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. |
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. |
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.
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.
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. |
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. |
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 |
Id of referenced File
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
name |
Path to a file |
Fully qualified filename |
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 |
The scanning interval to determine whether files are added or removed from the fileset. The individual files are not scanned. The suffix for the interval of time is h-hour, m-minute, s-second, and ms-millisecond, for example, 2ms or 5s. The scanning interval is disabled by default and is disabled manually by setting the scan interval, scanInterval, to 0. 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. |
Id of referenced folder
Name | Type | Default | Description |
---|---|---|---|
dir |
Path to a directory |
Directory or folder to be included in the library classpath for locating resource files |
|
id |
string |
A unique configuration ID. |
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 |
Id of referenced File
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
name |
Path to a file |
Fully qualified filename |
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 |
The scanning interval to determine whether files are added or removed from the fileset. The individual files are not scanned. The suffix for the interval of time is h-hour, m-minute, s-second, and ms-millisecond, for example, 2ms or 5s. The scanning interval is disabled by default and is disabled manually by setting the scan interval, scanInterval, to 0. 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. |
Id of referenced folder
Name | Type | Default | Description |
---|---|---|---|
dir |
Path to a directory |
Directory or folder to be included in the library classpath for locating resource files |
|
id |
string |
A unique configuration ID. |
The EJB binding descriptor defines binding information for an EJB module.
Name | Type | Default | Description |
---|---|---|---|
moduleName |
string |
The module name specifies the individual module that the binding or extension configuration applies to. |
Binding properties for interceptors.
Name | Type | Default | Description |
---|---|---|---|
class |
string |
The class name for the interceptor. |
|
id |
string |
A unique configuration ID. |
Specifies the binding for a data source.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
Specifies the binding for an EJB Reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Specifies the binding for an environment entry.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a message destination reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
Binding properties for message destinations.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name of the message destination. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name of the message destination. |
Binding properties for message driven beans.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the enterprise bean. |
Specifies the binding for a data source.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
Specifies the binding for an EJB Reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Specifies the binding for an environment entry.
Name | Type | Default | Description |
---|---|---|---|
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. |
Defines a JCA adapter for a message driven bean.
Name | Type | Default | Description |
---|---|---|---|
activation-spec-auth-alias |
string |
Specifies the authentication alias for an activation specification. |
|
activation-spec-binding-name |
string |
Specifies the binding name for an activation specification. |
|
destination-binding-name |
string |
Specifies the destination binding name for a JCA adapter. |
Specifies the binding for a message destination reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
Binding properties for session beans.
Name | Type | Default | Description |
---|---|---|---|
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 |
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. |
Specifies the binding for a data source.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
Specifies the binding for an EJB Reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Specifies the binding for an environment entry.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies a session interface.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
Specifies a binding name for an interface. |
|
class |
string |
The class name for the interface. |
|
id |
string |
A unique configuration ID. |
Specifies the binding for a message destination reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
Extension properties for EJB applications.
Name | Type | Default | Description |
---|---|---|---|
moduleName |
string |
The module name specifies the individual module that the binding or extension configuration applies to. |
Extension properties for message driven beans.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the enterprise bean. |
Cache settings for an EJB.
Name | Type | Default | Description |
---|---|---|---|
activation-policy |
|
Specifies the point at which an EJB is placed in the cache. |
Specifies global transactions for this enterprise bean.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies local transactions for this enterprise bean.
Name | Type | Default | Description |
---|---|---|---|
resolver |
|
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 |
|
Defines the behavor for unresolved actions. The value can be either ROLLBACK or COMMIT. |
Specifies resource references for this enterprise bean.
Name | Type | Default | Description |
---|---|---|---|
branch-coupling |
|
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 |
|
Defines the transaction isolation level. |
|
name |
string |
The name for the resource reference. |
Controls whether the bean starts at application start.
Name | Type | Default | Description |
---|---|---|---|
value |
boolean |
false |
The value of the start at application start property. |
Extension properties for session beans.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the enterprise bean. |
Cache settings for an EJB.
Name | Type | Default | Description |
---|---|---|---|
activation-policy |
|
Specifies the point at which an EJB is placed in the cache. |
Specifies global transactions for this enterprise bean.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies local transactions for this enterprise bean.
Name | Type | Default | Description |
---|---|---|---|
resolver |
|
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 |
|
Defines the behavor for unresolved actions. The value can be either ROLLBACK or COMMIT. |
Specifies resource references for this enterprise bean.
Name | Type | Default | Description |
---|---|---|---|
branch-coupling |
|
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 |
|
Defines the transaction isolation level. |
|
name |
string |
The name for the resource reference. |
Controls whether the bean starts at application start.
Name | Type | Default | Description |
---|---|---|---|
value |
boolean |
false |
The value of the start at application start property. |
Specifies a time out value for the session bean.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the bindings for a managed bean.
Name | Type | Default | Description |
---|---|---|---|
moduleName |
string |
The module name specifies the individual module that the binding or extension configuration applies to. |
Defines interceptors for the managed bean binding.
Name | Type | Default | Description |
---|---|---|---|
class |
string |
The class name for the interceptor. |
|
id |
string |
A unique configuration ID. |
Specifies the binding for a data source.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
Specifies the binding for an EJB Reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Specifies the binding for an environment entry.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a message destination reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the managed bean for this binding.
Name | Type | Default | Description |
---|---|---|---|
class |
string |
Specifies the class name for a managed bean. |
|
id |
string |
A unique configuration ID. |
Specifies the binding for a data source.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
Specifies the binding for an EJB Reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Specifies the binding for an environment entry.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a message destination reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies configuration for a resource adapter that is embedded in an application.
Name | Type | Default | Description |
---|---|---|---|
alias |
string |
${id} |
Overrides the default identifier for the resource adapter. The identifier is used in the name of the resource adapter's configuration properties element, which in turn is used in determining the name of configuration properties elements for any resources provided by the resource adapter. The resource adapter's configuration properties element name has the format, properties.<APP_NAME>.<ALIAS>, where <APP_NAME> is the name of the application and <ALIAS> is the configured alias. If unspecified, the alias defaults to the module name of the resource adapter. |
autoStart |
boolean |
Configures whether a resource adapter starts automatically upon deployment of the resource adapter or lazily upon injection or lookup of a resource. |
|
contextServiceRef |
A reference to top level contextService element (string). |
Configures how context is captured and propagated to threads. |
|
id |
string |
Identifies the name of the embedded resource adapter module to which this configuration applies. |
Configures how context is captured and propagated to threads.
Name | Type | Default | Description |
---|---|---|---|
jndiName |
string |
JNDI name |
|
onError |
|
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. |
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. |
Specifies a base context service from which to inherit context that is not already defined on this context service.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
jndiName |
string |
JNDI name |
|
onError |
|
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. |
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. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
daemonTransactionClass |
string |
ASYNCDMN |
The Transaction Class name provided to WLM to classify work when a new WLM context is created for Daemon work. |
defaultTransactionClass |
string |
ASYNCBN |
The Transaction Class name provided to WLM to classify work when a new WLM context is being created for non-Daemon work. |
id |
string |
A unique configuration ID. |
|
wlm |
|
Propagate |
Indicates how the WLM context should be handled for non-Daemon work. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
daemonTransactionClass |
string |
ASYNCDMN |
The Transaction Class name provided to WLM to classify work when a new WLM context is created for Daemon work. |
defaultTransactionClass |
string |
ASYNCBN |
The Transaction Class name provided to WLM to classify work when a new WLM context is being created for non-Daemon work. |
id |
string |
A unique configuration ID. |
|
wlm |
|
Propagate |
Indicates how the WLM context should be handled for non-Daemon work. |
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. |
Specifies applications that are required to start before this application can begin starting.
Name | Type | Default | Description |
---|---|---|---|
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. |
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 |
Provides custom properties to an application.
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. |
Defines properties that apply to application bindings.
Specifies the binding for a data source.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
Specifies the binding for an EJB Reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Specifies the binding for an environment entry.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a message destination reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
A role that is mapped to users and groups in a domain user registry.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for a security role. |
The group for a security role.
Name | Type | Default | Description |
---|---|---|---|
access-id |
string |
The access ID for a subject. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the subject. |
ID and password of a user that is required to access a bean from another bean.
Name | Type | Default | Description |
---|---|---|---|
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. |
Name of a special subject possessing a security role.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
type |
|
One of the following special subject types: ALL_AUTHENTICATED_USERS, EVERYONE. |
The user for a security role.
Name | Type | Default | Description |
---|---|---|---|
access-id |
string |
The access ID for a subject. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the subject. |
Defines properties that apply to application clients.
Defines a data source for an application client.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
EJB References in an application client.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Defines an environment entry for an application client.
Name | Type | Default | Description |
---|---|---|---|
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. |
Message destination reference in an application client.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Resource references in an application client.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
Defines properties to extend applications.
Name | Type | Default | Description |
---|---|---|---|
shared-session-context |
boolean |
Indicates whether the session context is shared between modules. |
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 |
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. |
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. |
|
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. |
Defines the path of the RAR file to install. |
|
useJandex |
boolean |
Enables use of Jandex index files if they are supplied in the application |
Provides custom properties to an application.
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. |
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. |
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. |
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. |
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. |
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. |
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. |
Properties for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
branch-coupling |
|
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 |
|
Defines the transaction isolation level. |
|
name |
string |
The name for the resource reference. |
Web service bindings are used to customize web services endpoints and configure security settings for both web services providers and web service clients.
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. |
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.
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 |
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.
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. |
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.
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. |
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.
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. |
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.
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 |
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.
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. |
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. |
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. |
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.
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.
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. |
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. |
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 |
Id of referenced File
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
name |
Path to a file |
Fully qualified filename |
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 |
The scanning interval to determine whether files are added or removed from the fileset. The individual files are not scanned. The suffix for the interval of time is h-hour, m-minute, s-second, and ms-millisecond, for example, 2ms or 5s. The scanning interval is disabled by default and is disabled manually by setting the scan interval, scanInterval, to 0. 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. |
Id of referenced folder
Name | Type | Default | Description |
---|---|---|---|
dir |
Path to a directory |
Directory or folder to be included in the library classpath for locating resource files |
|
id |
string |
A unique configuration ID. |
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 |
Id of referenced File
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
name |
Path to a file |
Fully qualified filename |
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 |
The scanning interval to determine whether files are added or removed from the fileset. The individual files are not scanned. The suffix for the interval of time is h-hour, m-minute, s-second, and ms-millisecond, for example, 2ms or 5s. The scanning interval is disabled by default and is disabled manually by setting the scan interval, scanInterval, to 0. 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. |
Id of referenced folder
Name | Type | Default | Description |
---|---|---|---|
dir |
Path to a directory |
Directory or folder to be included in the library classpath for locating resource files |
|
id |
string |
A unique configuration ID. |
The EJB binding descriptor defines binding information for an EJB module.
Name | Type | Default | Description |
---|---|---|---|
moduleName |
string |
The module name specifies the individual module that the binding or extension configuration applies to. |
Binding properties for interceptors.
Name | Type | Default | Description |
---|---|---|---|
class |
string |
The class name for the interceptor. |
|
id |
string |
A unique configuration ID. |
Specifies the binding for a data source.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
Specifies the binding for an EJB Reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Specifies the binding for an environment entry.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a message destination reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
Binding properties for message destinations.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name of the message destination. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name of the message destination. |
Binding properties for message driven beans.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the enterprise bean. |
Specifies the binding for a data source.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
Specifies the binding for an EJB Reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Specifies the binding for an environment entry.
Name | Type | Default | Description |
---|---|---|---|
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. |
Defines a JCA adapter for a message driven bean.
Name | Type | Default | Description |
---|---|---|---|
activation-spec-auth-alias |
string |
Specifies the authentication alias for an activation specification. |
|
activation-spec-binding-name |
string |
Specifies the binding name for an activation specification. |
|
destination-binding-name |
string |
Specifies the destination binding name for a JCA adapter. |
Specifies the binding for a message destination reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
Binding properties for session beans.
Name | Type | Default | Description |
---|---|---|---|
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 |
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. |
Specifies the binding for a data source.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
Specifies the binding for an EJB Reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Specifies the binding for an environment entry.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies a session interface.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
Specifies a binding name for an interface. |
|
class |
string |
The class name for the interface. |
|
id |
string |
A unique configuration ID. |
Specifies the binding for a message destination reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
Extension properties for EJB applications.
Name | Type | Default | Description |
---|---|---|---|
moduleName |
string |
The module name specifies the individual module that the binding or extension configuration applies to. |
Extension properties for message driven beans.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the enterprise bean. |
Cache settings for an EJB.
Name | Type | Default | Description |
---|---|---|---|
activation-policy |
|
Specifies the point at which an EJB is placed in the cache. |
Specifies global transactions for this enterprise bean.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies local transactions for this enterprise bean.
Name | Type | Default | Description |
---|---|---|---|
resolver |
|
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 |
|
Defines the behavor for unresolved actions. The value can be either ROLLBACK or COMMIT. |
Specifies resource references for this enterprise bean.
Name | Type | Default | Description |
---|---|---|---|
branch-coupling |
|
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 |
|
Defines the transaction isolation level. |
|
name |
string |
The name for the resource reference. |
Controls whether the bean starts at application start.
Name | Type | Default | Description |
---|---|---|---|
value |
boolean |
false |
The value of the start at application start property. |
Extension properties for session beans.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the enterprise bean. |
Cache settings for an EJB.
Name | Type | Default | Description |
---|---|---|---|
activation-policy |
|
Specifies the point at which an EJB is placed in the cache. |
Specifies global transactions for this enterprise bean.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies local transactions for this enterprise bean.
Name | Type | Default | Description |
---|---|---|---|
resolver |
|
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 |
|
Defines the behavor for unresolved actions. The value can be either ROLLBACK or COMMIT. |
Specifies resource references for this enterprise bean.
Name | Type | Default | Description |
---|---|---|---|
branch-coupling |
|
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 |
|
Defines the transaction isolation level. |
|
name |
string |
The name for the resource reference. |
Controls whether the bean starts at application start.
Name | Type | Default | Description |
---|---|---|---|
value |
boolean |
false |
The value of the start at application start property. |
Specifies a time out value for the session bean.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the bindings for a managed bean.
Name | Type | Default | Description |
---|---|---|---|
moduleName |
string |
The module name specifies the individual module that the binding or extension configuration applies to. |
Defines interceptors for the managed bean binding.
Name | Type | Default | Description |
---|---|---|---|
class |
string |
The class name for the interceptor. |
|
id |
string |
A unique configuration ID. |
Specifies the binding for a data source.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
Specifies the binding for an EJB Reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Specifies the binding for an environment entry.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a message destination reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the managed bean for this binding.
Name | Type | Default | Description |
---|---|---|---|
class |
string |
Specifies the class name for a managed bean. |
|
id |
string |
A unique configuration ID. |
Specifies the binding for a data source.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
Specifies the binding for an EJB Reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Specifies the binding for an environment entry.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a message destination reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies configuration for a resource adapter that is embedded in an application.
Name | Type | Default | Description |
---|---|---|---|
alias |
string |
${id} |
Overrides the default identifier for the resource adapter. The identifier is used in the name of the resource adapter's configuration properties element, which in turn is used in determining the name of configuration properties elements for any resources provided by the resource adapter. The resource adapter's configuration properties element name has the format, properties.<APP_NAME>.<ALIAS>, where <APP_NAME> is the name of the application and <ALIAS> is the configured alias. If unspecified, the alias defaults to the module name of the resource adapter. |
autoStart |
boolean |
Configures whether a resource adapter starts automatically upon deployment of the resource adapter or lazily upon injection or lookup of a resource. |
|
contextServiceRef |
A reference to top level contextService element (string). |
Configures how context is captured and propagated to threads. |
|
id |
string |
Identifies the name of the embedded resource adapter module to which this configuration applies. |
Configures how context is captured and propagated to threads.
Name | Type | Default | Description |
---|---|---|---|
jndiName |
string |
JNDI name |
|
onError |
|
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. |
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. |
Specifies a base context service from which to inherit context that is not already defined on this context service.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
jndiName |
string |
JNDI name |
|
onError |
|
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. |
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. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
daemonTransactionClass |
string |
ASYNCDMN |
The Transaction Class name provided to WLM to classify work when a new WLM context is created for Daemon work. |
defaultTransactionClass |
string |
ASYNCBN |
The Transaction Class name provided to WLM to classify work when a new WLM context is being created for non-Daemon work. |
id |
string |
A unique configuration ID. |
|
wlm |
|
Propagate |
Indicates how the WLM context should be handled for non-Daemon work. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
daemonTransactionClass |
string |
ASYNCDMN |
The Transaction Class name provided to WLM to classify work when a new WLM context is created for Daemon work. |
defaultTransactionClass |
string |
ASYNCBN |
The Transaction Class name provided to WLM to classify work when a new WLM context is being created for non-Daemon work. |
id |
string |
A unique configuration ID. |
|
wlm |
|
Propagate |
Indicates how the WLM context should be handled for non-Daemon work. |
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. |
Specifies binding properties for a web application.
Name | Type | Default | Description |
---|---|---|---|
moduleName |
string |
The module name specifies the individual module that the binding or extension configuration applies to. |
Specifies the binding for a data source.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
Specifies the binding for an EJB Reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Specifies the binding for an environment entry.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a message destination reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the virtual host that is used for the web application.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
The name for the virtual host |
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. |
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. |
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. |
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. |
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. |
Properties for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
branch-coupling |
|
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 |
|
Defines the transaction isolation level. |
|
name |
string |
The name for the resource reference. |
Web service bindings are used to customize web services endpoints and configure security settings for both web services providers and web service clients.
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. |
The web service security element is used to configure role-based authorization for POJO web services and EJB-based web services.
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 |
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.
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. |
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.
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. |
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.
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. |
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.
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 |
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. |
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. |
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. |
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.
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.
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. |
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. |
Specifies binding properties for a web application.
Name | Type | Default | Description |
---|---|---|---|
moduleName |
string |
The module name specifies the individual module that the binding or extension configuration applies to. |
Specifies the binding for a data source.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The data source binding name. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The data source name. |
Specifies the binding for an EJB Reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the EJB reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the EJB reference. |
Specifies the binding for an environment entry.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a message destination reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource environment reference.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the binding for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
binding-name |
string |
The binding name for the resource reference. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The name for the resource reference. |
The authentication alias for the resource reference.
Name | Type | Default | Description |
---|---|---|---|
nameRef |
A reference to top level authData element (string). |
The authentication alias name. |
The authentication alias name.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies custom login configuration properties.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
A name for the custom login configuration. |
Defines a property for a custom login configuration.
Name | Type | Default | Description |
---|---|---|---|
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. |
Specifies the virtual host that is used for the web application.
Name | Type | Default | Description |
---|---|---|---|
name |
string |
The name for the virtual host |
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. |
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. |
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. |
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. |
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. |
Properties for a resource reference.
Name | Type | Default | Description |
---|---|---|---|
branch-coupling |
|
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 |
|
Defines the transaction isolation level. |
|
name |
string |
The name for the resource reference. |
Web service bindings are used to customize web services endpoints and configure security settings for both web services providers and web service clients.
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. |
The web service security element is used to configure role-based authorization for POJO web services and EJB-based web services.
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 |
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. |
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.
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 |
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 |
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. |
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. |
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. |
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.
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.
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. |
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. |