Configuration elements in server.xml

The application server configuration is described in a series of elements in server.xml. Each element has one or more attributes or sub-elements.

Elements in server.xml

activedLdapFilterProperties

Default Microsoft Active Directory LDAP filters.

PID: com.ibm.ws.security.registry.ldap.internal.filters.actived.

Attributes

userFilter

An LDAP filter clause for searching the user registry for users.

Default: (&(sAMAccountName=%v)(objectcategory=user))

Required: true

Data type: string

groupFilter

An LDAP filter clause for search the user registry for groups.

Default: (&(cn=%v)(objectcategory=group))

Required: true

Data type: string

userIdMap

An LDAP filter that maps the name of a user to an LDAP entry.

Default: user:sAMAccountName

Required: true

Data type: string

groupIdMap

An LDAP filter that maps the name of a group to an LDAP entry.

Default: *:cn

Required: true

Data type: string

groupMemberIdMap

An LDAP filter that identifies user to group memberships.

Default: memberof:member

Required: true

Data type: string

administrator-role

A collection of users and/or groups assigned the server administrator role.

PID: com.ibm.ws.management.security.role.administrator.

Sub-elements

user

User assigned a role.

Required: false

Data type: string

group

Group assigned a role.

Required: false

Data type: string

application

Defines the properties of an application.

PID: com.ibm.ws.app.manager.

Attributes

location

Location of an application expressed as an absolute path or a path relative to the server-level apps directory.

Required: true

Data type: string

name

Name of an application.

Required: false

Data type: string

type

Type of application archive.

Default: ${location:type}

Required: false

Data type: string

context-root

Context root of an application.

Required: false

Data type: string

autoStart

Indicates whether or not the server should start the application automatically when the server starts.

Default: true

Required: false

Data type: boolean

application-bnd

Binds general deployment information included in the application to specific resources.

PID: com.ibm.ws.javaee.dd.appbnd, and it is the child of complex type "application".

Attributes

version

Version of the application bindings specification.

Required: false

Data type: string

Sub-elements

security-role

Required: false

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

name

Name of a security role.

Required: true

Data type: string

user

Required: false

Data type: A user possessing a security role.

name

Name of a user possessing a security role.

Required: true

Data type: string

access-id

A user access ID in the general form user:realmName/userUniqueId. A value will be generated if one is not specified.

Required: false

Data type: string

group

Required: false

Data type: A group possessing a security role.

name

Name of a group possessing a security role.

Required: true

Data type: string

access-id

Group access ID

Required: false

Data type: string

special-subject

Required: false

Data type: Name of a special-subject possessing a security role.

type

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

Range:

EVERYONE




ALL_AUTHENTICATED_USERS

All authenticated users

Required: true

Data type: string

run-as

Required: false

Data type: ID and password of a user required to access a bean from another bean.

userid

ID of a user required to access a bean from another bean.

Required: true

Data type: string

password

Password of a user required to access a bean from another bean. Stored in clear text or encoded form. To encode the password, use the securityUtility tool with the encode option.

Required: false

Data type: password (string)

applicationMonitor

Defines how the server responds to application additions, updates, and deletions.

PID: com.ibm.ws.app.manager.monitor.

Attributes

pollingRate

Rate at which the server checks for application additions, updates, and deletions. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Default: 500ms

Required: false

Data type: string

dropins

Location of the application drop-in directory expressed as an absolute path or a path relative to the server directory.

Default: dropins

Required: false

Data type: string

dropinsEnabled

Monitor the drop-in directory for application additions, updates, and deletions.

Default: true

Required: false

Data type: boolean

updateTrigger

Application update method or trigger.

Default: polled

Range:

polled

Server will scan for application changes at the polling interval and update any applications that have detectable changes.

mbean

Server will only update applications when prompted by an MBean called by an external program such as an integrated development environment or a management application.

disabled

Disables all update monitoring. Application changes will not be applied while the server is running.

Required: false

Data type: string

authCache

Controls the operation of the authentication cache. PID is com.ibm.ws.security.authentication.cache.

Attributes

initialSize

Initial number of entries supported by the authentication cache.

Default: 50

Required: false

Data type: int

maxSize

Maximum number of entries supported by the authentication cache.

Default: 25000

Required: false

Data type: int

timeout

Amount of time after which an entry in the cache will be removed. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Default: 600s

Required: false

Data type: string

allowBasicAuthLookup

Allow lookup by user ID and hashed password.

Default: true

Required: false

Data type: boolean

authData

Authentication data for connecting to an Enterprise Information System (EIS).

PID: com.ibm.ws.security.jca.internal.authdata.config.

Attributes

user

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

Required: true

Data type: string

password

Password of the user to use when connecting to the EIS. 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.

Required: true

Data type: password (string)

authentication

Controls the built-in authentication service configuration.

PID: com.ibm.ws.security.authentication.

Attributes

cacheEnabled

Enables the authentication cache.

Default: true

Required: true

Data type: boolean

allowHashtableLoginWithIdOnly

Allow an application to login with just an identity in the hashtable properties. Use this option only when we have applications that require this and have other means to validate the identity.

Default: false

Required: false

Data type: boolean

authorization-roles

A collection of role names and mappings of the roles to users, groups, or special subjects.

PID: com.ibm.ws.webcontainer.security.feature.authorizationConfig.

Sub-elements

security-role

Required: false

Data type: A role that is mapped to users and groups in a user registry.

name

Role name.

Required: true

Data type: string

user

Required: false

Data type: User who has the security role.

name

Name of a user who has the security role.

Required: true

Data type: string

access-ied

A user access ID in the general form user:realmName/userUniqueId. A value will be generated if one is not specified.

Required: false

Data type: string

group

Required: false

Data type: Group that has the security role.

name

Name of a group that has the security role.

Required: true

Data type: string

access-ied

A group access ID in the general form group:realmName/groupUniqueId. A value will be generated if one is not specified.

Required: false

Data type: string

special-subject

Required: false

Data type: Special subject that has the security role.

type

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

Range:

ALL_AUTHENTICATED_USERS

All authenticated users.

EVERYONE

All users for every request, even if the request was not authenticated.

Required: true

Data type: string

basicRegistry

A simple XML-based user registry.

PID: com.ibm.ws.security.registry.basic.config.

Attributes

realm

The realm name represents the user registry.

Default: BasicRegistry

Required: true

Data type: string

Sub-elements

user

Required: false

Data type: A user in a Basic User Registry.

name

Name of a user in a Basic User Registry.

Required: true

Data type: string

password

Password of a user in a Basic User Registry. 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.

Required: true

Data type: password (string)

group

Required: false

Data type: A group in a Basic User Registry.

name

Name of a group in a Basic User Registry.

Required: true

Data type: string

member

Required: false

Data type: A member of a Basic User Registry group.

name

Name of a user in a Basic User Registry group.

Required: true

Data type: string

binaryLog

Binary logging options. The binary log can be viewed using the logViewer command.

PID: com.ibm.ws.logging.binaryLog, and it is the child of complex type "logging".

Attributes

purgeMaxSize

Maximum size for the binary log repository in megabytes. When the value for purgeMaxSize is specified with a value of more than 0, cleanup based on repository size is enabled, otherwise it is disabled; a value of 0 means no limit.

Inherits: com.ibm.hpel.log.purgeMaxSize

Default: 50

Required: false

Data type: int

purgeMinTime

Duration, in hours, after which a server can remove a log record. When the value for purgeMinTime is specified with a value of more than 0, cleanup based on log record age is enabled, otherwise it is disabled; a value of 0 means no limit.

Inherits: com.ibm.hpel.log.purgeMinTime

Default: 0

Required: false

Data type: int

fileSwitchTime

Makes the server close the active log file and start a new one at the specified hour of the day. When the value for fileSwitchTime is specified, file switching is enabled, otherwise it is disabled.

Inherits: com.ibm.hpel.log.fileSwitchTime

Required: false

Data type: int

bufferingEnabled

Whether to allow a small delay in saving records to the disk for improved performance. When bufferingEnabled is set to true, records will be briefly held in memory before being written to disk.

Inherits: com.ibm.hpel.log.bufferingEnabled

Default: true

Required: false

Data type: boolean

outOfSpaceAction

Action to perform when the file system where records are kept runs out of free space. When outOfSpaceAction is set to "StopLogging" the server will stop logging when records are not able to be written to disk. When this attribute is set to "PurgeOld" the server will attempt to delete the oldest records from the binary log repository to make space for new records. When this attribute is set to "StopServer" the binary log will stop the server when records cannot be written.

Inherits: com.ibm.hpel.log.outOfSpaceAction

Default: StopLogging

Range:

StopServer

Stop Server

PurgeOld

Remove old records

StopLogging

Stop Logging

Required: false

Data type: string

binaryTrace

Binary trace options. The binary trace can be viewed using the logViewer command.

PID: com.ibm.ws.logging.binaryTrace, and it is the child of complex type "logging".

Attributes

purgeMaxSize

Maximum size for the binary trace repository in megabytes. When the value for purgeMaxSize is specified with a value of more than 0, cleanup based on repository size is enabled, otherwise it is disabled; a value of 0 means no limit.

Inherits: com.ibm.hpel.trace.purgeMaxSize

Default: 50

Required: false

Data type: int

purgeMinTime

Duration, in hours, after which a server can remove a trace record. When the value for purgeMinTime is specified with a value of more than 0, cleanup based on trace record age is enabled, otherwise it is disabled; a value of 0 means no limit.

Inherits: com.ibm.hpel.trace.purgeMinTime

Default: 0

Required: false

Data type: int

fileSwitchTime

Makes the server close the active trace file and start a new one at the specified hour of the day. When the value for fileSwitchTime is specified, file switching is enabled, otherwise it is disabled.

Inherits: com.ibm.hpel.trace.fileSwitchTime

Required: false

Data type: int

bufferingEnabled

Whether to allow a small delay in saving records to the disk for improved performance. When bufferingEnabled is set to true, records will be briefly held in memory before being written to disk.

Inherits: com.ibm.hpel.trace.bufferingEnabled

Default: true

Required: false

Data type: boolean

outOfSpaceAction

Action to perform when the file system where records are kept runs out of free space. When outOfSpaceAction is set to "StopLogging" the server will stop tracing when records are not able to be written to disk. When this attribute is set to "PurgeOld" the server will attempt to delete the oldest records from the binary trace repository to make space for new records. When this attribute is set to "StopServer" binary trace will stop the server when records cannot be written.

Inherits: com.ibm.hpel.trace.outOfSpaceAction

Default: StopLogging

Range:

StopServer

Stop Server

PurgeOld

Remove old records

StopLogging

Stop Logging

Required: false

Data type: string

bundleRepository

An internal bundle repository, in which we can store the bundles for the OSGi applications.

PID: com.ibm.ws.eba.bundle.repository.

Attributes

filesetRef

Space separated list of fileset references

Required: false

Data type: List of configuration IDs of type fileset (comma-separated string).

Sub-elements

fileset

Space separated list of fileset references

Required: false

Data type: Element of type fileset.

cacheGroup

Specifies sets of external caches that are controlled by WebSphere(R) Application Server on servers such as IBM(R) WebSphere(R) Edge Server and IBM(R) HTTP Server.

PID: com.ibm.ws.cache.cacheGroup, and it is the child of complex type "distributedMap".

Attributes

name

Specifies a unique name for the external cache group. The external cache group name must match the ExternalCache property defined in the servlet or Java(TM) Server Pages (JSP) cachespec.xml file.

Required: false

Data type: string

cdiContainer

Defines behavior for the Contexts and Dependency Injection (CDI) container.

PID: com.ibm.ws.cdiContainer.

channelfw

Defines channel and chain management settings.

PID: com.ibm.ws.channelfw.

Attributes

chainStartRetryInterval

Time interval between start retries. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Default: 5s

Required: false

Data type: string

chainStartRetryAttempts

Number of retry attempts to make per chain.

Default: 60

Required: false

Data type: int

chainQuiesceTimeout

Default amount of time to wait while quiescing chains. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Default: 0s

Required: false

Data type: string

warningWaitTime

Amount of time to wait before notifying of a missing factory configuration. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Default: 10s

Required: false

Data type: string

classloader

Defines the settings for an application classloader. PID is com.ibm.ws.classloading.classloader, and it is the child of complex type "application".

Attributes

delegation

Controls whether parent classloader is used before or after this classloader.

Default: parentFirst

Range:

parentFirst

Parent first

parentLast

Parent last

Required: false

Data type: string

privateLibraryRef

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

Required: false

Data type: List of configuration IDs of type library (comma-separated string).

commonLibraryRef

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

Required: false

Data type: List of configuration IDs of type library (comma-separated string).

apiTypeVisibility

The types of API package this class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party.

Default: spec,ibm-api,api

Required: false

Data type: string

Sub-elements

privateLibrary

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

Required: false

Data type: Element of type library.

commonLibrary

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

Required: false

Data type: Element of type library.

classloaderContext

Classloader context propagation configuration.

PID: com.ibm.ws.classloader.context, and it is the child of complex type "contextService".

collectiveMember

The collective member configuration requires at least one collective controller address (host and port). The collective controller can have multiple available addresses.

PID: com.ibm.ws.management.repository.connection.

Attributes

controllerHost

The host name for the collective controller instance.

Required: true

Data type: string

controllerPort

The port for the JMX/REST connector, typically the HTTPS port.

Required: true

Data type: int

heartBeatInterval

Periodic time interval at which the collective member will contact the collective controller to indicate liveness. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Default: 60s

Required: false

Data type: string

Sub-elements

failoverController

A failover collective controller address which will be used in the event the primary address is unavailable.

Required: false

Data type: A failover collective controller address which will be used in the event the primary address is unavailable.

host

The host name for the collective controller instance.

Required: true

Data type: string

port

The port for the JMX/REST connector, typically the HTTPS port.

Required: true

Data type: int

config

Defines how the server processes configuration information.

PID: com.ibm.ws.config.

Attributes

onError

Action to take after a incurring a configuration error.

Inherits: onError

Default: WARN

Range:

WARN

Server will issue warning and error messages when it incurs a configuration error.

FAIL

Server will issue a warning or error message on the first error occurrence and then stop the server.

IGNORE

Server will not issue any warning and error messages when it incurs a configuration error.

Required: true

Data type: string

monitorInterval

Rate at which the server checks for configuration updates. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Default: 500ms

Required: false

Data type: string

updateTrigger

Configuration update method or trigger.

Default: polled

Range:

polled

Server will scan for changes at the polling interval on all the configuration files and update the runtime configuration with the changes detected.

mbean

Server will only update the configuration when prompted by an MBean called by an external program such as an integrated development environment or a management application.

disabled

Disables all update monitoring. Configuration changes will not be applied while the server is running.

Required: false

Data type: string

connectionManager

Connection Manager configuration.

PID: com.ibm.ws.jca.connectionManager.

Attributes

agedTimeout

Amount of time before a physical connection can be discarded by pool maintenance. A value of -1 disables this timeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: -1

Required: false

Data type: string

connectionTimeout

Amount of time after which a connection request times out. A value of -1 disables this timeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 30s

Required: false

Data type: string

maxIdleTime

Amount of time after which an unused or idle connection can be discarded during pool maintenance, if doing so does not reduce the pool below the minimum size. A value of -1 disables this timeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 30m

Required: false

Data type: string

maxPoolSize

Maximum number of physical connections for a pool. A value of 0 means unlimited.

Default: 50

Required: false

Data type: int

minPoolSize

Minimum number of physical connections to maintain in the pool. The pool is not pre-populated. Aged timeout can override the minimum.

Required: false

Data type: int

purgePolicy

Specifies which connections to destroy when a stale connection is detected in a pool.

Default: EntirePool

Range:

EntirePool

When a stale connection is detected, all connections in the pool are marked stale, and when no longer in use, are closed.

FailingConnectionOnly

When a stale connection is detected, only the connection which was found to be bad is closed.

ValidateAllConnections

When a stale connection is detected, connections are tested and those found to be bad are closed.

Required: false

Data type: string

reapTime

Amount of time between runs of the pool maintenance thread. A value of -1 disables pool maintenance. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 3m

Required: false

Data type: string

maxConnectionsPerThread

Limits the number of open connections on each thread.

Required: false

Data type: int

numConnectionsPerThreadLocal

Caches the specified number of connections for each thread.

Required: false

Data type: int

contextService

Configures how context is propagated to threads.

PID: com.ibm.ws.context.service.

Attributes

onError

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.

Inherits: onError

Default: WARN

Range:

FAIL

Fail when incorrect configuration is encountered.

IGNORE

Ignore incorrect configuration.

WARN

Issue a warning for incorrect configuration.

Required: true

Data type: string

baseContextRef

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

Required: false

Data type: Configuration ID of type contextService (string).

Sub-elements

baseContext

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

Required: false

Data type: Element of type contextService.

customLdapFilterProperties

Default Custom LDAP filters. PID is com.ibm.ws.security.registry.ldap.internal.filters.custom.

Attributes

userFilter

An LDAP filter clause for searching the user registry for users.

Default: (&(uid=%v)(objectclass=ePerson))

Required: true

Data type: string

groupFilter

An LDAP filter clause for search the user registry for groups.

Default: (&(cn=%v)(|(objectclass=groupOfNames)(objectclass=groupOfUniqueNames)(objectclass=groupOfURLs)))

Required: true

Data type: string

userIdMap

An LDAP filter that maps the name of a user to an LDAP entry.

Default: *:uid

Required: true

Data type: string

groupIdMap

An LDAP filter that maps the name of a group to an LDAP entry.

Default: *:cn

Required: true

Data type: string

groupMemberIdMap

An LDAP filter that identifies user to group memberships.

Default: ibm-allGroups:member;ibm-allGroups:uniqueMember;groupOfNames:member;groupOfUniqueNames:uniqueMember

Required: true

Data type: string

dataSource

Defines a data source configuration.

PID: com.ibm.ws.jdbc.dataSource.

Attributes

jndiName

JNDI name for a data source.

Required: true

Data type: string

jdbcDriverRef

JDBC driver for a data source.

Required: false

Data type: Configuration ID of type jdbcDriver (string).

connectionManagerRef

Connection manager for a data source.

Required: false

Data type: Configuration ID of type connectionManager (string).

type

Type of data source.

Range:

javax.sql.XADataSource




javax.sql.ConnectionPoolDataSource




javax.sql.DataSource




Required: false

Data type: string

connectionSharing

Specifies how connections are matched for sharing.

Default: MatchOriginalRequest

Range:

MatchOriginalRequest

When sharing connections, match based on the original connection request.

MatchCurrentState

When sharing connections, match based on the current state of the connection.

Required: false

Data type: string

containerAuthDataRef

Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.

Required: false

Data type: Configuration ID of type authData (string).

isolationLevel

Default transaction isolation level.

Range:

TRANSACTION_READ_UNCOMMITTED

Dirty reads, non-repeatable reads and phantom reads can occur.

TRANSACTION_READ_COMMITTED

Dirty reads are prevented; non-repeatable reads and phantom reads can occur.

TRANSACTION_REPEATABLE_READ

Dirty reads and non-repeatable reads are prevented; phantom reads can occur.

TRANSACTION_SERIALIZABLE

Dirty reads, non-repeatable reads and phantom reads are prevented.

TRANSACTION_SNAPSHOT

Snapshot isolation for Microsoft SQL Server JDBC Driver and DataDirect Connect for JDBC driver.

Required: false

Data type: string

statementCacheSize

Maximum number of cached statements per connection.

Default: 10

Required: false

Data type: int

transactional

Enable participation in transactions managed by the application server.

Default: true

Required: false

Data type: boolean

beginTranForResultSetScrollingAPIs

Attempt transaction enlistment when result set scrolling interfaces are used.

Default: true

Required: false

Data type: boolean

beginTranForVendorAPIs

Attempt transaction enlistment when vendor interfaces are used.

Default: true

Required: false

Data type: boolean

commitOrRollbackOnCleanup

Determines how to clean up connections that might be in a database unit of work (AutoCommit=false) when the connection is closed or returned to the pool.

Range:

commit

Clean up the connection by committing.

rollback

Clean up the connection by rolling back.

Required: false

Data type: string

queryTimeout

Default query timeout for SQL statements. In a JTA transaction, syncQueryTimeoutWithTransactionTimeout can override this default. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

recoveryAuthDataRef

Authentication data for transaction recovery.

Required: false

Data type: Configuration ID of type authData (string).

syncQueryTimeoutWithTransactionTimeout

Use the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements.

Default: false

Required: false

Data type: boolean

supplementalJDBCTrace

Supplements the JDBC driver trace that is logged when JDBC driver trace is enabled in bootstrap.properties. JDBC driver trace specifications include: com.ibm.ws.database.logwriter, com.ibm.ws.db2.logwriter, com.ibm.ws.derby.logwriter, com.ibm.ws.informix.logwriter, com.ibm.ws.oracle.logwriter, com.ibm.ws.sqlserver.logwriter, com.ibm.ws.sybase.logwriter.

Required: false

Data type: boolean

Sub-elements

jdbcDriver

JDBC driver for a data source.

Required: false

Data type: Element of type jdbcDriver.

connectionManager

Connection manager for a data source.

Required: false

Data type: Element of type connectionManager.

containerAuthData

Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.

Required: false

Data type: Element of type authData.

recoveryAuthData

Authentication data for transaction recovery.

Required: false

Data type: Element of type authData.

diskCache

Enable disk offload to specify that when the cache is full, cache entries are removed from the cache and saved to disk. The location is a fully-qualified directory location used by the disk offload function. The Flush to Disk on Stop option specifies that when the server stops, the contents of the memory cache are moved to disk.

PID: com.ibm.ws.cache.disk, and it is the child of complex type "distributedMap".

Attributes

sizeInEntries

Specifies a value for the maximum disk cache size, in number of entries.

Default: 100000

Required: false

Data type: int

sizeInGB

Specifies a value for the maximum disk cache size, in gigabytes (GB).

Default: 3

Required: false

Data type: int

evictionPolicy

Eviction algorithm and thresholds that the disk cache uses to evict entries.

Default: RANDOM

Range:

RANDOM




SIZE




Required: false

Data type: string

highThreshold

Specifies when the eviction policy starts.

Default: 80

Required: false

Data type: int

lowThreshold

Specifies when the eviction policy ends.

Default: 70

Required: false

Data type: int

location

Directory to use for disk offload.

Required: false

Data type: string

flushToDiskOnStopEnabled

Set to true to have objects that are cached in memory saved to disk when the server stops. This value is ignored if Enable disk offload is set to false.

Default: false

Required: false

Data type: boolean

distributedMap

Distributed map configuration for a local cache.

PID: com.ibm.ws.cache.

Attributes

jndiName

JNDI name for a cache instance.

Default: ${id}

Required: false

Data type: string

memorySizeInEntries

Positive integer that defines the maximum number of entries that the cache can hold. Values are usually in the thousands. The minimum value is 100, with no set maximum value. The default value is 2000.

Default: 2000

Required: false

Data type: int

memorySizeInMB

Specifies a value for the maximum memory cache size in megabytes (MB).

Default: -1

Required: false

Data type: int

highThreshold

Specifies when the memory cache eviction policy starts. The threshold is expressed in terms of the percentage of the memory cache size in megabytes (MB).

Default: -1

Required: false

Data type: int

lowThreshold

Specifies when the memory cache eviction policy ends. The threshold is expressed in terms of the percentage of the memory cache size in megabytes (MB).

Default: -1

Required: false

Data type: int

cacheProviderName

Configure an alternate cache provider for the Web Cache.

Default: default

Required: false

Data type: string

libraryRef

Specifies a reference to a shared library.

Required: false

Data type: Configuration ID of type library (string).

Sub-elements

library

Specifies a reference to a shared library.

Required: false

Data type: Element of type library.

domino50LdapFilterProperties

Default IBM Lotus Domino LDAP filters.

PID: com.ibm.ws.security.registry.ldap.internal.filters.domino50.

Attributes

userFilter

An LDAP filter clause for searching the user registry for users.

Default: (&(uid=%v)(objectclass=Person))

Required: true

Data type: string

groupFilter

An LDAP filter clause for search the user registry for groups.

Default: (&(cn=%v)(objectclass=dominoGroup))

Required: true

Data type: string

userIdMap

An LDAP filter that maps the name of a user to an LDAP entry.

Default: person:uid

Required: true

Data type: string

groupIdMap

An LDAP filter that maps the name of a group to an LDAP entry.

Default: *:cn

Required: true

Data type: string

groupMemberIdMap

An LDAP filter that identifies user to group memberships.

Default: dominoGroup:member

Required: true

Data type: string

edirectoryLdapFilterProperties

List of Novell eDirectory LDAP filters. PID is com.ibm.ws.security.registry.ldap.internal.filters.eDirectory.

Attributes

userFilter

An LDAP filter clause for searching the user registry for users.

Default: (&(cn=%v)(objectclass=Person))

Required: true

Data type: string

groupFilter

An LDAP filter clause for search the user registry for groups.

Default: (&(cn=%v)(objectclass=groupOfNames))

Required: true

Data type: string

userIdMap

An LDAP filter that maps the name of a user to an LDAP entry.

Default: person:cn

Required: true

Data type: string

groupIdMap

An LDAP filter that maps the name of a group to an LDAP entry.

Default: *:cn

Required: true

Data type: string

groupMemberIdMap

An LDAP filter that identifies user to group memberships.

Default: groupOfNames:member

Required: true

Data type: string

ejbContainer

Defines the behavior of the EJB container.

PID: com.ibm.ws.ejbcontainer.runtime.

Attributes

poolCleanupInterval

The interval between removing unused bean instances. This setting only applies to stateless session and message-driven beans. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 30s

Required: true

Data type: string

cacheSize

The number of stateful session bean instances that should be cached in memory.

Default: 2053

Required: true

Data type: int

cacheCleanupInterval

The interval between passivating unused stateful session bean instances when the size is exceeded. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 3s

Required: true

Data type: string

enterpriseApplication

Defines the properties of an enterprise application. PID is com.ibm.ws.app.manager.earappcfg.

Attributes

name

Name of an application.

Required: false

Data type: string

location

Location of an application expressed as an absolute path or a path relative to the server-level apps directory.

Required: true

Data type: string

type

Type of application archive.

Required: false

Data type: string

autoStart

Indicates whether or not the server should start the application automatically when the server starts.

Default: true

Required: false

Data type: boolean

executor

Defines settings for an executor in the server.

PID: com.ibm.ws.threading.

Attributes

name

Name of the executor for which the thread is performing work.

Default: Default Executor

Required: false

Data type: string

maxThreads

Maximum number of threads that can be associated with the executor. If greater than 0, this value must be greater than or equal to the value of coreThreads. If the value of maxThreads is less than or equal to 0, the maximum number of threads is unbounded.

Default: -1

Required: false

Data type: int

coreThreads

Steady-state or core number of threads to associate with the executor. The number of threads associated with the executor will quickly grow to this number. If this value is less than 0, a default value is used. This default value is calculated based on the number of hardware threads on the system.

Default: -1

Required: false

Data type: int

keepAlive

Amount of time to keep an idle thread in the pool before allowing it to terminate. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Default: 60s

Required: false

Data type: string

stealPolicy

The work-stealing policy to employ. The options for this policy determine how work is queued, and how threads obtain queued work.

Default: LOCAL

Range:

STRICT

All threads that generate work own a local work pile. Threads that are associated with the executor take work from other threads when the local work pile is exhausted.

LOCAL

A global work queue is used for work generated by threads that are not associated with the executor. Work generated by threads associated with the executor is placed on a local work pile. This work pile is owned by the generating thread, unless another thread steals it. Threads that are associated with the executor take work associated with other threads if the local work pile is empty and there is no work on the global work queue.

NEVER

A global work queue is used to feed work to threads that are associated with the executor. No stealing will occur.

Required: false

Data type: string

rejectedWorkPolicy

Policy to employ when the executor is unable to stage work for execution.

Default: ABORT

Range:

ABORT

Raise an exception.

CALLER_RUNS

Execute the work immediately on the caller's thread.

Required: false

Data type: string

featureManager

Defines how the server loads features.

PID: com.ibm.ws.kernel.feature.

Attributes

onError

Action to take after a failure to load a feature.

Inherits: onError

Default: WARN

Range:

WARN

Server will issue warning and error messages when it incurs a feature configuration error.

FAIL

Server will issue a warning or error message on the first feature configuration error occurrence and then stop the server.

IGNORE

Server will not issue any warning and error messages when it incurs a feature configuration error.

Required: true

Data type: string

Sub-elements

feature

Specifies a feature to be used when the server runs.

Required: false

Data type: string

federatedRepository

Configuration for the user registry federation.

PID: com.ibm.ws.wim.core.config.

Attributes

maxSearchResults

Maximum number of entries that can be returned in a search.

Default: 4500

Required: false

Data type: int

searchTimeOut

The maximum amount of time, in milliseconds, to process a search.

Default: 600000

Required: false

Data type: int

Sub-elements

registryEntityType

The reference of the registry entity type.

Required: false

Data type: The configuration of the Registry Entity Type.

name

The name of the supported entity type.

Required: true

Data type: string

rdnProperty

The relative distinguished name property for the supported entity.

Required: true

Data type: string

realm

The reference to the realm.

Required: false

Data type: The realm configuration.

name

Name of the realm.

Required: true

Data type: string

delimiter

Delimiter used to qualify the realm under which the operation should be executed. For example, userid=test1/myrealm where / is the delimiter and realm name is myrealm.

Default: /

Required: false

Data type: string

enabled

Whether the realm is enabled for security use.

Default: true

Required: false

Data type: boolean

allowOpIfRepoDown

Whether to allow operation if a repository is down. The default value is false.

Default: false

Required: false

Data type: boolean

participatingBaseEntry

The Base Entry that is part of this realm.

Required: true

Data type: The configuration of the registry base entry.

name

The name of the base entry.

Required: true

Data type: string

baseDN

Base distinguished name (DN) in the repository.

Required: false

Data type: string

uniqueUserIdMapping

The input and output property mappings for unique user id used in an user registry operation.

Required: false

Data type: The input and output mapping for the unique user id.

propertyForInput

The property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: uniqueName

Required: true

Data type: string

propertyForOutput

The property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: uniqueName

Required: true

Data type: string

userSecurityNameMapping

The input and output property mappings for user security name in an user registry operation.

Required: false

Data type: The property mapping for userSecurityName (default: principalName).

propertyForInput

The property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: principalName

Required: true

Data type: string

propertyForOutput

The property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: uniqueName

Required: true

Data type: string

userDisplayNameMapping

The input and output property mappings for user display name in an user registry operation.

Required: false

Data type: The property mapping for userDisplayName (default: principalName).

propertyForInput

The property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: principalName

Required: true

Data type: string

propertyForOutput

The property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: principalName

Required: true

Data type: string

uniqueGroupIdMapping

The input and output property mappings for unique group id in an user registry operation .

Required: false

Data type: The property mapping for uniqueGroupId (default: uniqueName).

propertyForInput

The property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: cn

Required: true

Data type: string

propertyForOutput

The property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: uniqueName

Required: true

Data type: string

groupSecurityNameMapping

The input and output property mappings for group security name in an user registry operation.

Required: false

Data type: The property mapping for groupSecurityName (default: cn).

propertyForInput

The property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: cn

Required: true

Data type: string

propertyForOutput

The property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: cn

Required: true

Data type: string

groupDisplayNameMapping

The input and output property mappings for group display name in an user registry operation.

Required: false

Data type: The property mapping for groupDisplayName (default: cn).

propertyForInput

The property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: cn

Required: true

Data type: string

propertyForOutput

The property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: cn

Required: true

Data type: string

primaryRealm

Primary realm configuration.

Required: false

Data type: The realm configuration.

name

Name of the realm.

Required: true

Data type: string

delimiter

Delimiter used to qualify the realm under which the operation should be executed. For example, userid=test1/myrealm where / is the delimiter and realm name is myrealm.

Default: /

Required: false

Data type: string

enabled

Whether the realm is enabled for security use.

Default: true

Required: false

Data type: boolean

allowOpIfRepoDown

Whether to allow operation if a repository is down. The default value is false.

Default: false

Required: false

Data type: boolean

participatingBaseEntry

The Base Entry that is part of this realm.

Required: true

Data type: The configuration of the registry base entry.

name

The name of the base entry.

Required: true

Data type: string

baseDN

Base distinguished name (DN) in the repository.

Required: false

Data type: string

uniqueUserIdMapping

The input and output property mappings for unique user id used in an user registry operation.

Required: false

Data type: The input and output mapping for the unique user id.

propertyForInput

The property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: uniqueName

Required: true

Data type: string

propertyForOutput

The property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: uniqueName

Required: true

Data type: string

userSecurityNameMapping

The input and output property mappings for user security name in an user registry operation.

Required: false

Data type: The property mapping for userSecurityName (default: principalName).

propertyForInput

The property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: principalName

Required: true

Data type: string

propertyForOutput

The property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: uniqueName

Required: true

Data type: string

userDisplayNameMapping

The input and output property mappings for user display name in an user registry operation.

Required: false

Data type: The property mapping for userDisplayName (default: principalName).

propertyForInput

The property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: principalName

Required: true

Data type: string

propertyForOutput

The property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: principalName

Required: true

Data type: string

uniqueGroupIdMapping

The input and output property mappings for unique group id in an user registry operation .

Required: false

Data type: The property mapping for uniqueGroupId (default: uniqueName).

propertyForInput

The property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: cn

Required: true

Data type: string

propertyForOutput

The property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: uniqueName

Required: true

Data type: string

groupSecurityNameMapping

The input and output property mappings for group security name in an user registry operation.

Required: false

Data type: The property mapping for groupSecurityName (default: cn).

propertyForInput

The property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: cn

Required: true

Data type: string

propertyForOutput

The property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: cn

Required: true

Data type: string

groupDisplayNameMapping

The input and output property mappings for group display name in an user registry operation.

Required: false

Data type: The property mapping for groupDisplayName (default: cn).

propertyForInput

The property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: cn

Required: true

Data type: string

propertyForOutput

The property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

Default: cn

Required: true

Data type: string

fileset

Specifies a set of files starting from a base directory and matching a set of patterns.

PID: com.ibm.ws.kernel.metatype.helper.fileset.

Attributes

dir

The base directory to search for files.

Default: ${server.config.dir}

Required: true

Data type: string

caseSensitive

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

Default: true

Required: false

Data type: boolean

includes

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

Default: *

Required: false

Data type: string

excludes

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

Default:

Required: false

Data type: string

scanInterval

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

Default: 0

Required: false

Data type: string

hostAuthInfo

Connection details to allow for Atlas to authenticate to the server's host.

PID: com.ibm.ws.management.repository.member.hostAuthInfo.

Attributes

rpcHost

The fully qualified host name or IP address. A '*' wildcard will result in host name detection; this is not recommended for multi-homed systems and may result in unexpected behaviour. The host name must be unique within the network and must be the host name on which the remote connection protocol is listening (SSH, or OS specific RPC). This value will inherit from the defaultHostName variable if not set. The host name set here will directly control where the server's information is stored within the Atlas repository.

Inherits: defaultHostName

Default: localhost

Required: true

Data type: string

rpcPort

The port on which the remote connection protocol is listening (SSH, or OS specific RPC). See product documentation for supported RPC mechanisms.

Default: 22

Required: true

Data type: int

rpcUser

The operating system user ID to use to connect to the host.

Required: false

Data type: string

rpcUserPassword

The password for the operating system user. If this property is not set, key-based authentication will be used. Use of key-based authentication is recommended for hosts which support SSH. If this property is set and sshPrivateKeyPath is also set, the key will take precedence.

Required: false

Data type: password (string)

rpcUserHome

The home directory of the user login ID. Only required to be set if sudo is to be used and SSH generation is to be done automatically.

Required: false

Data type: string

sshPublicKeyPath

The path to the SSH public key file. If the key pair does not exist, a key pair will be generated automatically. The public key will be placed into the configured userId's authorized_keys file if it is not present. Setting the path to the public key is not required.

Required: false

Data type: string

sshPrivateKeyPath

The path to the SSH private key file. If the key pair does not exist, a key pair will be generated automatically. The private key is required for key-based authentication.

Required: false

Data type: string

sshPrivateKeyPassword

The password for the SSH private key.

Required: false

Data type: password (string)

useSudo

If true, then sudo will be used to invoke commands. The user to sudo as can be controlled by setting sudoUser attribute. If sudoUser is not set, then the user to sudo as will be the configured default sudo user for the host. If this property is not set, and either sudoUser or sudoUserPassword are set, then useSudo is assumed to be true. If false, and either sudoUser or sudoUserPassword are set, then a warning will be printed and the sudo options will be ignored.

Required: false

Data type: boolean

sudoUser

The sudo user ID. This property should not be set when useSudo=false.

Required: false

Data type: string

sudoUserPassword

The password for the sudo user. This property should not be set when useSudo=false.

Required: false

Data type: password (string)

httpAccessLogging

HTTP access logs contain a record of all inbound HTTP client requests.

PID: com.ibm.ws.http.log.access.

Attributes

enabled

Enable access logging.

Default: true

Required: false

Data type: boolean

filePath

Directory path and name of the access log file. Standard variable substitutions, such as ${server.output.dir}, can be used when specifying the directory path.

Default: ${server.output.dir}/logs/http_access.log

Required: false

Data type: string

logFormat

Log format used when logging client access information.

Default: %h %u %{t}W "%r" %s %b

Required: false

Data type: string

maxFileSize

Maximum size of a log file, in megabytes, before being rolled over; a value of 0 means no limit.

Default: 20

Required: false

Data type: int

maxFiles

Maximum number of log files that will be kept, before the oldest file is removed; a value of 0 means no limit.

Default: 2

Required: false

Data type: int

httpDispatcher

HTTP Dispatcher configuration.

PID: com.ibm.ws.http.dispatcher.

Attributes

enableWelcomePage

Enables the default Liberty profile welcome page when no application is bound to a context root of "/". The default value is true.

Default: true

Required: false

Data type: boolean

appOrContextRootMissingMessage

Message to return to the client when the application in the requested URI can not be found.

Required: false

Data type: string

httpEncoding

HTTP transport encoding settings.

PID: com.ibm.ws.transport.http.encoding.

Attributes

converter.Shift_JIS

Shift_JIS Japanese converter

Default: Cp943C

Required: false

Data type: string

converter.EUC-JP

EUC Japanese converter (EUC-JP)

Default: Cp33722C

Required: false

Data type: string

converter.EUC-KR

EUC Korean converter (EUC-KR)

Default: Cp970

Required: false

Data type: string

converter.EUC_KR

EUC Korean converter (EUC_KR)

Default: Cp970

Required: false

Data type: string

converter.EUC-TW

EUC Chinese (Taiwan) converter (EUC-TW)

Default: Cp964

Required: false

Data type: string

converter.Big5

Big5 Chinese converter

Default: Cp950

Required: false

Data type: string

converter.GB2312

GB2312 Chinese converter

Default: EUC_CN

Required: false

Data type: string

converter.ISO-2022-KR

ISO-2022 Korean converter (ISO-2022-KR)

Default: ISO2022KR

Required: false

Data type: string

encoding.en

English language encoding (en)

Default: ISO-8859-1

Required: false

Data type: string

encoding.fr

French language encoding (fr)

Default: ISO-8859-1

Required: false

Data type: string

encoding.de

German language encoding (de)

Default: ISO-8859-1

Required: false

Data type: string

encoding.es

Spanish language encoding (es)

Default: ISO-8859-1

Required: false

Data type: string

encoding.pt

Portuguese language encoding (pt)

Default: ISO-8859-1

Required: false

Data type: string

encoding.da

Danish language encoding (da)

Default: ISO-8859-1

Required: false

Data type: string

encoding.ca

Catalan language encoding (ca)

Default: ISO-8859-1

Required: false

Data type: string

encoding.fi

Finnish language encoding (fi)

Default: ISO-8859-1

Required: false

Data type: string

encoding.it

Italian language encoding (it)

Default: ISO-8859-1

Required: false

Data type: string

encoding.nl

Dutch language encoding (nl)

Default: ISO-8859-1

Required: false

Data type: string

encoding.no

Norwegian language encoding (no)

Default: ISO-8859-1

Required: false

Data type: string

encoding.sv

Swedish language encoding (sv)

Default: ISO-8859-1

Required: false

Data type: string

encoding.is

Icelandic language encoding (is)

Default: ISO-8859-1

Required: false

Data type: string

encoding.eu

Basque language encoding (eu)

Default: ISO-8859-1

Required: false

Data type: string

encoding.cs

Czech language encoding (cs)

Default: ISO-8859-2

Required: false

Data type: string

encoding.hr

Croatian language encoding (hr)

Default: ISO-8859-2

Required: false

Data type: string

encoding.hu

Hungarian language encoding (hu)

Default: ISO-8859-2

Required: false

Data type: string

encoding.lt

Lithuanian language encoding (lt)

Default: ISO-8859-2

Required: false

Data type: string

encoding.pl

Polish language encoding (pl)

Default: ISO-8859-2

Required: false

Data type: string

encoding.sh

Serbo-Croatian language encoding (sh)

Default: ISO-8859-2

Required: false

Data type: string

encoding.sk

Slovak language encoding (sk)

Default: ISO-8859-2

Required: false

Data type: string

encoding.sl

Slovenian language encoding (sl)

Default: ISO-8859-2

Required: false

Data type: string

encoding.sq

Albanian language encoding (sq)

Default: ISO-8859-2

Required: false

Data type: string

encoding.fo

Faroese language encoding (fo)

Default: ISO-8859-2

Required: false

Data type: string

encoding.ro

Romanian language encoding (ro)

Default: ISO-8859-2

Required: false

Data type: string

encoding.mt

Maltese language encoding (mt)

Default: ISO-8859-3

Required: false

Data type: string

encoding.et

Estonian language encoding (et)

Default: ISO-8859-4

Required: false

Data type: string

encoding.lv

Latvian language encoding (lv)

Default: ISO-8859-4

Required: false

Data type: string

encoding.be

Belarusian language encoding (be)

Default: ISO-8859-5

Required: false

Data type: string

encoding.bg

Bulgarian language encoding (bg)

Default: ISO-8859-5

Required: false

Data type: string

encoding.mk

Macedonian language encoding (mk)

Default: ISO-8859-5

Required: false

Data type: string

encoding.ru

Russian language encoding (ru)

Default: ISO-8859-5

Required: false

Data type: string

encoding.sr

Serbian language encoding (sr)

Default: ISO-8859-5

Required: false

Data type: string

encoding.uk

Ukrainian language encoding (uk)

Default: ISO-8859-5

Required: false

Data type: string

encoding.ar

Arabic language encoding (ar)

Default: ISO-8859-6

Required: false

Data type: string

encoding.fa

Persian language encoding (fa)

Default: ISO-8859-6

Required: false

Data type: string

encoding.ms

Malay language encoding (ms)

Default: ISO-8859-6

Required: false

Data type: string

encoding.el

Greek language encoding (el)

Default: ISO-8859-7

Required: false

Data type: string

encoding.iw

Hebrew language encoding (iw)

Default: ISO-8859-8

Required: false

Data type: string

encoding.he

Hebrew language encoding (he)

Default: ISO-8859-8

Required: false

Data type: string

encoding.ji

Yiddish language encoding (ji)

Default: ISO-8859-8

Required: false

Data type: string

encoding.yi

Yiddish language encoding (yi)

Default: ISO-8859-8

Required: false

Data type: string

encoding.tr

Turkish language encoding (tr)

Default: ISO-8859-9

Required: false

Data type: string

encoding.th

Thai language encoding (th)

Default: windows-874

Required: false

Data type: string

encoding.vi

Vietnamese language encoding (vi)

Default: windows-1258

Required: false

Data type: string

encoding.ja

Japanese language encoding (ja)

Default: Shift_JIS

Required: false

Data type: string

encoding.ko

Korean language encoding (ko)

Default: EUC-KR

Required: false

Data type: string

encoding.zh

Chinese language encoding (zh)

Default: GB2312

Required: false

Data type: string

encoding.zh_TW

Chinese language encoding (zh_TW)

Default: Big5

Required: false

Data type: string

encoding.hy

Armenian language encoding (hy)

Default: UTF-8

Required: false

Data type: string

encoding.ka

Georgian language encoding (ka)

Default: UTF-8

Required: false

Data type: string

encoding.hi

Hindi language encoding (hi)

Default: UTF-8

Required: false

Data type: string

encoding.mr

Marathi language encoding (mr)

Default: UTF-8

Required: false

Data type: string

encoding.sa

Sanskrit language encoding (sa)

Default: UTF-8

Required: false

Data type: string

encoding.ta

Tamil language encoding (ta)

Default: UTF-8

Required: false

Data type: string

encoding.bn

Bengali language encoding (bn)

Default: UTF-8

Required: false

Data type: string

httpEndpoint

Configuration properties for an HTTP endpoint.

PID: com.ibm.ws.http.

Attributes

enabled

Toggle the availability of an endpoint. When true, this endpoint will be activated by the dispatcher to handle HTTP requests.

Default: true

Required: false

Data type: boolean

host

IP address, DNS host name with domain name suffix, or just the DNS host name, used by a client to request a resource. Use '*' for available network interfaces.

Inherits: defaultHostName

Default: localhost

Required: false

Data type: string

httpPort

The port used for client HTTP requests. Use -1 to disable this port.

Required: false

Data type: int

httpsPort

The port used for client HTTP requests secured with SSL (https). Use -1 to disable this port.

Required: false

Data type: int

httpOptionsRef

HTTP protocol options for the endpoint.

Default: defaultHttpOptions

Required: false

Data type: Configuration ID of type httpOptions (string).

sslOptionsRef

SSL protocol options for the endpoint.

Required: false

Data type: Configuration ID of type sslOptions (string).

tcpOptionsRef

TCP protocol options for the endpoint.

Default: defaultTCPOptions

Required: false

Data type: Configuration ID of type tcpOptions (string).

accessLoggingRef

HTTP access logging configuration for the endpoint.

Required: false

Data type: Configuration ID of type httpAccessLogging (string).

Sub-elements

httpOptions

HTTP protocol options for the endpoint.

Default: defaultHttpOptions

Required: false

Data type: Element of type httpOptions.

sslOptions

SSL protocol options for the endpoint.

Required: false

Data type: Element of type sslOptions.

tcpOptions

TCP protocol options for the endpoint.

Default: defaultTCPOptions

Required: false

Data type: Element of type tcpOptions.

accessLogging

HTTP access logging configuration for the endpoint.

Required: false

Data type: Element of type httpAccessLogging.

httpOptions

HTTP protocol configuration.

PID: com.ibm.ws.http.options.

Attributes

keepAliveEnabled

Enables persistent connections (HTTP keepalive). If true, connections are kept alive for reuse by multiple sequential requests and responses. If false, connections are closed after the response is sent.

Default: true

Required: false

Data type: boolean

maxKeepAliveRequests

Maximum number of persistent requests allowed on a single HTTP connection if persistent connections are enabled. A value of -1 means unlimited.

Default: 100

Required: false

Data type: int

persistTimeout

Amount of time that a socket will be allowed to remain idle between requests. This setting only applies if persistent connections are enabled. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 30s

Required: false

Data type: string

readTimeout

Amount of time to wait for a read request to complete on a socket after the first read occurs. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 60s

Required: false

Data type: string

writeTimeout

Amount of time to wait on a socket for each portion of the response data to be transmitted. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 60s

Required: false

Data type: string

removeServerHeader

Removes server implementation information from HTTP headers and also disables the default Liberty profile welcome page.

Default: false

Required: false

Data type: boolean

httpSession

Configuration for HTTP session management.

PID: com.ibm.ws.session.

Attributes

maxInMemorySessionCount

Maximum number of sessions to maintain in memory for each web module.

Default: 1000

Required: false

Data type: int

allowOverflow

Allows the number of sessions in memory to exceed the value of the Max in-memory session count property.

Default: true

Required: false

Data type: boolean

sslTrackingEnabled

That session tracking uses SSL information as a session identifier.

Default: false

Required: false

Data type: boolean

cookiesEnabled

That session tracking uses cookies to carry session identifiers.

Default: true

Required: false

Data type: boolean

urlRewritingEnabled

That the session management facility uses rewritten URLs to carry the session identifiers.

Default: false

Required: false

Data type: boolean

invalidationTimeout

Amount of time a session can go unused before it is no longer valid.

Default: 1800

Required: false

Data type: long

reaperPollInterval

The wake-up interval, in seconds, for the process that removes invalid sessions. The minimum value is 30 seconds. If a value less than the minimum is entered, an appropriate value is automatically determined and used. This value overrides the default installation value, which is between 30 and 360 seconds, based off the session timeout value. Because the default session timeout is 30 minutes, the reaper interval is usually between 2 and 3 minutes.

Default: -1

Required: false

Data type: long

forceInvalidationMultiple

If the requests normally are not bound by a response time limit, specify 0 to indicate that the session manager should wait indefinitely until a request is complete before attempting to invalidate the session. Otherwise, set this property to a positive integer to delay the invalidation of active sessions. Active timed out sessions will not be invalidated by the first invalidation interval pass, but will be invalidated by the interval pass based on this value. For example, a value of 2 would invalidate an active session on the second invalidation interval pass after the session timeout has expired.

Default: 3

Required: false

Data type: int

cookieName

A unique name for a session management cookie.

Default: JSESSIONID

Required: false

Data type: string

cookieDomain

Domain field of a session tracking cookie.

Default:

Required: false

Data type: string

cookieMaxAge

Maximum amount of time that a cookie can reside on the client browser.

Default: -1

Required: false

Data type: int

cookiePath

A cookie is sent to the URL designated in the path.

Default: /

Required: false

Data type: string

useContextRootAsCookiePath

That the cookie path equals the context root of the web module instead of /

Default: false

Required: false

Data type: boolean

cookieSecure

That the session cookies include the secure field.

Default: false

Required: false

Data type: boolean

cookieHttpOnly

That session cookies include the HttpOnly field. Browsers that support the HttpOnly field do not enable cookies to be accessed by client-side scripts. Using the HttpOnly field will help prevent cross-site scripting attacks.

Default: true

Required: false

Data type: boolean

rewriteId

Use this property to change the key used with URL rewriting.

Default: jsessionid

Required: false

Data type: string

protocolSwitchRewritingEnabled

Adds the session identifier to a URL when the URL requires a switch from HTTP to HTTPS or from HTTPS to HTTP.

Default: false

Required: false

Data type: boolean

alwaysEncodeUrl

The Servlet 2.5 specification specifies to not encode the URL on a response.encodeURL call if it is not necessary. To support backward compatibility when URL encoding is enabled, set this property to true to call the encodeURL method. The URL is always encoded, even if the browser supports cookies.

Default: false

Required: false

Data type: boolean

securityIntegrationEnabled

Enables security integration, which causes the session management facility to associate the identity of users with their HTTP sessions.

Default: true

Required: false

Data type: boolean

securityUserIgnoreCase

Indicates that the session security identity and the client security identity should be considered a match even if their cases are different. For example, when this property is set to true, the session security identity USER1 matches the client security identities User1 and user1.

Default: false

Required: false

Data type: boolean

invalidateOnUnauthorizedSessionRequestException

Set this property to true if, in response to an unauthorized request, we want the session manager to invalidate a session instead of issuing an UnauthorizedSessionRequestException. When a session is invalidated, the requester can create a new session, but does not have access to any of the previously saved session data. This allows a single user to continue processing requests to other applications after a logout while still protecting session data.

Default: false

Required: false

Data type: boolean

cloneId

The clone identifier of the cluster member. Within a cluster, this identifier must be unique to maintain session affinity. When set, this name overwrites the default name generated by the server.

Required: false

Data type: string

cloneSeparator

The single character used to separate the session identifier from the clone identifier in session cookies. The default value should usually be used. On some Wireless Application Protocol (WAP) devices, a colon (:) is not allowed, so a plus sign (+) should be used instead. Different values should rarely be used. We should understand the clone character requirements of other products running on the system before using this property to change the clone separator character. The fact that any character can be specified as the value for this property does not imply that the character we specify will function correctly. This fact also does not imply that IBM is responsible for fixing any problem that might arise from using an alternative character.

Default: :

Required: false

Data type: string

idLength

Length of the session identifier.

Default: 23

Required: false

Data type: int

idReuse

In a multi-JVM environment that is not configured for session persistence, setting this property to "true" enables the session manager to use the same session information for all of a user's requests even if the web applications that are handling these requests are governed by different JVMs. The default value for this property is false. Set this property to true to enable the session manager to use the session identifier sent from a browser to preserve session data across web applications running in an environment that is not configured for session persistence.

Default: false

Required: false

Data type: boolean

noAdditionalInfo

Forces removal of information that is not needed in session identifiers.

Default: false

Required: false

Data type: boolean

debugCrossover

Enable this option to perform additional checks to verify that only the session associated with the request is accessed or referenced, and log messages if any discrepancies are detected. Disable this option to skip the additional checks.

Default: false

Required: false

Data type: boolean

httpSessionDatabase

Controls how HTTP sessions are persisted to a database.

PID: com.ibm.ws.session.db.

Attributes

dataSourceRef

The identifier of the data source the session manager should use to persist HTTP session data.

Required: true

Data type: string

tableName

The database table name.

Default: sessions

Required: false

Data type: string

useMultiRowSchema

When enabled, each session data attribute is placed in a separate row in the database, allowing larger amounts of data to be stored for each session. This configuration can yield better performance when session attributes are very large and few changes are required to the session attributes. When disabled, all session data attributes are placed in the same row for each session.

Default: false

Required: false

Data type: boolean

skipIndexCreation

Set this property to "true" to disable index creation on server startup. This custom property should only be used to manually create our own database indices for session persistence. However, IBM recommends that you let session manager create database indices. Before enabling this property, verify the correct index does exist on the session database.

Default: false

Required: false

Data type: boolean

writeFrequency

Specifies when session data is written to the persistent store. By default, session data is written to the persistent store after the servlet completes execution. Changing this value can improve performance in some environments.

Default: END_OF_SERVLET_SERVICE

e:

END_OF_SERVLET_SERVICE

Session data is written to the persistent store after the servlet completes execution.

MANUAL_UPDATE

A programmatic sync on the IBMSession object is required to write the session data to the persistent store.

TIME_BASED_WRITE

Session data is written to the persistent store based on the specified write interval value.

Required: false

Data type: string

writeInterval

Number of seconds that should pass before writing session data to the persistent store. The default is 120 seconds. This value is only used when a time based write frequency is enabled.

Default: 120

Required: false

Data type: int

writeContents

Specifies how much session data should be written to the persistent store. By default, only updated attributes are written, but all attributes can be written instead (regardless of whether or not they changed).

Default: ONLY_UPDATED_ATTRIBUTES

Range:

ONLY_UPDATED_ATTRIBUTES

Only updated attributes are written to the persistent store.

ALL_SESSION_ATTRIBUTES

All attributes are written to the persistent store.

Required: false

Data type: string

scheduleInvalidation

Enable this option to reduce the number of database updates required to keep the HTTP sessions alive. Specify the two hours of a day when there is the least activity in the application server. When this option is disabled, the invalidator process runs every few minutes to remove invalidated HTTP sessions.

Default: false

Required: false

Data type: boolean

scheduleInvalidationFirstHour

Indicates the first hour during which the invalidated sessions are cleared from the persistent store. Specify this value as an integer between 0 and 23. This value is valid only when schedule invalidation is enabled.

Default: 0

Required: false

Data type: int

scheduleInvalidationSecondHour

Indicates the second hour during which the invalidated sessions are cleared from the persistent store. Specify this value as an integer between 0 and 23. This value is valid only when schedule invalidation is enabled.

Default: 0

Required: false

Data type: int

noAffinitySwitchBack

Set this property to "true" to maintain affinity to the new member even after original one comes back up. When a cluster member fails, its requests routed to a different cluster member, and sessions are activated in that other member. Thus, session affinity is maintained to the new member, and when failed cluster member comes back up, the requests for sessions that were created in the original cluster member are routed back to it. Allowed values are true or false, with the default being false. Set this property to true when we have distributed sessions configured with time-based write. Note that this property has no affect on the behavior when distributed sessions are not enabled.

Default: false

Required: false

Data type: boolean

useInvalidatedId

Set this property to "true" to reuse the incoming identifier if the session with that identifier was recently invalidated. This is a performance optimization because it prevents checking the persistent store.

Default: true

Required: false

Data type: boolean

onlyCheckInCacheDuringPreInvoke

A value of true indicates that the last access time of a session should only be updated if a request gets the session. A value of false indicates that the last access time of a session should be updated upon every request. Changing this value can improve performance in some environments.

Default: false

Required: false

Data type: boolean

optimizeCacheIdIncrements

If the user's browser session is moving back and forth across multiple web applications, we might see extra persistent store activity as the in-memory sessions for a web module are refreshed from the persistent store. As a result, the cache identifiers are continually increasing and the in-memory session attributes are overwritten by those of the persistent copy. Set this property to true to prevent the cache identifiers from continually increasing. A value of true indicates that the session manager should assess whether the in-memory session for a web module is older than the copy in persistent store. If the configuration is a cluster, ensure that the system times of each cluster member are as identical as possible.

Default: true

Required: false

Data type: boolean

db2RowSize

Table space page size configured for the sessions table, if using a DB2 database. Increasing this value can improve database performance in some environments.

Default: 4KB

Range:

4KB

Use the default table space page size of 4 KB. You do not need to create a DB2 buffer pool or table space, and we do not need to specify a table space name.

8KB

Use a table space page size of 8 KB. We must additionally create a DB2 buffer pool and table space, and specify 8KB as the page size for both. Also specify the name of the table space we created.

16KB

Use a table space page size of 16 KB. We must additionally create a DB2 buffer pool and table space, and specify 16KB as the page size for both. Also specify the name of the table space we created.

32KB

Use a table space page size of 32 KB. We must additionally create a DB2 buffer pool and table space, and specify 32KB as the page size for both. Also specify the name of the table space we created.

Required: false

Data type: string

tableSpaceName

Table space to be used for the sessions table. This value is only required when the DB2 Row Size is greater than 4KB.

Default:

Required: false

Data type: string

usingCustomSchemaName

Set this property to "true" if we are using DB2 for session persistence and the currentSchema property is set in the data source.

Default: false

Required: false

Data type: boolean

useOracleBlob

Set this property to "true" to create the database table using the Binary Large Object (BLOB) data type for the medium column. This value increases performance of persistent sessions when Oracle databases are used. Due to an Oracle restriction, BLOB support requires use of the Oracle Call Interface (OCI) database driver for more than 4000 bytes of data. Also ensure that a new sessions table is created before the server is restarted by dropping the old sessions table or by changing the datasource definition to reference a database that does not contain a sessions table.

Default: false

Required: false

Data type: boolean

idsLdapFilterProperties

Default IBM Tivoli Directory Server LDAP filters.

PID: com.ibm.ws.security.registry.ldap.internal.filters.ids.

Attributes

userFilter

An LDAP filter clause for searching the user registry for users.

Default: (&(uid=%v)(objectclass=ePerson))

Required: true

Data type: string

groupFilter

An LDAP filter clause for search the user registry for groups.

Default: (&(cn=%v)(|(objectclass=groupOfNames)(objectclass=groupOfUniqueNames)(objectclass=groupOfURLs)))

Required: true

Data type: string

userIdMap

An LDAP filter that maps the name of a user to an LDAP entry.

Default: *:uid

Required: true

Data type: string

groupIdMap

An LDAP filter that maps the name of a group to an LDAP entry.

Default: *:cn

Required: true

Data type: string

groupMemberIdMap

An LDAP filter that identifies user to group memberships.

Default: ibm-allGroups:member;ibm-allGroups:uniqueMember;groupOfNames:member;groupOfUniqueNames:uniqueMember

Required: true

Data type: string

include

Specify a configuration resource to include in the servers configuration.

Attributes

optional

Allow the included resource to be skipped if it cannot be found.

Required: false

Data type: boolean

location

The resource location, this could be a file path or a URI for a remote resource.

Required: true

Data type: string

iplanetLdapFilterProperties

Default Sun Java System Directory Server LDAP filters. PID is com.ibm.ws.security.registry.ldap.internal.filters.iPlanet.

Attributes

userFilter

An LDAP filter clause for searching the user registry for users.

Default: (&(uid=%v)(objectclass=inetOrgPerson))

Required: true

Data type: string

groupFilter

An LDAP filter clause for search the user registry for groups.

Default: (&(cn=%v)(objectclass=ldapsubentry))

Required: true

Data type: string

userIdMap

An LDAP filter that maps the name of a user to an LDAP entry.

Default: inetOrgPerson:uid

Required: true

Data type: string

groupIdMap

An LDAP filter that maps the name of a group to an LDAP entry.

Default: *:cn

Required: true

Data type: string

groupMemberIdMap

An LDAP filter that identifies user to group memberships.

Default: nsRole:nsRole

Required: true

Data type: string

jaasLoginContextEntry

The JAAS login context entry configuration.

PID: com.ibm.ws.security.authentication.internal.jaas.jaasLoginContextEntry.

Attributes

name

A unique name of a JAAS configuration entry.

Required: true

Data type: string

loginModuleRef

A reference to the ID of a JAAS login module.

Default: hashtable, userNameAndPassword, certificate, token

Required: false

Data type: List of configuration IDs of type jaasLoginModule (comma-separated string).

jaasLoginModule

A login module in the JAAS configuration.

PID: com.ibm.ws.security.authentication.internal.jaas.jaasLoginModuleConfig.

Attributes

className

Fully-qualified package name of the JAAS login module class.

Required: true

Data type: string

controlFlag

The login module's control flag. Valid values are REQUIRED, REQUISITE, SUFFICIENT, and OPTIONAL.

Default: REQUIRED

Range:

REQUIRED

This LoginModule is REQUIRED as per the JAAS specification. The LoginModule is required to succeed.

REQUISITE

controlFlag.REQUISITE

SUFFICIENT

This LoginModule is SUFFICIENT as per the JAAS specification. The LoginModule is not required to succeed. If authentication is successful, no other LoginModules will be called and control is returned to the caller.

OPTIONAL

This LoginModule is OPTIONAL as per the JAAS specification. The LoginModule is not required to succeed.

Required: true

Data type: string

libraryRef

A reference to the ID of the shared library configuration.

Required: false

Data type: Configuration ID of type library (string).

Sub-elements

library

A reference to the ID of the shared library configuration.

Required: false

Data type: Element of type library.

options

A collection of JAAS Login module options

Required: false

jdbcDriver

Identifies a JDBC driver.

PID: com.ibm.ws.jdbc.jdbcDriver.

Attributes

libraryRef

Identifies JDBC driver JARs and native files.

Required: false

Data type: Configuration ID of type library (string).

javax.sql.XADataSource

JDBC driver implementation of javax.sql.XADataSource.

Required: false

Data type: string

javax.sql.ConnectionPoolDataSource

JDBC driver implementation of javax.sql.ConnectionPoolDataSource.

Required: false

Data type: string

javax.sql.DataSource

JDBC driver implementation of javax.sql.DataSource.

Required: false

Data type: string

Sub-elements

library

Identifies JDBC driver JARs and native files.

Required: false

Data type: Element of type library.

jeeMetadataContext

Makes the namespace of the application component that submits a contextual task available to the task.

PID: com.ibm.ws.javaee.metadata.context, and it is the child of complex type "contextService".

jndiEntry

A single entry in the JNDI default namespace.

PID: com.ibm.ws.jndi.internal.JNDIEntry.

Attributes

jndiName

The JNDI name to use for this entry.

Required: true

Data type: string

value

The JNDI value to associate with the name.

Required: true

Data type: string

jpa

Configuration properties for the Java Persistence API container.

PID: com.ibm.ws.jpacomponent.

Attributes

defaultJtaDataSourceJndiName

Default Java Transaction API (JTA) data source JNDI name to be used by applications running in this server. By default, data sources are JTA. Only data sources that are transactional are allowed in this field.

Default:

Required: false

Data type: string

defaultNonJtaDataSourceJndiName

Default non-transactional data source JNDI name to be used by applications running in this server. Only data sources that have been marked as non-transactional are allowed in this field.

Default:

Required: false

Data type: string

defaultPersistenceProvider

Default persistence provider.

Default: com.ibm.websphere.persistence.PersistenceProviderImpl

Required: false

Data type: string

entityManagerPoolCapacity

EntityManager pool capacity per PersistenceContext reference. The minimum is 0 and the maximum is 500.

Default: -1

Required: false

Data type: int

Sub-elements

excludedApplication

An application to be excluded from JPA processing.

Default:

Required: false

Data type: string

jspEngine

JSP 2.2 configuration.

PID: com.ibm.ws.jsp.2.2.

Attributes

disableJspRuntimeCompilation

Disable compilation of JSPs at runtime.

Default: false

Required: false

Data type: boolean

extendedDocumentRoot

Directory that the JSP engine will search for additional JSP files to serve.

Default:

Required: false

Data type: string

jdkSourceLevel

Default Java source level for JSPs compiled by the JSP engine.

Default: 15

Range:

13




14




15




16




Required: false

Data type: string

keepGenerated

Keep Java source files generated for JSPs.

Default: false

Required: false

Data type: boolean

useInMemory

Generate Java source and classes in memory (without writing to disk).

Default: false

Required: false

Data type: boolean

recompileJspOnRestart

Recompile JSPs after an application is restarted. JSPs are recompiled on first access.

Default: false

Required: false

Data type: boolean

useImplicitTagLibs

Allow JSPs to use jsx and tsx tag libs.

Default: true

Required: false

Data type: boolean

disableResourceInjection

Disable injection of resources into JSPs.

Default: false

Required: false

Data type: boolean

prepareJSPs

When this attribute is present, all JSPs larger than the value (in kilobytes) are compiled at application server startup. Set this to 0 to compile all JSPs.

Required: false

Data type: int

keyStore

A repository of security certificates used for SSL encryption.

PID: com.ibm.ws.ssl.keystore.

Attributes

password

The password used to load the keystore file. Stored in clear text or encoded form. Use the securityUtility tool to encode the password.

Required: true

Data type: password (string)

location

An absolute or relative path to the keystore file. If a relative path is provided, the server will attempt to locate the file in the ${server.config.dir}/resources/security directory. Use the keystore file for a file-based keystore, the keyring name for SAF keyrings, or the device configuration file for hardware cryptography devices. In the SSL minimal configuration, the location of the file is assumed to be ${server.config.dir}/resources/security/key.jks.

Default: ${server.output.dir}/resources/security/key.jks

Required: false

Data type: string

type

A keystore type supported by the target SDK.

Default: jks

Required: false

Data type: string

ldapRegistry

Configuration properties for the LDAP user registry. PID is com.ibm.ws.security.registry.ldap.config.

Attributes

host

Address of the LDAP server in the form of an IP address or a domain name service (DNS) name.

Required: true

Data type: string

port

Port number of the LDAP server.

Required: true

Data type: int

baseDN

Base distinguished name (DN) of the directory service, which indicates the starting point for LDAP searches in the directory service.

Required: true

Data type: string

ldapType

Type of LDAP server to which a connection will be established.

Range:

Microsoft Active Directory

actived

Custom




IBM Lotus Domino

domino50

Novell eDirectory

edirectory

IBM Tivoli Directory Server

ibm_dir_server

Sun Java System Directory Server

iplanet

Netscape Directory Server

netscape

IBM SecureWay Directory Server

secureway

Required: true

Data type: string

realm

The realm name that represents the user registry.

Default: LdapRegistry

Required: false

Data type: string

bindDN

Distinguished name (DN) for the application server, which is used to bind to the directory service.

Required: false

Data type: string

bindPassword

Password for the bind DN. 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.

Required: false

Data type: password (string)

ignoreCase

Perform a case-insensitive authentication check.

Default: true

Required: false

Data type: boolean

recursiveSearch

Performs a nested group search. Select this option only if the LDAP server does not support recursive server-side searches.

Default: false

Required: false

Data type: boolean

reuseConnection

Requests the application server to reuse the LDAP server connection.

Default: true

Required: false

Data type: boolean

sslEnabled

Indicates whether an SSL connection should be made to the LDAP server.

Default: false

Required: false

Data type: boolean

sslRef

ID of the SSL configuration to be used to connect to the SSL-enabled LDAP server.

Required: false

Data type: string

searchTimeout

Maximum time for an LDAP server to respond before a request is canceled. This is equivalent to a read timeout once the connection is established. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Default: 1m

Required: false

Data type: string

connectTimeout

Maximum time for establishing a connection to the LDAP server. A error message will be logged if the specified time expires. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Default: 1m

Required: false

Data type: string

certificateMapMode

Whether to map x.509 certificates into an LDAP directory by EXACT_DN or CERTIFICATE_FILTER. Specify CERTIFICATE_FILTER to use the specified certificate filter for the mapping.

Range:

EXACT_DN

exactDN

CERTIFICATE_FILTER

certFilter

Required: false

Data type: string

certificateFilter

Filter certificate mapping property for the LDAP filter. The filter is used to map attributes in the client certificate to entries in the LDAP registry. For example, the filter can be specified as: uid=${SubjectCN}.

Required: false

Data type: string

activedFiltersRef

Default Microsoft Active Directory LDAP filters.

Required: false

Data type: Configuration ID of type activedLdapFilterProperties (string).

customFiltersRef

Default Custom LDAP filters.

Required: false

Data type: Configuration ID of type customLdapFilterProperties (string).

domino50FiltersRef

Default IBM Lotus Domino LDAP filters.

Required: false

Data type: Configuration ID of type domino50LdapFilterProperties (string).

edirectoryFiltersRef

List of Novell eDirectory LDAP filters.

Required: false

Data type: Configuration ID of type edirectoryLdapFilterProperties (string).

idsFiltersRef

Default IBM Tivoli Directory Server LDAP filters.

Required: false

Data type: Configuration ID of type idsLdapFilterProperties (string).

iplanetFiltersRef

Default Sun Java System Directory Server LDAP filters.

Required: false

Data type: Configuration ID of type iplanetLdapFilterProperties (string).

netscapeFiltersRef

Default Netscape Directory Server LDAP filters.

Required: false

Data type: Configuration ID of type netscapeLdapFilterProperties (string).

securewayFiltersRef

Default IBM SecureWay Directory Server LDAP filters.

Required: false

Data type: Configuration ID of type securewayLdapFilterProperties (string).

returnToPrimaryServer

A boolean value that indicates if the search should be done against the Primary Server.

Default: true

Required: false

Data type: boolean

Sub-elements

failoverServers

List of LDAP failover servers.

Required: false

Data type: List of LDAP failover servers.

name

Configuration properties for LDAP failover servers. Specify it as a backup server for the primary LDAP servers. For example, <failoverServers name="failoverLdapServers"><server host="myfullyqualifiedhostname1" port="389"/><server host="myfullyqualifiedhostname2" port="389"/></failoverServers>

Required: false

Data type: string

server

Configuration properties for LDAP failover server.

Required: false

Data type: Configuration properties for LDAP failover server.

host

LDAP server host name, which can be either an IP address or a domain name service (DNS) name.

Required: true

Data type: string

port

LDAP failover server port.

Required: true

Data type: int

activedFilters

Default Microsoft Active Directory LDAP filters.

Required: false

Data type: Element of type activedLdapFilterProperties.

customFilters

Default Custom LDAP filters.

Required: false

Data type: Element of type customLdapFilterProperties.

domino50Filters

Default IBM Lotus Domino LDAP filters.

Required: false

Data type: Element of type domino50LdapFilterProperties.

edirectoryFilters

List of Novell eDirectory LDAP filters.

Required: false

Data type: Element of type edirectoryLdapFilterProperties.

idsFilters

Default IBM Tivoli Directory Server LDAP filters.

Required: false

Data type: Element of type idsLdapFilterProperties.

iplanetFilters

Default Sun Java System Directory Server LDAP filters.

Required: false

Data type: Element of type iplanetLdapFilterProperties.

netscapeFilters

Default Netscape Directory Server LDAP filters.

Required: false

Data type: Element of type netscapeLdapFilterProperties.

securewayFilters

Default IBM SecureWay Directory Server LDAP filters.

Required: false

Data type: Element of type securewayLdapFilterProperties.

contextPool

Properties of the context pool.

Required: false

Data type: Configure the attributes of the context pool.

enabled

A boolean value that determines if the context pool is enabled. Disabling it can cause performance degradation.

Default: true

Required: false

Data type: boolean

initialSize

An integer value that determines the initial size of the context pool. Set this based on the load on the repository.

Default: 1

Required: false

Data type: int

maxSize

An integer value that defines the maximum context pool size. Set this based on maximum load on the repository.

Default: 0

Required: false

Data type: int

timeout

The duration after which the context pool times out. An integer that represents the time that an idle context instance can remain in the pool without being closed and removed from the pool.

Default: 0

Required: false

Data type: int

waitTime

The duration after which the context pool times out. The time interval that the request waits until the context pool checks again if an idle context instance is available in the pool when the number of context instances reaches the maximum pool size.

Default: 3000

Required: false

Data type: int

preferredSize

The preferred size of the context pool. Set this based on the load on the repository.

Default: 3

Required: false

Data type: int

ldapCache

Configure the attributes of the cache.

Required: false

Data type: Configure the attributes of the cache.

attributesCache

The attribute cache properties configuration.

Required: false

Data type: The attribute cache properties.

enabled

A Boolean value to indicate that the property is enabled.

Default: true

Required: false

Data type: boolean

size

The size of the cache. The number of search results stored in the cache. This needs to be configured based on number of search queries executed on the system and the hardware system resources available.

Default: 2000

Required: false

Data type: int

timeout

The duration after which the context pool times out. An integer that represents the time that an idle context instance can remain in the pool without being closed and removed from the pool.

Default: 1200

Required: false

Data type: int

sizeLimit

The size limit for the cache.

Default: 2000

Required: false

Data type: int

serverTTLAttribute

The time after which a cache entry expires. The subsequent call for this entry will be fetched directly from the server and then placed again in the cache.

Required: false

Data type: string

searchResultsCache

The configuration for the search results cache.

Required: false

Data type: The cache for the search results.

enabled

A Boolean value to indicate that the property is enabled.

Default: true

Required: false

Data type: boolean

size

The size of the cache. The number of search results stored in the cache. This needs to be configured based on number of search queries executed on the system and the hardware system resources available.

Default: 2000

Required: false

Data type: int

timeout

The time interval until which the search operation should be performed.

Default: 1200

Required: false

Data type: int

resultsSizeLimit

The maximum number of results that can be returned in the search.

Required: false

Data type: int

library

Shared Library.

PID: com.ibm.ws.classloading.sharedlibrary.

Attributes

name

Name of shared library for administrators

Required: false

Data type: string

description

Description of shared library for administrators

Required: false

Data type: string

filesetRef

Id of referenced Fileset

Required: false

Data type: List of configuration IDs of type fileset (comma-separated string).

apiTypeVisibility

The types of API package this library's class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party.

Default: spec,ibm-api,api

Required: false

Data type: string

Sub-elements

fileset

Id of referenced Fileset

Required: false

Data type: Element of type fileset.

folder

Id of referenced folder

Required: false

Data type: Folder containing resources such as .properties and .class files.

dir

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

Required: true

Data type: string

file

Id of referenced File

Required: false

Data type: Add a file to be included in this library.

name

Fully qualified filename

Required: true

Data type: string

logging

Controls the capture and output of log and trace messages.

PID: com.ibm.ws.logging.

Attributes

maxFileSize

Maximum size of a log file, in megabytes, before being rolled over; a value of 0 means no limit.

Inherits: com.ibm.ws.logging.max.file.size

Default: 20

Required: false

Data type: int

maxFiles

Maximum number of log files that will be kept, before the oldest file is removed; a value of 0 means no limit.

Inherits: com.ibm.ws.logging.max.files

Default: 2

Required: false

Data type: int

logDirectory

Location of the directory for log files. The default value is ${server.output.dir}/logs.

Inherits: com.ibm.ws.logging.log.directory

Default: ${server.output.dir}/logs

Required: false

Data type: string

messageFileName

Name of the file to which message output will be written relative to the configured log directory. The default value is messages.log.

Inherits: com.ibm.ws.logging.message.file.name

Default: messages.log

Required: false

Data type: string

traceFileName

Name of the file to which trace output will be written relative to the configured log directory. The default value is trace.log.

Inherits: com.ibm.ws.logging.trace.file.name

Default: trace.log

Required: false

Data type: string

traceSpecification

A trace specification that conforms to the trace specification grammar and specifies the initial state for various trace components. An empty value is allowed and treated as 'disable all trace'. Any component that is not specified is initialized to a default state of *=info.

Inherits: com.ibm.ws.logging.trace.specification

Default: *=info

Required: false

Data type: string

traceFormat

This format is used for the trace log.

Inherits: com.ibm.ws.logging.trace.format

Default: ENHANCED

Range:

BASIC

Use the basic trace format.

ENHANCED

Use the enhanced basic trace format.

ADVANCED

Use the advanced trace format.

Required: false

Data type: string

consoleLogLevel

The logging level used to filter messages written to system streams. The default value is audit.

Inherits: com.ibm.ws.logging.console.log.level

Default: AUDIT

Range:

INFO

Info, audit, and warning messages will be written to the system output stream. Error messages will be written to the system error stream.

AUDIT

Audit and warning messages will be written to the system output stream. Error messages will be written to the system error stream.

WARNING

Warning messages will be written to the system output stream. Error messages will be written to the system error stream.

ERROR

Error messages will be written to the system error stream.

OFF

No server output will be written to system streams. Only JVM output will be written to system streams.

Required: false

Data type: string

copySystemStreams

If true, write System.out to the system output stream and System.err to the system error stream. If false, System.out and System.err will write to configured logs like messages.log or trace.log, but not to the system streams. The default value is true.

Inherits: com.ibm.ws.logging.copy.system.streams

Default: true

Required: false

Data type: boolean

suppressSensitiveTrace

The server trace can expose sensitive data when tracing untyped data, such as bytes received over a network connection. If true, prevent potentially sensitive information from being exposed in log and trace files. The default value is false.

Default: false

Required: false

Data type: boolean

ltpa

Lightweight Third Party Authentication (LTPA) token configuration.

PID: com.ibm.ws.security.token.ltpa.LTPAConfiguration.

Attributes

keysFileName

Path of the file containing the token keys.

Default: ${server.output.dir}/resources/security/ltpa.keys

Required: false

Data type: string

keysPassword

Password for the token keys. Stored in clear text or encoded form. It is recommended to encode the password, use the securityUtility tool with the encode option.

Default: {xor}CDo9Hgw=

Required: false

Data type: password (string)

expiration

Amount of time after which a token expires in minutes. Specify a positive integer followed by a unit of time, which can be hours (h) or minutes (m). For example, specify 30 minutes as 30m. We can include multiple values in a single entry. For example, 1h30m is equivalent to 90 minutes.

Default: 120m

Required: false

Data type: string

monitorInterval

Rate at which the server checks for updates to the LTPA token keys file. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Default: 0ms

Required: false

Data type: string

managedExecutorService

Managed executor service.

PID: com.ibm.ws.concurrent.managedExecutorService.

Attributes

contextServiceRef

Configures how context is propagated to threads

Default: DefaultContextService

Required: false

Data type: Configuration ID of type contextService (string).

jndiName

JNDI name for a managed executor service

Required: false

Data type: string

Sub-elements

contextService

Configures how context is propagated to threads

Default: DefaultContextService

Required: false

Data type: Element of type contextService.

member

Members of an external cache group that are controlled by WebSphere Application Server.

PID: com.ibm.ws.cache.cacheGroup.member, and it is the child of complex type "cacheGroup".

Attributes

host

Fully qualified host name

Required: false

Data type: string

port

Port.

Required: false

Data type: int

Sub-elements

adapterBeanName

Name of a class, which is located on the WebSphere Application Server class path, of the adapter between WebSphere Application Server and this external cache.

Required: true

Data type: string

mimeTypes

Definition of mime types shared by all http virtual hosts.

PID: com.ibm.ws.http.mimetype.

Sub-elements

type

Definition of mime type as id=value. Use the extension as the id, and the associated type as the value.

Required: false

Data type: string

monitor

Configuration for Monitoring Feature which includes enabled traditional PMI ,FineGrained and any future configurations updates.

PID: com.ibm.ws.monitor.internal.MonitoringFrameworkExtender.

Attributes

enableTraditionalPMI

Property to enable or disable Traditional PMI way of reporting.

Default: false

Required: false

Data type: boolean

filter

Allows user to enable/disable monitors based on group name such as webcontainer,jvm,threadpool and so on.

Default:

Required: false

Data type: string

netscapeLdapFilterProperties

Default Netscape Directory Server LDAP filters.

PID: com.ibm.ws.security.registry.ldap.internal.filters.netscape.

Attributes

userFilter

An LDAP filter clause for searching the user registry for users.

Default: (&(uid=%v)(objectclass=inetOrgPerson))

Required: true

Data type: string

groupFilter

An LDAP filter clause for search the user registry for groups.

Default: (&(cn=%v)(|(objectclass=groupOfNames)(objectclass=groupOfUniqueNames)))

Required: true

Data type: string

userIdMap

An LDAP filter that maps the name of a user to an LDAP entry.

Default: inetOrgPerson:uid

Required: true

Data type: string

groupIdMap

An LDAP filter that maps the name of a group to an LDAP entry.

Default: *:cn

Required: true

Data type: string

groupMemberIdMap

An LDAP filter that identifies user to group memberships.

Default: groupOfNames:member;groupOfUniqueNames:uniqueMember

Required: true

Data type: string

oauth-roles

OAuth web application security role map.

PID: com.ibm.ws.security.oauth20.roles.

Sub-elements

authenticated

Required: false

Data type: Security role for authorization code and token requests.

user

Required: false

Data type: User who has the security role.

name

Name of a user who has the security role.

Required: true

Data type: string

access-ied

A user access ID in the general form user:realmName/userUniqueId. A value will be generated if one is not specified.

Required: false

Data type: string

group

Required: false

Data type: Group that has the security role.

name

Name of a group that has the security role.

Required: true

Data type: string

access-ied

A group access ID in the general form group:realmName/groupUniqueId. A value will be generated if one is not specified.

Required: false

Data type: string

special-subject

Required: false

Data type: Special subject that has the security role.

type

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

Range:

ALL_AUTHENTICATED_USERS

All authenticated users.

EVERYONE

All users for every request, even if the request was not authenticated.

Required: true

Data type: string

clientManager

Required: false

Data type: Security role for client management requests.

user

Required: false

Data type: User who has the security role.

name

Name of a user who has the security role.

Required: true

Data type: string

access-ied

A user access ID in the general form user:realmName/userUniqueId. A value will be generated if one is not specified.

Required: false

Data type: string

group

Required: false

Data type: Group that has the security role.

name

Name of a group that has the security role.

Required: true

Data type: string

access-ied

A group access ID in the general form group:realmName/groupUniqueId. A value will be generated if one is not specified.

Required: false

Data type: string

special-subject

Required: false

Data type: Special subject that has the security role.

type

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

Range:

ALL_AUTHENTICATED_USERS

All authenticated users.

EVERYONE

All users for every request, even if the request was not authenticated.

Required: true

Data type: string

oauthProvider

OAuth provider definition.

PID: com.ibm.ws.security.oauth20.provider.

Attributes

authorizationGrantLifetime

Authorization grant lifetime (seconds). The equivalent provider parameter in the full application server profile is oauth20.max.authorization.grant.lifetime.seconds. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 604800

Required: false

Data type: string

authorizationCodeLifetime

Authorization code lifetime (seconds). The equivalent provider parameter in the full application server profile is oauth20.code.lifetime.seconds. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 60

Required: false

Data type: string

authorizationCodeLength

Length of the generated authorization code. The equivalent provider parameter in the full application server profile is oauth20.code.length.

Default: 30

Required: false

Data type: long

accessTokenLifetime

Time that access token is valid (seconds). The equivalent provider parameter in the full application server profile is oauth20.token.lifetime.seconds. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 3600

Required: false

Data type: string

accessTokenLength

Length of the generated OAuth access token. The equivalent provider parameter in the full application server profile is oauth20.access.token.length.

Default: 40

Required: false

Data type: long

issueRefreshToken

A value of false disables generation and the use of refresh tokens. The equivalent provider parameter in the full application server profile is oauth20.issue.refresh.token.

Default: true

Required: false

Data type: boolean

refreshTokenLength

Length of generated refresh token. The equivalent provider parameter in the full application server profile is oauth20.refresh.token.length.

Default: 50

Required: false

Data type: long

libraryRef

Reference to shared library containing the mediator plugin class.

Required: false

Data type: Configuration ID of type library (string).

allowPublicClients

A value of false disables the access of public clients as detailed in the OAuth specification. The equivalent provider parameter in the full application server profile is oauth20.allow.public.clients.

Default: false

Required: false

Data type: boolean

authorizationFormTemplate

URL of a custom authorization page template. The equivalent provider parameter in the full application server profile is oauth20.authorization.form.template.

Default: template.html

Required: false

Data type: string

authorizationErrorTemplate

URL of a custom authorization error page template. The equivalent provider parameter in the full application server profile is oauth20.authorization.error.template.

Default:

Required: false

Data type: string

customLoginURL

URL of a custom login page. The equivalent provider parameter in the full application server profile is oauth20.authorization.loginURL.

Default: login.jsp

Required: false

Data type: string

autoAuthorizeParam

To use auto authorization, append the autoAuthorize parameter to requests with a value of true. The equivalent provider parameter in the full application server profile is oauth20.autoauthorize.param.

Default: autoauthz

Required: false

Data type: string

clientURISubstitutions

Optional value to replace client URI strings for dynamic hostnames. The equivalent provider parameter in the full application server profile is oauth20.client.uri.substitutions.

Required: false

Data type: string

clientTokenCacheSize

Maximum number of entries in the client token cache. The equivalent provider parameter in the full application server profile is oauth20.token.userClientTokenLimit.

Required: false

Data type: long

filter

URI filter selects requests to be authorized by this provider. The equivalent provider parameter in the full application server profile is Filter.

Required: false

Data type: string

characterEncoding

characterEncoding.desc

Required: false

Data type: string

oauthOnly

If the value is true, then requests matching the filter must have an access token or they will be failed. If false, then matching requests will be checked for other authentication data if no access token is present. The equivalent provider parameter in the full application server profile is oauthOnly.

Default: true

Required: false

Data type: boolean

includeTokenInSubject

If the value is true, add the com.ibm.wsspi.security.oauth20.token.WSOAuth20Token as a private credential. The equivalent provider parameter in the full application server profile is includeToken.

Default: true

Required: false

Data type: boolean

Sub-elements

localStore

Required: false

Data type: Clients are defined in server.xml and tokens are cached in the server.

tokenStoreSize

Token store size

Default: 2000

Required: false

Data type: long

client

Required: false

Data type: OAuth client definition. Only clients defined here can access the provider.

name

Name of the client (sometimes referred to as the Id).

Required: false

Data type: string

secret

Secret key of the client.

Required: false

Data type: password (string)

displayname

Display name of the client.

Required: false

Data type: string

redirect

URL to redirect the client's requests to.

Required: false

Data type: string

enabled

Client is enabled if true, disabled if false.

Default: true

Required: false

Data type: boolean

databaseStore

Required: false

Data type: Clients are defined and tokens are cached in the database.

dataSourceRef

Reference to the data source for the store.

Required: false

Data type: Configuration ID of type dataSource (string).

cleanupExpiredTokenInterval

Expired token cleanup interval (seconds). The equivalent provider parameter in the full application server profile is oauthjdbc.CleanupInterval. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 3600

Required: false

Data type: string

user

User

Required: false

Data type: string

password

Password used to access the database.

Required: false

Data type: password (string)

dataSource

Reference to the data source for the store.

Required: false

Data type: Element of type dataSource.

library

Reference to shared library containing the mediator plugin class.

Required: false

Data type: Element of type library.

mediatorClassname

Mediator plugin class name. The equivalent provider parameter in the full application server profile is oauth20.mediator.classnames.

Required: false

Data type: string

grantType

An access token grant type (as detailed in the OAuth specification) that is allowed for the provider. The equivalent provider parameter in the full application server profile is oauth20.grant.types.allowed.

Required: false

Data type: string

autoAuthorizeClient

Name of a client that is allowed to use auto authorization. The equivalent provider parameter in the full application server profile is oauth20.autoauthorize.clients.

Required: false

Data type: string

osgiApplication

Defines the properties of an osgi application.

PID: com.ibm.ws.app.manager.osgiappcfg.

Attributes

name

Name of an application.

Required: false

Data type: string

location

Location of an application expressed as an absolute path or a path relative to the server-level apps directory.

Required: true

Data type: string

type

Type of application archive.

Required: false

Data type: string

autoStart

Indicates whether or not the server should start the application automatically when the server starts.

Default: true

Required: false

Data type: boolean

pluginConfiguration

Generate plugin configuration.

PID: com.ibm.ws.generatePluginConfig.

Attributes

pluginInstallRoot

Web container plugin installation location in file system

Default: .

Required: false

Data type: string

webserverPort

Web server HTTP port

Default: 80

Required: false

Data type: string

webserverSecurePort

Web server HTTPS port

Default: 443

Required: false

Data type: string

sslKeyringLocation

Location of SSL keyring

Default: keyring.kdb

Required: false

Data type: string

sslStashfileLocation

Location of SSL stashfile

Default: keyring.sth

Required: false

Data type: string

sslCertlabel

SSL cert label

Default: LibertyCert

Required: false

Data type: string

ipv6Preferred

IPv6 is preferred

Default: false

Required: false

Data type: boolean

properties

List of JDBC vendor properties for the data source. For example, databaseName="dbname" serverName="localhost" portNumber="50000".

PID: com.ibm.ws.jdbc.dataSource.properties, and it is the child of complex type "dataSource".

Attributes

databaseName

JDBC driver property: databaseName.

Required: false

Data type: string

serverName

Server where the database is running.

Required: false

Data type: string

portNumber

Port on which to obtain database connections.

Required: false

Data type: int

URL

URL for connecting to the database.

Required: false

Data type: string

user

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: string

password

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: password (string)

properties.datadirect.sqlserver

Data source properties for the DataDirect Connect for JDBC driver for Microsoft SQL Server.

PID: com.ibm.ws.jdbc.dataSource.properties.datadirect.sqlserver, and it is the child of complex type "dataSource".

Attributes

databaseName

JDBC driver property: databaseName.

Required: false

Data type: string

serverName

Server where the database is running.

Default: localhost

Required: false

Data type: string

portNumber

Port on which to obtain database connections.

Default: 1433

Required: false

Data type: int

accountingInfo

JDBC driver property: accountingInfo.

Required: false

Data type: string

alternateServers

JDBC driver property: alternateServers.

Required: false

Data type: string

alwaysReportTriggerResults

JDBC driver property: alwaysReportTriggerResults.

Required: false

Data type: boolean

applicationName

JDBC driver property: applicationName.

Required: false

Data type: string

authenticationMethod

JDBC driver property: authenticationMethod.

Range:

auto




kerberos




ntlm




userIdPassword




Required: false

Data type: string

bulkLoadBatchSize

JDBC driver property: bulkLoadBatchSize.

Required: false

Data type: long

bulkLoadOptions

JDBC driver property: bulkLoadOptions.

Required: false

Data type: long

clientHostName

JDBC driver property: clientHostName.

Required: false

Data type: string

clientUser

JDBC driver property: clientUser.

Required: false

Data type: string

codePageOverride

JDBC driver property: codePageOverride.

Required: false

Data type: string

connectionRetryCount

JDBC driver property: connectionRetryCount.

Required: false

Data type: int

connectionRetryDelay

JDBC driver property: connectionRetryDelay. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

convertNull

JDBC driver property: convertNull.

Required: false

Data type: int

dateTimeInputParameterType

JDBC driver property: dateTimeInputParameterType.

Range:

auto




dateTime




dateTimeOffset




Required: false

Data type: string

dateTimeOutputParameterType

JDBC driver property: dateTimeOutputParameterType.

Range:

auto




dateTime




dateTimeOffset




Required: false

Data type: string

describeInputParameters

JDBC driver property: describeInputParameters.

Range:

describeAll




describeIfDateTime




describeIfString




noDescribe




Required: false

Data type: string

describeOutputParameters

JDBC driver property: describeOutputParameters.

Range:

describeAll




describeIfDateTime




describeIfString




noDescribe




Required: false

Data type: string

enableBulkLoad

JDBC driver property: enableBulkLoad.

Required: false

Data type: boolean

enableCancelTimeout

JDBC driver property: enableCancelTimeout.

Required: false

Data type: boolean

encryptionMethod

JDBC driver property: encryptionMethod.

Range:

noEncryption




loginSSL




requestSSL




SSL




Required: false

Data type: string

failoverGranularity

JDBC driver property: failoverGranularity.

Range:

atomic




atomicWithRepositioning




disableIntegrityCheck




nonAtomic




Required: false

Data type: string

failoverMode

JDBC driver property: failoverMode.

Range:

connect




extended




select




Required: false

Data type: string

failoverPreconnect

JDBC driver property: failoverPreconnect.

Required: false

Data type: boolean

hostNameInCertificate

JDBC driver property: hostNameInCertificate.

Required: false

Data type: string

initializationString

JDBC driver property: initializationString.

Required: false

Data type: string

insensitiveResultSetBufferSize

JDBC driver property: insensitiveResultSetBufferSize.

Required: false

Data type: int

javaDoubleToString

JDBC driver property: javaDoubleToString.

Required: false

Data type: boolean

JDBCBehavior

JDBC driver property: JDBCBehavior. Values are: 0 (JDBC 4.0) or 1 (JDBC 3.0).

Default: 0

Range:

0

JDBC 4.0

1

JDBC 3.0

Required: false

Data type: int

loadBalancing

JDBC driver property: loadBalancing.

Required: false

Data type: boolean

loginTimeout

JDBC driver property: loginTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

longDataCacheSize

JDBC driver property: longDataCacheSize.

Required: false

Data type: int

netAddress

JDBC driver property: netAddress.

Required: false

Data type: string

packetSize

JDBC driver property: packetSize.

Required: false

Data type: int

password

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: password (string)

queryTimeout

JDBC driver property: queryTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

resultsetMetaDataOptions

JDBC driver property: resultsetMetaDataOptions.

Required: false

Data type: int

selectMethod

JDBC driver property: selectMethod.

Range:

cursor




direct




Required: false

Data type: string

snapshotSerializable

JDBC driver property: snapshotSerializable.

Required: false

Data type: boolean

spyAttributes

JDBC driver property: spyAttributes.

Required: false

Data type: string

stringInputParameterType

JDBC driver property: stringInputParameterType.

Default: varchar

Range:

nvarchar




varchar




Required: false

Data type: string

stringOutputParameterType

JDBC driver property: stringOutputParameterType.

Default: varchar

Range:

nvarchar




varchar




Required: false

Data type: string

suppressConnectionWarnings

JDBC driver property: suppressConnectionWarnings.

Required: false

Data type: boolean

transactionMode

JDBC driver property: transactionMode.

Range:

explicit




implicit




Required: false

Data type: string

truncateFractionalSeconds

JDBC driver property: truncateFractionalSeconds.

Required: false

Data type: boolean

trustStore

JDBC driver property: trustStore.

Required: false

Data type: string

trustStorePassword

JDBC driver property: trustStorePassword.

Required: false

Data type: password (string)

user

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: string

useServerSideUpdatableCursors

JDBC driver property: useServerSideUpdatableCursors.

Required: false

Data type: boolean

validateServerCertificate

JDBC driver property: validateServerCertificate.

Required: false

Data type: boolean

XATransactionGroup

JDBC driver property: XATransactionGroup.

Required: false

Data type: string

XMLDescribeType

JDBC driver property: XMLDescribeType.

Range:

longvarbinary




longvarchar




Required: false

Data type: string

properties.db2.i.native

Data source properties for the IBM DB2 for i Native JDBC driver.

PID: com.ibm.ws.jdbc.dataSource.properties.db2.i.native, and it is the child of complex type "dataSource".

Attributes

databaseName

JDBC driver property: databaseName.

Default: *LOCAL

Required: false

Data type: string

access

JDBC driver property: access.

Default: all

Range:

all




read call




read only




Required: false

Data type: string

autoCommit

JDBC driver property: autoCommit.

Default: true

Required: false

Data type: boolean

batchStyle

JDBC driver property: batchStyle.

Default: 2.0

Range:

2.0




2.1




Required: false

Data type: string

behaviorOverride

JDBC driver property: behaviorOverride.

Required: false

Data type: int

blockSize

JDBC driver property: blockSize.

Default: 32

Range:

0




8




16




32




64




128




256




512




Required: false

Data type: int

cursorHold

JDBC driver property: cursorHold.

Default: false

Required: false

Data type: boolean

cursorSensitivity

JDBC driver property: cursorSensitivity. Values are: 0 (TYPE_SCROLL_SENSITIVE_STATIC), 1 (TYPE_SCROLL_SENSITIVE_DYNAMIC), 2 (TYPE_SCROLL_ASENSITIVE).

Default: asensitive

Range:

asensitive




sensitive




Required: false

Data type: string

dataTruncation

JDBC driver property: dataTruncation.

Default: true

Required: false

Data type: string

dateFormat

JDBC driver property: dateFormat.

Range:

dmy




eur




mdy




iso




jis




julian




usa




ymd




Required: false

Data type: string

dateSeparator

JDBC driver property: dateSeparator.

Range:

/

The forward slash character (/).

-

The dash character (-).

.

The period character (.).

,

The comma character (,).

b

The character b

Required: false

Data type: string

decimalSeparator

JDBC driver property: decimalSeparator.

Range:

.

The period character (.).

,

The comma character (,).

Required: false

Data type: string

directMap

JDBC driver property: directMap.

Default: true

Required: false

Data type: boolean

doEscapeProcessing

JDBC driver property: doEscapeProcessing.

Default: true

Required: false

Data type: boolean

fullErrors

JDBC driver property: fullErrors.

Required: false

Data type: boolean

libraries

JDBC driver property: libraries.

Required: false

Data type: string

lobThreshold

JDBC driver property: lobThreshold.

Default: 0

Required: false

Data type: int

lockTimeout

JDBC driver property: lockTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 0

Required: false

Data type: string

loginTimeout

JDBC driver property: loginTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

maximumPrecision

JDBC driver property: maximumPrecision.

Default: 31

Range:

31




63




Required: false

Data type: int

maximumScale

JDBC driver property: maximumScale.

Default: 31

Required: false

Data type: int

minimumDivideScale

JDBC driver property: minimumDivideScale.

Default: 0

Required: false

Data type: int

networkProtocol

JDBC driver property: networkProtocol.

Required: false

Data type: int

password

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: password (string)

portNumber

Port on which to obtain database connections.

Required: false

Data type: int

prefetch

JDBC driver property: prefetch.

Default: true

Required: false

Data type: boolean

queryOptimizeGoal

JDBC driver property: queryOptimizeGoal. Values are: 1 (*FIRSTIO) or 2 (*ALLIO).

Default: 2

Range:

1

*FIRSTIO

2

*ALLIO

Required: false

Data type: string

reuseObjects

JDBC driver property: reuseObjects.

Default: true

Required: false

Data type: boolean

serverName

Server where the database is running.

Required: false

Data type: string

serverTraceCategories

JDBC driver property: serverTraceCategories.

Default: 0

Required: false

Data type: int

systemNaming

JDBC driver property: systemNaming.

Default: false

Required: false

Data type: boolean

timeFormat

JDBC driver property: timeFormat.

Range:

eur




hms




iso




jis




usa




Required: false

Data type: string

timeSeparator

JDBC driver property: timeSeparator.

Range:

:

The colon character (:).

.

The period character (.).

,

The comma character (,).

b

The character b

Required: false

Data type: string

trace

JDBC driver property: trace.

Required: false

Data type: boolean

transactionTimeout

JDBC driver property: transactionTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 0

Required: false

Data type: string

translateBinary

JDBC driver property: translateBinary.

Default: false

Required: false

Data type: boolean

translateHex

JDBC driver property: translateHex.

Default: character

Range:

binary




character




Required: false

Data type: string

useBlockInsert

JDBC driver property: useBlockInsert.

Default: false

Required: false

Data type: boolean

user

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: string

properties.db2.i.toolbox

Data source properties for the IBM DB2 for i Toolbox JDBC driver.

PID: com.ibm.ws.jdbc.dataSource.properties.db2.i.toolbox, and it is the child of complex type "dataSource".

Attributes

serverName

Server where the database is running.

Required: true

Data type: string

databaseName

JDBC driver property: databaseName.

Required: false

Data type: string

access

JDBC driver property: access.

Default: all

Range:

all




read call




read only




Required: false

Data type: string

behaviorOverride

JDBC driver property: behaviorOverride.

Required: false

Data type: int

bidiImplicitReordering

JDBC driver property: bidiImplicitReordering.

Default: true

Required: false

Data type: boolean

bidiNumericOrdering

JDBC driver property: bidiNumericOrdering.

Default: false

Required: false

Data type: boolean

bidiStringType

JDBC driver property: bidiStringType.

Required: false

Data type: int

bigDecimal

JDBC driver property: bigDecimal.

Default: true

Required: false

Data type: boolean

blockCriteria

JDBC driver property: blockCriteria. Values are: 0 (no record blocking), 1 (block if FOR FETCH ONLY is specified), 2 (block if FOR UPDATE is specified).

Default: 2

Range:

0




1




2




Required: false

Data type: int

blockSize

JDBC driver property: blockSize.

Default: 32

Range:

0




8




16




32




64




128




256




512




Required: false

Data type: int

cursorHold

JDBC driver property: cursorHold.

Default: false

Required: false

Data type: boolean

cursorSensitivity

JDBC driver property: cursorSensitivity. Values are: 0 (TYPE_SCROLL_SENSITIVE_STATIC), 1 (TYPE_SCROLL_SENSITIVE_DYNAMIC), 2 (TYPE_SCROLL_ASENSITIVE).

Default: asensitive

Range:

asensitive




insensitive




sensitive




Required: false

Data type: string

dataCompression

JDBC driver property: dataCompression.

Default: true

Required: false

Data type: boolean

dataTruncation

JDBC driver property: dataTruncation.

Default: true

Required: false

Data type: boolean

dateFormat

JDBC driver property: dateFormat.

Range:

dmy




eur




mdy




iso




jis




julian




usa




ymd




Required: false

Data type: string

dateSeparator

JDBC driver property: dateSeparator.

Range:

/

The forward slash character (/).

-

The dash character (-).

.

The period character (.).

,

The comma character (,).

The space character ( ).

Required: false

Data type: string

decimalSeparator

JDBC driver property: decimalSeparator.

Range:

.

The period character (.).

,

The comma character (,).

Required: false

Data type: string

driver

JDBC driver property: driver.

Default: toolbox

Range:

native




toolbox




Required: false

Data type: string

errors

JDBC driver property: errors.

Default: basic

Range:

basic




full




Required: false

Data type: string

extendedDynamic

JDBC driver property: extendedDynamic.

Default: false

Required: false

Data type: boolean

extendedMetaData

JDBC driver property: extendedMetaData.

Default: false

Required: false

Data type: boolean

fullOpen

JDBC driver property: fullOpen.

Default: false

Required: false

Data type: boolean

holdInputLocators

JDBC driver property: holdInputLocators.

Default: true

Required: false

Data type: boolean

holdStatements

JDBC driver property: holdStatements.

Default: false

Required: false

Data type: boolean

isolationLevelSwitchingSupport

JDBC driver property: isolationLevelSwitchingSupport.

Default: false

Required: false

Data type: boolean

keepAlive

JDBC driver property: keepAlive.

Required: false

Data type: boolean

lazyClose

JDBC driver property: lazyClose.

Default: false

Required: false

Data type: boolean

libraries

JDBC driver property: libraries.

Required: false

Data type: string

lobThreshold

JDBC driver property: lobThreshold.

Default: 0

Required: false

Data type: int

loginTimeout

JDBC driver property: loginTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

maximumPrecision

JDBC driver property: maximumPrecision.

Default: 31

Range:

31




63

64

Required: false

Data type: int

maximumScale

JDBC driver property: maximumScale.

Default: 31

Required: false

Data type: int

metaDataSource

JDBC driver property: metaDataSource.

Default: 1

Required: false

Data type: int

minimumDivideScale

JDBC driver property: minimumDivideScale.

Default: 0

Required: false

Data type: int

naming

JDBC driver property: naming.

Default: sql

Range:

sql




system




Required: false

Data type: string

package

JDBC driver property: package.

Required: false

Data type: string

packageAdd

JDBC driver property: packageAdd.

Default: true

Required: false

Data type: boolean

packageCCSID

JDBC driver property: packageCCSID. Values are: 1200 (UCS-2) or 13488 (UTF-16).

Default: 13488

Range:

1200

1200 (UCS-2)

13488

13488 (UTF-16)

Required: false

Data type: int

packageCache

JDBC driver property: packageCache.

Default: false

Required: false

Data type: boolean

packageCriteria

JDBC driver property: packageCriteria.

Default: default

Range:

default




select




Required: false

Data type: string

packageError

JDBC driver property: packageError.

Default: warning

Range:

exception




warning




none




Required: false

Data type: string

packageLibrary

JDBC driver property: packageLibrary.

Default: QGPL

Required: false

Data type: string

password

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: password (string)

prefetch

JDBC driver property: prefetch.

Default: true

Required: false

Data type: boolean

prompt

JDBC driver property: prompt.

Default: false

Required: false

Data type: boolean

proxyServer

JDBC driver property: proxyServer.

Required: false

Data type: string

qaqqiniLibrary

JDBC driver property: qaqqiniLibrary.

Required: false

Data type: string

queryOptimizeGoal

JDBC driver property: queryOptimizeGoal. Values are: 1 (*FIRSTIO) or 2 (*ALLIO).

Default: 0

Required: false

Data type: int

receiveBufferSize

JDBC driver property: receiveBufferSize.

Required: false

Data type: int

remarks

JDBC driver property: remarks.

Default: system

Range:

sql




system




Required: false

Data type: string

rollbackCursorHold

JDBC driver property: rollbackCursorHold.

Default: false

Required: false

Data type: boolean

savePasswordWhenSerialized

JDBC driver property: savePasswordWhenSerialized.

Default: false

Required: false

Data type: boolean

secondaryUrl

JDBC driver property: secondaryUrl.

Required: false

Data type: string

secure

JDBC driver property: secure.

Default: false

Required: false

Data type: boolean

sendBufferSize

JDBC driver property: sendBufferSize.

Required: false

Data type: int

serverTraceCategories

JDBC driver property: serverTraceCategories.

Default: 0

Required: false

Data type: int

soLinger

JDBC driver property: soLinger. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

soTimeout

JDBC driver property: soTimeout. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Required: false

Data type: string

sort

JDBC driver property: sort.

Default: hex

Range:

hex




language




table




Required: false

Data type: string

sortLanguage

JDBC driver property: sortLanguage.

Required: false

Data type: string

sortTable

JDBC driver property: sortTable.

Required: false

Data type: string

sortWeight

JDBC driver property: sortWeight.

Range:

shared




unqiue

unique

Required: false

Data type: string

tcpNoDelay

JDBC driver property: tcpNoDelay.

Required: false

Data type: boolean

threadUsed

JDBC driver property: threadUsed.

Default: true

Required: false

Data type: boolean

timeFormat

JDBC driver property: timeFormat.

Range:

eur




hms




iso




jis




usa




Required: false

Data type: string

timeSeparator

JDBC driver property: timeSeparator.

Range:

:

The colon character (:).

.

The period character (.).

,

The comma character (,).

The space character ( ).

Required: false

Data type: string

toolboxTrace

JDBC driver property: toolboxTrace.

Range:

none

datastream

diagnostic

error

information

warning

conversion

proxy




pcml




jdbc




all




thread




Required: false

Data type: string

trace

JDBC driver property: trace.

Required: false

Data type: boolean

translateBinary

JDBC driver property: translateBinary.

Default: false

Required: false

Data type: boolean

translateBoolean

JDBC driver property: translateBoolean.

Default: true

Required: false

Data type: boolean

translateHex

JDBC driver property: translateHex.

Default: character

Range:

binary

character

Required: false

Data type: string

trueAutoCommit

JDBC driver property: trueAutoCommit.

Default: false

Required: false

Data type: boolean

user

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: string

xaLooselyCoupledSupport

JDBC driver property: xaLooselyCoupledSupport.

Default: 0

Required: false

Data type: int

properties.db2.jcc

Data source properties for the IBM Data Server Driver for JDBC and SQLJ for DB2.

PID: com.ibm.ws.jdbc.dataSource.properties.db2.jcc, and it is the child of complex type "dataSource".

Attributes

driverType

JDBC driver property: driverType.

Default: 4

Range:

2

Type 2 JDBC driver.

4

Type 4 JDBC driver.

Required: false

Data type: int

databaseName

JDBC driver property: databaseName.

Required: false

Data type: string

serverName

Server where the database is running.

Default: localhost

Required: false

Data type: string

portNumber

Port on which to obtain database connections.

Default: 50000

Required: false

Data type: int

activateDatabase

JDBC driver property: activateDatabase.

Required: false

Data type: int

alternateGroupDatabaseName

JDBC driver property: alternateGroupDatabaseName.

Required: false

Data type: string

alternateGroupPortNumber

JDBC driver property: alternateGroupPortNumber.

Required: false

Data type: string

alternateGroupServerName

JDBC driver property: alternateGroupServerName.

Required: false

Data type: string

blockingReadConnectionTimeout

JDBC driver property: blockingReadConnectionTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

clientAccountingInformation

JDBC driver property: clientAccountingInformation.

Required: false

Data type: string

clientApplicationInformation

JDBC driver property: clientApplicationInformation.

Required: false

Data type: string

clientRerouteServerListJNDIName

JDBC driver property: clientRerouteServerListJNDIName.

Required: false

Data type: string

clientUser

JDBC driver property: clientUser.

Required: false

Data type: string

clientWorkstation

JDBC driver property: clientWorkstation.

Required: false

Data type: string

connectionCloseWithInFlightTransaction

JDBC driver property: connectionCloseWithInFlightTransaction.

Range:

1

CONNECTION_CLOSE_WITH_EXCEPTION

2

CONNECTION_CLOSE_WITH_ROLLBACK

Required: false

Data type: int

currentAlternateGroupEntry

JDBC driver property: currentAlternateGroupEntry.

Required: false

Data type: int

currentFunctionPath

JDBC driver property: currentFunctionPath.

Required: false

Data type: string

currentLocaleLcCtype

JDBC driver property: currentLocaleLcCtype.

Required: false

Data type: string

currentLockTimeout

JDBC driver property: currentLockTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

currentPackagePath

JDBC driver property: currentPackagePath.

Required: false

Data type: string

currentPackageSet

JDBC driver property: currentPackageSet.

Required: false

Data type: string

currentSQLID

JDBC driver property: currentSQLID.

Required: false

Data type: string

currentSchema

JDBC driver property: currentSchema.

Required: false

Data type: string

cursorSensitivity

JDBC driver property: cursorSensitivity. Values are: 0 (TYPE_SCROLL_SENSITIVE_STATIC), 1 (TYPE_SCROLL_SENSITIVE_DYNAMIC), 2 (TYPE_SCROLL_ASENSITIVE).

Range:

0

TYPE_SCROLL_SENSITIVE_STATIC

1

TYPE_SCROLL_SENSITIVE_DYNAMIC

2

TYPE_SCROLL_ASENSITIVE

Required: false

Data type: int

deferPrepares

JDBC driver property: deferPrepares.

Default: true

Required: false

Data type: boolean

enableAlternateGroupSeamlessACR

JDBC driver property: enableAlternateGroupSeamlessACR.

Required: false

Data type: boolean

enableClientAffinitiesList

JDBC driver property: enableClientAffinitiesList. Values are: 1 (YES) or 2 (NO).

Range:

1

YES

2

NO

Required: false

Data type: int

enableExtendedDescribe

JDBC driver property: enableExtendedDescribe.

Range:

1

YES

2

NO

Required: false

Data type: int

enableExtendedIndicators

JDBC driver property: enableExtendedIndicators.

Range:

1

YES

2

NO

Required: false

Data type: int

enableNamedParameterMarkers

JDBC driver property: enableNamedParameterMarkers. Values are: 1 (YES) or 2 (NO).

Range:

1

YES

2

NO

Required: false

Data type: int

enableSeamlessFailover

JDBC driver property: enableSeamlessFailover. Values are: 1 (YES) or 2 (NO).

Range:

1

YES

2

NO

Required: false

Data type: int

enableSysplexWLB

JDBC driver property: enableSysplexWLB.

Required: false

Data type: boolean

fetchSize

JDBC driver property: fetchSize.

Required: false

Data type: int

fullyMaterializeInputStreams

JDBC driver property: fullyMaterializeInputStreams.

Required: false

Data type: boolean

fullyMaterializeInputStreamsOnBatchExecution

JDBC driver property: fullyMaterializeInputStreamsOnBatchExecution.

Range:

1

YES

2

NO

Required: false

Data type: int

fullyMaterializeLobData

JDBC driver property: fullyMaterializeLobData.

Required: false

Data type: boolean

implicitRollbackOption

JDBC driver property: implicitRollbackOption.

Range:

0

IMPLICIT_ROLLBACK_OPTION_NOT_SET

1

IMPLICIT_ROLLBACK_OPTION_NOT_CLOSE_CONNECTION

2

IMPLICIT_ROLLBACK_OPTION_CLOSE_CONNECTION

Required: false

Data type: int

interruptProcessingMode

JDBC driver property: interruptProcessingMode.

Range:

0

INTERRUPT_PROCESSING_MODE_DISABLED

1

INTERRUPT_PROCESSING_MODE_STATEMENT_CANCEL

2

INTERRUPT_PROCESSING_MODE_CLOSE_SOCKET

Required: false

Data type: int

keepAliveTimeOut

JDBC driver property: keepAliveTimeOut. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

keepDynamic

JDBC driver property: keepDynamic.

Required: false

Data type: int

kerberosServerPrincipal

JDBC driver property: kerberosServerPrincipal.

Required: false

Data type: string

loginTimeout

JDBC driver property: loginTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

maxConnCachedParamBufferSize

JDBC driver property: maxConnCachedParamBufferSize.

Required: false

Data type: int

maxRetriesForClientReroute

JDBC driver property: maxRetriesForClientReroute.

Required: false

Data type: int

password

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: password (string)

profileName

JDBC driver property: profileName.

Required: false

Data type: string

queryCloseImplicit

JDBC driver property: queryCloseImplicit. Values are: 1 (QUERY_CLOSE_IMPLICIT_YES) or 2 (QUERY_CLOSE_IMPLICIT_NO).

Range:

1

QUERY_CLOSE_IMPLICIT_YES

2

QUERY_CLOSE_IMPLICIT_NO

Required: false

Data type: int

queryDataSize

JDBC driver property: queryDataSize.

Required: false

Data type: int

queryTimeoutInterruptProcessingMode

JDBC driver property: queryTimeoutInterruptProcessingMode.

Range:

1

INTERRUPT_PROCESSING_MODE_STATEMENT_CANCEL

2

INTERRUPT_PROCESSING_MODE_CLOSE_SOCKET

Required: false

Data type: int

readOnly

JDBC driver property: readOnly.

Required: false

Data type: boolean

recordTemporalHistory

recordTemporalHistory.desc

Range:

1

YES

2

NO

Required: false

Data type: int

resultSetHoldability

JDBC driver property: resultSetHoldability. Values are: 1 (HOLD_CURSORS_OVER_COMMIT) or 2 (CLOSE_CURSORS_AT_COMMIT).

Range:

1

HOLD_CURSORS_OVER_COMMIT

2

CLOSE_CURSORS_AT_COMMIT

Required: false

Data type: int

resultSetHoldabilityForCatalogQueries

JDBC driver property: resultSetHoldabilityForCatalogQueries. Values are: 1 (HOLD_CURSORS_OVER_COMMIT) or 2 (CLOSE_CURSORS_AT_COMMIT).

Range:

1

HOLD_CURSORS_OVER_COMMIT

2

CLOSE_CURSORS_AT_COMMIT

Required: false

Data type: int

retrieveMessagesFromServerOnGetMessage

JDBC driver property: retrieveMessagesFromServerOnGetMessage.

Default: true

Required: false

Data type: boolean

retryIntervalForClientReroute

JDBC driver property: retryIntervalForClientReroute. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

securityMechanism

JDBC driver property: securityMechanism. Values are: 3 (CLEAR_TEXT_PASSWORD_SECURITY), 4 (USER_ONLY_SECURITY), 7 (ENCRYPTED_PASSWORD_SECURITY), 9 (ENCRYPTED_USER_AND_PASSWORD_SECURITY), 11 (KERBEROS_SECURITY), 12 (ENCRYPTED_USER_AND_DATA_SECURITY"), (ENCRYPTED_USER_PASSWORD_AND_DATA_SECURITY"), 15 (PLUGIN_SECURITY), 16 (ENCRYPTED_USER_ONLY_SECURITY).

Range:

3

CLEAR_TEXT_PASSWORD_SECURITY

4

USER_ONLY_SECURITY

7

ENCRYPTED_PASSWORD_SECURITY

9

ENCRYPTED_USER_AND_PASSWORD_SECURITY

11

KERBEROS_SECURITY

12

ENCRYPTED_USER_AND_DATA_SECURITY

13

ENCRYPTED_USER_PASSWORD_AND_DATA_SECURITY

15

PLUGIN_SECURITY

16

ENCRYPTED_USER_ONLY_SECURITY

Required: false

Data type: int

sendDataAsIs

JDBC driver property: sendDataAsIs.

Required: false

Data type: boolean

sessionTimeZone

JDBC driver property: sessionTimeZone.

Required: false

Data type: string

sqljCloseStmtsWithOpenResultSet

JDBC driver property: sqljCloseStmtsWithOpenResultSet.

Required: false

Data type: boolean

sqljEnableClassLoaderSpecificProfiles

JDBC driver property: sqljEnableClassLoaderSpecificProfiles.

Required: false

Data type: boolean

sslConnection

JDBC driver property: sslConnection.

Required: false

Data type: boolean

streamBufferSize

JDBC driver property: streamBufferSize.

Required: false

Data type: int

stripTrailingZerosForDecimalNumbers

JDBC driver property: stripTrailingZerosForDecimalNumbers.

Range:

1

YES

2

NO

Required: false

Data type: int

sysSchema

JDBC driver property: sysSchema.

Required: false

Data type: string

timerLevelForQueryTimeOut

JDBC driver property: timerLevelForQueryTimeOut.

Range:

-1

QUERYTIMEOUT_DISABLED

1

QUERYTIMEOUT_STATEMENT_LEVEL

2

QUERYTIMEOUT_CONNECTION_LEVEL

Required: false

Data type: int

traceDirectory

JDBC driver property: traceDirectory.

Required: false

Data type: string

traceFile

JDBC driver property: traceFile.

Required: false

Data type: string

traceFileAppend

JDBC driver property: traceFileAppend.

Required: false

Data type: boolean

traceFileCount

JDBC driver property: traceFileCount.

Required: false

Data type: int

traceFileSize

JDBC driver property: traceFileSize.

Required: false

Data type: int

traceLevel

Bitwise combination of the following constant values: TRACE_NONE=0, TRACE_CONNECTION_CALLS=1, TRACE_STATEMENT_CALLS=2, TRACE_RESULT_SET_CALLS=4, TRACE_DRIVER_CONFIGURATION=16, TRACE_CONNECTS=32, TRACE_DRDA_FLOWS=64, TRACE_RESULT_SET_META_DATA=128, TRACE_PARAMETER_META_DATA=256, TRACE_DIAGNOSTICS=512, TRACE_SQLJ=1024, TRACE_META_CALLS=8192, TRACE_DATASOURCE_CALLS=16384, TRACE_LARGE_OBJECT_CALLS=32768, TRACE_SYSTEM_MONITOR=131072, TRACE_TRACEPOINTS=262144, TRACE_ALL=-1.

Default: 0

Required: false

Data type: int

traceOption

JDBC driver property: traceOption

Range:

0

1




Required: false

Data type: int

translateForBitData

JDBC driver property: translateForBitData.

Range:

1

HEX_REPRESENTATION

2

SERVER_ENCODING_REPRESENTATION

Required: false

Data type: int

updateCountForBatch

JDBC driver property: updateCountForBatch.

Range:

1

NO_UPDATE_COUNT

2

TOTAL_UPDATE_COUNT

Required: false

Data type: int

useCachedCursor

JDBC driver property: useCachedCursor.

Required: false

Data type: boolean

useIdentityValLocalForAutoGeneratedKeys

JDBC driver property: useIdentityValLocalForAutoGeneratedKeys.

Required: false

Data type: boolean

useJDBC4ColumnNameAndLabelSemantics

JDBC driver property: useJDBC4ColumnNameAndLabelSemantics. Values are: 1 (YES) or 2 (NO).

Range:

1

YES

2

NO

Required: false

Data type: int

useJDBC41DefinitionForGetColumns

JDBC driver property: useJDBC41DefinitionForGetColumns.

Range:

1

YES

2

NO

Required: false

Data type: int

user

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: string

useTransactionRedirect

JDBC driver property: useTransactionRedirect.

Required: false

Data type: boolean

xaNetworkOptimization

JDBC driver property: xaNetworkOptimization.

Required: false

Data type: boolean

properties.derby.client

Data source properties for Derby Network Client JDBC driver.

PID: com.ibm.ws.jdbc.dataSource.properties.derby.client, and it is the child of complex type "dataSource".

Attributes

createDatabase

JDBC driver property: createDatabase.

Range:

create

When the first connection is established, automatically create the database if it doesn't exist.

false

Do not automatically create the database.

Required: false

Data type: string

databaseName

JDBC driver property: databaseName.

Required: false

Data type: string

serverName

Server where the database is running.

Default: localhost

Required: false

Data type: string

portNumber

Port on which to obtain database connections.

Default: 1527

Required: false

Data type: int

connectionAttributes

JDBC driver property: connectionAttributes.

Required: false

Data type: string

loginTimeout

JDBC driver property: loginTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

password

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: password (string)

retrieveMessageText

JDBC driver property: retrieveMessageText.

Default: true

Required: false

Data type: boolean

securityMechanism

JDBC driver property: securityMechanism. Values are: 3 (CLEAR_TEXT_PASSWORD_SECURITY), 4 (USER_ONLY_SECURITY), 7 (ENCRYPTED_PASSWORD_SECURITY), 8 (STRONG_PASSWORD_SUBSTITUTE_SECURITY), 9 (ENCRYPTED_USER_AND_PASSWORD_SECURITY).

Default: 3

Range:

3

CLEAR_TEXT_PASSWORD_SECURITY

4

USER_ONLY_SECURITY

7

ENCRYPTED_PASSWORD_SECURITY

8

STRONG_PASSWORD_SUBSTITUTE_SECURITY

9

ENCRYPTED_USER_AND_PASSWORD_SECURITY

Required: false

Data type: short

shutdownDatabase

JDBC driver property: shutdownDatabase.

Range:

shutdown

Shut down the database when a connection is attempted.

false

Do not shut down the database.

Required: false

Data type: string

ssl

JDBC driver property: ssl.

Range:

basic

peerAuthentication

off




Required: false

Data type: string

traceDirectory

JDBC driver property: traceDirectory.

Required: false

Data type: string

traceFile

JDBC driver property: traceFile.

Required: false

Data type: string

traceFileAppend

JDBC driver property: traceFileAppend.

Required: false

Data type: boolean

traceLevel

Bitwise combination of the following constant values: TRACE_NONE=0, TRACE_CONNECTION_CALLS=1, TRACE_STATEMENT_CALLS=2, TRACE_RESULT_SET_CALLS=4, TRACE_DRIVER_CONFIGURATION=16, TRACE_CONNECTS=32, TRACE_DRDA_FLOWS=64, TRACE_RESULT_SET_META_DATA=128, TRACE_PARAMETER_META_DATA=256, TRACE_DIAGNOSTICS=512, TRACE_XA_CALLS=2048, TRACE_ALL=-1.

Required: false

Data type: int

user

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: string

properties.derby.embedded

Data source properties for Derby Embedded JDBC driver.

PID: com.ibm.ws.jdbc.dataSource.properties.derby.embedded, and it is the child of complex type "dataSource".

Attributes

createDatabase

JDBC driver property: createDatabase.

Range:

create

When the first connection is established, automatically create the database if it doesn't exist.

false

Do not automatically create the database.

Required: false

Data type: string

databaseName

JDBC driver property: databaseName.

Required: false

Data type: string

connectionAttributes

JDBC driver property: connectionAttributes.

Required: false

Data type: string

loginTimeout

JDBC driver property: loginTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

password

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: password (string)

shutdownDatabase

JDBC driver property: shutdownDatabase.

Range:

shutdown

Shut down the database when a connection is attempted.

false

Do not shut down the database.

Required: false

Data type: string

user

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: string

properties.informix

Data source properties for the Informix JDBC driver.

PID: com.ibm.ws.jdbc.dataSource.properties.informix, and it is the child of complex type "dataSource".

Attributes

databaseName

JDBC driver property: databaseName.

Required: false

Data type: string

ifxIFXHOST

JDBC driver property: ifxIFXHOST.

Default: localhost

Required: false

Data type: string

serverName

Server where the database is running.

Required: false

Data type: string

portNumber

Port on which to obtain database connections.

Default: 1526

Required: false

Data type: int

ifxCLIENT_LOCALE

JDBC driver property: ifxCLIENT_LOCALE.

Required: false

Data type: string

ifxCPMAgeLimit

JDBC driver property: ifxCPMAgeLimit. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

ifxCPMInitPoolSize

JDBC driver property: ifxCPMInitPoolSize.

Required: false

Data type: int

ifxCPMMaxConnections

JDBC driver property: ifxCPMMaxConnections.

Required: false

Data type: int

ifxCPMMaxPoolSize

JDBC driver property: ifxCPMMaxPoolSize.

Required: false

Data type: int

ifxCPMMinAgeLimit

JDBC driver property: ifxCPMMinAgeLimit. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

ifxCPMMinPoolSize

JDBC driver property: ifxCPMMinPoolSize.

Required: false

Data type: int

ifxCPMServiceInterval

JDBC driver property: ifxCPMServiceInterval. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Required: false

Data type: string

ifxDBANSIWARN

JDBC driver property: ifxDBANSIWARN.

Required: false

Data type: boolean

ifxDBCENTURY

JDBC driver property: ifxDBCENTURY.

Required: false

Data type: string

ifxDBDATE

JDBC driver property: ifxDBDATE.

Required: false

Data type: string

ifxDBSPACETEMP

JDBC driver property: ifxDBSPACETEMP.

Required: false

Data type: string

ifxDBTEMP

JDBC driver property: ifxDBTEMP.

Required: false

Data type: string

ifxDBTIME

JDBC driver property: ifxDBTIME.

Required: false

Data type: string

ifxDBUPSPACE

JDBC driver property: ifxDBUPSPACE.

Required: false

Data type: string

ifxDB_LOCALE

JDBC driver property: ifxDB_LOCALE.

Required: false

Data type: string

ifxDELIMIDENT

JDBC driver property: ifxDELIMIDENT.

Required: false

Data type: boolean

ifxENABLE_TYPE_CACHE

JDBC driver property: ifxENABLE_TYPE_CACHE.

Required: false

Data type: boolean

ifxFET_BUF_SIZE

JDBC driver property: ifxFET_BUF_SIZE.

Required: false

Data type: int

ifxGL_DATE

JDBC driver property: ifxGL_DATE.

Required: false

Data type: string

ifxGL_DATETIME

JDBC driver property: ifxGL_DATETIME.

Required: false

Data type: string

ifxIFX_AUTOFREE

JDBC driver property: ifxIFX_AUTOFREE.

Required: false

Data type: boolean

ifxIFX_DIRECTIVES

JDBC driver property: ifxIFX_DIRECTIVES.

Required: false

Data type: string

ifxIFX_LOCK_MODE_WAIT

JDBC driver property: ifxIFX_LOCK_MODE_WAIT. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 2s

Required: false

Data type: string

ifxIFX_SOC_TIMEOUT

JDBC driver property: ifxIFX_SOC_TIMEOUT. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Required: false

Data type: string

ifxIFX_USEPUT

JDBC driver property: ifxIFX_USEPUT.

Required: false

Data type: boolean

ifxIFX_USE_STRENC

JDBC driver property: ifxIFX_USE_STRENC.

Required: false

Data type: boolean

ifxIFX_XASPEC

JDBC driver property: ifxIFX_XASPEC.

Default: y

Required: false

Data type: string

ifxINFORMIXCONRETRY

JDBC driver property: ifxINFORMIXCONRETRY.

Required: false

Data type: int

ifxINFORMIXCONTIME

JDBC driver property: ifxINFORMIXCONTIME. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

ifxINFORMIXOPCACHE

JDBC driver property: ifxINFORMIXOPCACHE.

Required: false

Data type: string

ifxINFORMIXSTACKSIZE

JDBC driver property: ifxINFORMIXSTACKSIZE.

Required: false

Data type: int

ifxJDBCTEMP

JDBC driver property: ifxJDBCTEMP.

Required: false

Data type: string

ifxLDAP_IFXBASE

JDBC driver property: ifxLDAP_IFXBASE.

Required: false

Data type: string

ifxLDAP_PASSWD

JDBC driver property: ifxLDAP_PASSWD.

Required: false

Data type: string

ifxLDAP_URL

JDBC driver property: ifxLDAP_URL.

Required: false

Data type: string

ifxLDAP_USER

JDBC driver property: ifxLDAP_USER.

Required: false

Data type: string

ifxLOBCACHE

JDBC driver property: ifxLOBCACHE.

Required: false

Data type: int

ifxNEWCODESET

JDBC driver property: ifxNEWCODESET.

Required: false

Data type: string

ifxNEWLOCALE

JDBC driver property: ifxNEWLOCALE.

Required: false

Data type: string

ifxNODEFDAC

JDBC driver property: ifxNODEFDAC.

Required: false

Data type: string

ifxOPTCOMPIND

JDBC driver property: ifxOPTCOMPIND.

Required: false

Data type: string

ifxOPTOFC

JDBC driver property: ifxOPTOFC.

Required: false

Data type: string

ifxOPT_GOAL

JDBC driver property: ifxOPT_GOAL.

Required: false

Data type: string

ifxPATH

JDBC driver property: ifxPATH.

Required: false

Data type: string

ifxPDQPRIORITY

JDBC driver property: ifxPDQPRIORITY.

Required: false

Data type: string

ifxPLCONFIG

JDBC driver property: ifxPLCONFIG.

Required: false

Data type: string

ifxPLOAD_LO_PATH

JDBC driver property: ifxPLOAD_LO_PATH.

Required: false

Data type: string

ifxPROTOCOLTRACE

JDBC driver property: ifxPROTOCOLTRACE.

Required: false

Data type: int

ifxPROTOCOLTRACEFILE

JDBC driver property: ifxPROTOCOLTRACEFILE.

Required: false

Data type: string

ifxPROXY

JDBC driver property: ifxPROXY.

Required: false

Data type: string

ifxPSORT_DBTEMP

JDBC driver property: ifxPSORT_DBTEMP.

Required: false

Data type: string

ifxPSORT_NPROCS

JDBC driver property: ifxPSORT_NPROCS.

Required: false

Data type: boolean

ifxSECURITY

JDBC driver property: ifxSECURITY.

Required: false

Data type: string

ifxSQLH_FILE

JDBC driver property: ifxSQLH_FILE.

Required: false

Data type: string

ifxSQLH_LOC

JDBC driver property: ifxSQLH_LOC.

Required: false

Data type: string

ifxSQLH_TYPE

JDBC driver property: ifxSQLH_TYPE.

Required: false

Data type: string

ifxSSLCONNECTION

JDBC driver property: ifxSSLCONNECTION.

Required: false

Data type: string

ifxSTMT_CACHE

JDBC driver property: ifxSTMT_CACHE.

Required: false

Data type: string

ifxTRACE

JDBC driver property: ifxTRACE.

Required: false

Data type: int

ifxTRACEFILE

JDBC driver property: ifxTRACEFILE.

Required: false

Data type: string

ifxTRUSTED_CONTEXT

JDBC driver property: ifxTRUSTED_CONTEXT.

Required: false

Data type: string

ifxUSEV5SERVER

JDBC driver property: ifxUSEV5SERVER.

Required: false

Data type: boolean

ifxUSE_DTENV

JDBC driver property: ifxUSE_DTENV.

Required: false

Data type: boolean

loginTimeout

JDBC driver property: loginTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

password

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: password (string)

roleName

JDBC driver property: roleName.

Required: false

Data type: string

user

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: string

properties.informix.jcc

Data source properties for the IBM Data Server Driver for JDBC and SQLJ for Informix.

PID: com.ibm.ws.jdbc.dataSource.properties.informix.jcc, and it is the child of complex type "dataSource".

Attributes

databaseName

JDBC driver property: databaseName.

Required: false

Data type: string

serverName

Server where the database is running.

Default: localhost

Required: false

Data type: string

portNumber

Port on which to obtain database connections.

Default: 1526

Required: false

Data type: int

currentLockTimeout

JDBC driver property: currentLockTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 2s

Required: false

Data type: string

DBANSIWARN

JDBC driver property: DBANSIWARN.

Required: false

Data type: boolean

DBDATE

JDBC driver property: DBDATE.

Required: false

Data type: string

DBPATH

JDBC driver property: DBPATH.

Required: false

Data type: string

DBSPACETEMP

JDBC driver property: DBSPACETEMP.

Required: false

Data type: string

DBTEMP

JDBC driver property: DBTEMP.

Required: false

Data type: string

DBUPSPACE

JDBC driver property: DBUPSPACE.

Required: false

Data type: string

DELIMIDENT

JDBC driver property: DELIMIDENT.

Required: false

Data type: boolean

deferPrepares

JDBC driver property: deferPrepares.

Required: false

Data type: boolean

driverType

JDBC driver property: driverType.

Default: 4

Required: false

Data type: int

enableNamedParameterMarkers

JDBC driver property: enableNamedParameterMarkers. Values are: 1 (YES) or 2 (NO).

Required: false

Data type: int

enableSeamlessFailover

JDBC driver property: enableSeamlessFailover. Values are: 1 (YES) or 2 (NO).

Required: false

Data type: int

enableSysplexWLB

JDBC driver property: enableSysplexWLB.

Required: false

Data type: boolean

fetchSize

JDBC driver property: fetchSize.

Required: false

Data type: int

fullyMaterializeLobData

JDBC driver property: fullyMaterializeLobData.

Required: false

Data type: boolean

IFX_DIRECTIVES

JDBC driver property: IFX_DIRECTIVES.

Range:

ON

OFF

Required: false

Data type: string

IFX_EXTDIRECTIVES

JDBC driver property: IFX_EXTDIRECTIVES.

Range:

ON

OFF

Required: false

Data type: string

IFX_UPDDESC

JDBC driver property: IFX_UPDDESC.

Required: false

Data type: string

IFX_XASTDCOMPLIANCE_XAEND

JDBC driver property: IFX_XASTDCOMPLIANCE_XAEND.

Range:

0

1

Required: false

Data type: string

INFORMIXOPCACHE

JDBC driver property: INFORMIXOPCACHE.

Required: false

Data type: string

INFORMIXSTACKSIZE

JDBC driver property: INFORMIXSTACKSIZE.

Required: false

Data type: string

keepDynamic

JDBC driver property: keepDynamic.

Required: false

Data type: int

loginTimeout

JDBC driver property: loginTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

NODEFDAC

JDBC driver property: NODEFDAC.

Range:

yes

no

Required: false

Data type: string

OPTCOMPIND

JDBC driver property: OPTCOMPIND.

Range:

0

1

2

Required: false

Data type: string

OPTOFC

JDBC driver property: OPTOFC.

Range:

0

1

Required: false

Data type: string

password

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: password (string)

PDQPRIORITY

JDBC driver property: PDQPRIORITY.

Range:

HIGH

LOW

OFF

Required: false

Data type: string

progressiveStreaming

JDBC driver property: progressiveStreaming. Values are: 1 (YES) or 2 (NO).

Range:

1

YES

2

NO

Required: false

Data type: int

PSORT_DBTEMP

JDBC driver property: PSORT_DBTEMP.

Required: false

Data type: string

PSORT_NPROCS

JDBC driver property: PSORT_NPROCS.

Required: false

Data type: string

queryDataSize

JDBC driver property: queryDataSize.

Required: false

Data type: int

resultSetHoldability

JDBC driver property: resultSetHoldability. Values are: 1 (HOLD_CURSORS_OVER_COMMIT) or 2 (CLOSE_CURSORS_AT_COMMIT).

Range:

1

HOLD_CURSORS_OVER_COMMIT

2

CLOSE_CURSORS_AT_COMMIT

Required: false

Data type: int

resultSetHoldabilityForCatalogQueries

JDBC driver property: resultSetHoldabilityForCatalogQueries. Values are: 1 (HOLD_CURSORS_OVER_COMMIT) or 2 (CLOSE_CURSORS_AT_COMMIT).

Range:

1

HOLD_CURSORS_OVER_COMMIT

2

CLOSE_CURSORS_AT_COMMIT

Required: false

Data type: int

retrieveMessagesFromServerOnGetMessage

JDBC driver property: retrieveMessagesFromServerOnGetMessage.

Default: true

Required: false

Data type: boolean

securityMechanism

JDBC driver property: securityMechanism. Values are: 3 (CLEAR_TEXT_PASSWORD_SECURITY), 4 (USER_ONLY_SECURITY), 7 (ENCRYPTED_PASSWORD_SECURITY), 9 (ENCRYPTED_USER_AND_PASSWORD_SECURITY).

Range:

3

CLEAR_TEXT_PASSWORD_SECURITY

4

USER_ONLY_SECURITY

7

ENCRYPTED_PASSWORD_SECURITY

9

ENCRYPTED_USER_AND_PASSWORD_SECURITY

Required: false

Data type: short

STMT_CACHE

JDBC driver property: STMT_CACHE.

Range:

0

1

Required: false

Data type: string

traceDirectory

JDBC driver property: traceDirectory.

Required: false

Data type: string

traceFile

JDBC driver property: traceFile.

Required: false

Data type: string

traceFileAppend

JDBC driver property: traceFileAppend.

Required: false

Data type: boolean

traceLevel

Bitwise combination of the following constant values: TRACE_NONE=0, TRACE_CONNECTION_CALLS=1, TRACE_STATEMENT_CALLS=2, TRACE_RESULT_SET_CALLS=4, TRACE_DRIVER_CONFIGURATION=16, TRACE_CONNECTS=32, TRACE_DRDA_FLOWS=64, TRACE_RESULT_SET_META_DATA=128, TRACE_PARAMETER_META_DATA=256, TRACE_DIAGNOSTICS=512, TRACE_SQLJ=1024, TRACE_META_CALLS=8192, TRACE_DATASOURCE_CALLS=16384, TRACE_LARGE_OBJECT_CALLS=32768, TRACE_SYSTEM_MONITOR=131072, TRACE_TRACEPOINTS=262144, TRACE_ALL=-1.

Required: false

Data type: int

useJDBC4ColumnNameAndLabelSemantics

JDBC driver property: useJDBC4ColumnNameAndLabelSemantics. Values are: 1 (YES) or 2 (NO).

Required: false

Data type: int

user

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: string

properties.microsoft.sqlserver

Data source properties for Microsoft SQL Server JDBC Driver.

PID: com.ibm.ws.jdbc.dataSource.properties.microsoft.sqlserver, and it is the child of complex type "dataSource".

Attributes

databaseName

JDBC driver property: databaseName.

Required: false

Data type: string

instanceName

JDBC driver property: instanceName.

Required: false

Data type: string

serverName

Server where the database is running.

Default: localhost

Required: false

Data type: string

portNumber

Port on which to obtain database connections.

Default: 1433

Required: false

Data type: int

applicationIntent

JDBC driver property: applicationIntent.

Range:

ReadOnly

ReadWrite

Required: false

Data type: string

applicationName

JDBC driver property: applicationName.

Required: false

Data type: string

authenticationScheme

JDBC driver property: authenticationScheme.

Range:

JavaKerberos

NativeAuthentication

Required: false

Data type: string

encrypt

JDBC driver property: encrypt.

Required: false

Data type: boolean

failoverPartner

JDBC driver property: failoverPartner.

Required: false

Data type: string

hostNameInCertificate

JDBC driver property: hostNameInCertificate.

Required: false

Data type: string

integratedSecurity

JDBC driver property: integratedSecurity.

Required: false

Data type: boolean

lastUpdateCount

JDBC driver property: lastUpdateCount.

Required: false

Data type: boolean

lockTimeout

JDBC driver property: lockTimeout. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Required: false

Data type: string

loginTimeout

JDBC driver property: loginTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

multiSubnetFailover

JDBC driver property: multiSubnetFailover.

Required: false

Data type: boolean

packetSize

JDBC driver property: packetSize.

Required: false

Data type: int

password

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: password (string)

responseBuffering

JDBC driver property: responseBuffering.

Range:

adaptive

full

Required: false

Data type: string

selectMethod

JDBC driver property: selectMethod.

Range:

cursor

direct

Required: false

Data type: string

sendStringParametersAsUnicode

JDBC driver property: sendStringParametersAsUnicode.

Default: false

Required: false

Data type: boolean

sendTimeAsDatetime

JDBC driver property: sendTimeAsDatetime.

Required: false

Data type: boolean

trustServerCertificate

JDBC driver property: trustServerCertificate.

Required: false

Data type: boolean

trustStore

JDBC driver property: trustStore.

Required: false

Data type: string

trustStorePassword

JDBC driver property: trustStorePassword.

Required: false

Data type: password (string)

URL

URL for connecting to the database. Example: jdbc:sqlserver://localhost:1433;databaseName=myDB.

Required: false

Data type: string

user

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: string

workstationID

JDBC driver property: workstationID.

Required: false

Data type: string

xopenStates

JDBC driver property: xopenStates.

Required: false

Data type: boolean

properties.oracle

Data source properties for Oracle JDBC driver.

PID: com.ibm.ws.jdbc.dataSource.properties.oracle, and it is the child of complex type "dataSource".

Attributes

driverType

JDBC driver property: driverType.

Default: thin

Range:

thin

oci

Required: false

Data type: string

databaseName

JDBC driver property: databaseName.

Required: false

Data type: string

serverName

Server where the database is running.

Default: localhost

Required: false

Data type: string

portNumber

Port on which to obtain database connections.

Default: 1521

Required: false

Data type: int

URL

URL for connecting to the database. Examples: jdbc:oracle:thin:@//localhost:1521/sample or jdbc:oracle:oci:@//localhost:1521/sample.

Required: false

Data type: string

connectionProperties

JDBC driver property: connectionProperties.

Required: false

Data type: string

loginTimeout

JDBC driver property: loginTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

networkProtocol

JDBC driver property: networkProtocol.

Required: false

Data type: string

ONSConfiguration

JDBC driver property: ONSConfiguration.

Required: false

Data type: string

password

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: password (string)

serviceName

JDBC driver property: serviceName.

Required: false

Data type: string

TNSEntryName

JDBC driver property: TNSEntryName.

Required: false

Data type: string

user

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: string

properties.sybase

Data source properties for Sybase JDBC driver.

PID: com.ibm.ws.jdbc.dataSource.properties.sybase, and it is the child of complex type "dataSource".

Attributes

databaseName

JDBC driver property: databaseName.

Required: true

Data type: string

serverName

Server where the database is running.

Default: localhost

Required: false

Data type: string

portNumber

Port on which to obtain database connections.

Default: 5000

Required: false

Data type: int

connectionProperties

JDBC driver property: connectionProperties.

Default: SELECT_OPENS_CURSOR=true

Required: false

Data type: string

loginTimeout

JDBC driver property: loginTimeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Required: false

Data type: string

networkProtocol

JDBC driver property: networkProtocol.

Range:

socket

SSL

Required: false

Data type: string

password

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: password (string)

resourceManagerName

JDBC driver property: resourceManagerName.

Required: false

Data type: string

SERVER_INITIATED_TRANSACTIONS

JDBC driver property: SERVER_INITIATED_TRANSACTIONS.

Default: false

Range:

true

false

Required: false

Data type: string

user

It is recommended to use a container managed authentication alias instead of configuring this property.

Required: false

Data type: string

version

JDBC driver property: version.

Required: false

Data type: int

quickStartSecurity

Simple administrative security configuration.

PID: com.ibm.ws.security.quickStartSecurity.

Attributes

userName

Single user defined as part of the quick start security configuration. This user is granted the Administrator role.

Required: true

Data type: string

userPassword

Password for the single user defined as part of the quick start security configuration. It is recommended that you encode this password. To do so, use the securityUtility tool with the encode option.

Required: true

Data type: password (string)

remoteFileAccess

This element contains artifacts that control the level of file access exposed for remote connections.

PID: com.ibm.ws.management.filetransfer.

Sub-elements

readDir

A directory that remote clients are allowed to read from. There can be multiple readDir elements, and each represents a single directory that may refer to variables or absolute paths. Default is ${wlp.install.dir}, ${wlp.user.dir} and ${server.output.dir}

Required: false

Data type: string

writeDir

A directory that remote clients are allowed to read from and write to. There can be multiple writeDir elements, and each represents a single directory that may refer to variables or absolute paths. Default is an empty set of directories.

Required: false

Data type: string

securewayLdapFilterProperties

Default IBM SecureWay Directory Server LDAP filters.

PID: com.ibm.ws.security.registry.ldap.internal.filters.secureway.

Attributes

userFilter

An LDAP filter clause for searching the user registry for users.

Default: (&(uid=%v)(objectclass=ePerson))

Required: true

Data type: string

groupFilter

An LDAP filter clause for search the user registry for groups.

Default: (&(cn=%v)(|(objectclass=groupOfNames)(objectclass=groupOfUniqueNames)))

Required: true

Data type: string

userIdMap

An LDAP filter that maps the name of a user to an LDAP entry.

Default: *:uid

Required: true

Data type: string

groupIdMap

An LDAP filter that maps the name of a group to an LDAP entry.

Default: *:cn

Required: true

Data type: string

groupMemberIdMap

An LDAP filter that identifies user to group memberships.

Default: groupOfNames:member;groupOfUniqueNames:uniqueMember

Required: true

Data type: string

securityContext

When specified, the security context of the work initiator is propagated to the unit of work.

PID: com.ibm.ws.security.context, and it is the child of complex type "contextService".

ssl

An SSL repertoire with an ID, a defined keystore, and an optional truststore.

PID: com.ibm.ws.ssl.repertoire.

Attributes

keyStoreRef

A keystore containing key entries for the SSL repertoire. This attribute is required.

Required: true

Data type: string

trustStoreRef

A keystore containing trusted certificate entries used by the SSL repertoire for signing verification. This attribute is optional. If unspecified, the same keystore is used for both key and trusted certificate entries.

Default: ${keyStoreRef}

Required: false

Data type: string

sslDefault

The default repertoire for SSL services.

PID: com.ibm.ws.ssl.default.

Attributes

sslRef

The default SSL repertoire. The default value is defaultSSLSettings.

Default: defaultSSLConfig

Required: false

Data type: string

sslOptions

The SSL protocol configuration for a transport.

PID: com.ibm.ws.sslchannel.options.

Attributes

sessionTimeout

Amount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 1d

Required: false

Data type: string

suppressHandshakeErrors

Disable logging of SSL handshake errors. SSL handshake errors can occur during normal operation, however these messages can be useful when SSL is behaving unexpectedly.

Default: false

Required: false

Data type: boolean

sslRef

The default SSL configuration repertoire. The default value is defaultSSLSettings.

Required: false

Data type: string

tcpOptions

Defines TCP protocol settings.

PID: com.ibm.ws.tcpchannel.options.

Attributes

inactivityTimeout

Amount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. 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. We can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

Default: 60s

Required: false

Data type: string

soReuseAddr

Enables immediate rebind to a port with no active listener.

Default: false

Required: false

Data type: boolean

timedOperation

Timed operations help WebSphere Application Server administrators see when certain actions in their application server are operating more slowly than expected.

PID: com.ibm.ws.timedoperations.

Attributes

maxNumberTimedOperations

A warning is logged when the total number of timed operations reaches this value.

Default: 10000

Required: false

Data type: int

enableReport

Enables periodic generation of report to the logs detailing the ten longest timed operations, grouped by type, and sorted within each group by expected duration

Default: true

Required: false

Data type: boolean

reportFrequency

Frequency of generating report to the logs detailing the ten longest timed operations, grouped by type, and sorted within each group by expected duration. Specify a positive integer followed by the unit of time, which can be hours (h). For example, specify 12 hours as 12h.

Required: false

Data type: string

transaction

Configuration properties for the Transaction Manager service.

PID: com.ibm.ws.transaction.

Attributes

recoverOnStartup

Whether the server should begin transaction recovery at server startup.

Default: false

Required: false

Data type: boolean

waitForRecovery

Whether the server should wait for transaction recovery to complete before accepting new transactional work.

Default: false

Required: false

Data type: boolean

acceptHeuristicHazard

Whether all applications on this server accept the possibility of a heuristic hazard occurring in a two-phase transaction containing a one-phase resource.

Default: true

Required: false

Data type: boolean

clientInactivityTimeout

Maximum duration between transactional requests from a remote client. Any period of client inactivity that exceeds this timeout results in the transaction being rolled back in this application server. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 60s

Required: false

Data type: string

heuristicRetryInterval

Amount of time that the application server waits before retrying a completion signal, such as commit or rollback, after a transient exception from a resource manager or remote partner. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 60s

Required: false

Data type: string

heuristicRetryWait

The number of times that the application server retries a completion signal, such as commit or rollback. Retries occur after a transient exception from a resource manager or remote partner.

Default: 5

Required: false

Data type: int

propogatedOrBMTTranLifetimeTimeout

Upper limit of the transaction timeout for transactions that run in this server. Should be greater than or equal to the value specified for the total transaction timeout. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 0

Required: false

Data type: string

totalTranLifetimeTimeout

Default maximum time allowed for transactions started on this server to complete. Any such transactions that do not complete before this timeout occurs are rolled back. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 12000s

Required: false

Data type: string

transactionLogDirectory

A directory for this server where the transaction service stores log files for recovery.

Default: ${server.config.dir}/tranlog/

Required: false

Data type: string

transactionLogSize

Size of transaction log files in Kilobytes.

Default: 1024

Required: false

Data type: int

enableLoggingForHeuristicReporting

Whether the application server logs about-to-commit-one-phase-resource events from transactions that involve both a one-phase commit resource and two-phase commit resources.

Default: false

Required: false

Data type: boolean

timeoutGracePeriodEnabled

Whether there is a delay between a transaction timeout and the abnormal ending of the servant region that was running the transaction.

Default: false

Required: false

Data type: boolean

lpsHeuristicCompletion

Direction used to complete a transaction that has a heuristic outcome; either the application server commits or rolls back the transaction, or depends on manual completion by the administrator. Allowed values are: COMMIT, ROLLBACK and MANUAL

Default: ROLLBACK

Range:

ROLLBACK

COMMIT

MANUAL




Required: false

Data type: string

defaultMaxShutdownDelay

Default maximum shutdown delay. 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. We can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Default: 2s

Required: false

Data type: string

dataSourceRef

This is an optional property. By default the transaction service stores its recovery logs in a file. As an alternative it is possible to store the logs in an RDBMS. This is achieved by setting this property which defines a non-transactional data source where the transaction logs will be stored.

Required: false

Data type: Configuration ID of type dataSource (string).

Sub-elements

dataSource

This is an optional property. By default the transaction service stores its recovery logs in a file. As an alternative it is possible to store the logs in an RDBMS. This is achieved by setting this property which defines a non-transactional data source where the transaction logs will be stored.

Required: false

Data type: Element of type dataSource.

trustAssociation

Controls the operation of the trust association interceptor (TAI).

PID: com.ibm.ws.security.authentication.tai.

Attributes

invokeForUnprotectedURI

Controls whether the TAI is invoked for an unprotected URI.

Default: false

Required: true

Data type: boolean

failOverToAppAuthType

Allow an interceptor to fall back to the application authentication mechanism.

Default: false

Required: true

Data type: boolean

Sub-elements

interceptors

Required: false

Data type: Defines a trust association interceptor.

enabled

Enables or disables the interceptor.

Default: true

Required: true

Data type: boolean

className

Fully-qualified package name of the interceptor class.

Required: true

Data type: string

invokeBeforeSSO

Invoke an interceptor before single sign-on (SSO).

Default: true

Required: true

Data type: boolean

invokeAfterSSO

Invoke an interceptor after single sign-on (SSO).

Default: false

Required: true

Data type: boolean

libraryRef

A reference to the ID of the shared library configuration.

Required: false

Data type: Configuration ID of type library (string).

library

A reference to the ID of the shared library configuration.

Required: false

Data type: Element of type library.

properties

Required: false

variable

Declare a new variable by specifying the name and value for the variable.

Attributes

name

The name of the variable.

Required: true

Data type: string

value

The value to be assigned to the variable.

Required: true

Data type: string

virtualHost

Virtual host configuration.

PID: com.ibm.ws.http.virtualhost.

Attributes

virtualHostid

ID of a configured virtual host.

Required: false

Data type: string

Sub-elements

hostAlias

The hostAlias sub-element configuration.

Required: false

Data type: Element of type hostAlias.

allowFromEndpoint

Specify the identifier of one or more HTTP endpoints to restrict inbound traffic for this virtual host to the specified endpoints.

Required: false

Data type: Element of type allowFromEndpoint.

webApplication

Defines the properties of a web application.

PID: com.ibm.ws.app.manager.webappcfg.

Attributes

name

Name of an application.

Required: false

Data type: string

location

Location of an application expressed as an absolute path or a path relative to the server-level apps directory.

Required: true

Data type: string

type

Type of application archive.

Required: false

Data type: string

contextRoot

Context root of an application.

Required: false

Data type: string

autoStart

Indicates whether or not the server should start the application automatically when the server starts.

Default: true

Required: false

Data type: boolean

webAppSecurity

Configures web container application security.

PID: com.ibm.ws.webcontainer.security.WebAppSecurityCollaboratorImpl.

Attributes

allowFailOverToBasicAuth

Whether to fail over to basic authentication when certificate authentication fails. The equivalent custom property in the full application server profile is com.ibm.wsspi.security.web.failOverToBasicAuth.

Default: false

Required: false

Data type: boolean

allowLogoutPageRedirectToAnyHost

Setting true may open the systems to potential URL redirect attacks. If set to true, any host can be specified for the logout page redirect. If set to false, and the logout page points to a different host, or one not listed in the logout page redirect domain list, then a generic logout page is displayed. The equivalent custom property in the full application server profile is com.ibm.websphere.security.allowAnyLogoutExitPageHost.

Default: false

Required: false

Data type: boolean

displayAuthenticationRealm

If true, and the user registry's realm name contains sensitive information, it is displayed to the user. For example, if an LDAP configuration is used, the LDAP server hostname and port are displayed. This configuration controls what the HTTP basic authentication login window displays when the realm name is not defined in the application web.xml. If the realm name is defined in the application web.xml file, this property is ignored. If set to true, the realm name displayed will be the user registry realm name for the LTPA authentication mechanism or the Kerberos realm name for the Kerberos authentication mechanism. If set to false, the realm name displayed will be "Default Realm". The equivalent custom property in the full application server profile is com.ibm.websphere.security.displayRealm.

Default: false

Required: false

Data type: boolean

httpOnlyCookies

Whether the HTTP only (HttpOnly) cookies option is enabled.

Default: true

Required: false

Data type: boolean

logoutOnHttpSessionExpire

Whether users will be logged out after the HTTP session timer expires. If set to false, the user credential will stay active until the Single Sign-On token timeout occurs. The equivalent custom property in the full application server profile is com.ibm.ws.security.web.logoutOnHTTPSessionExpire.

Default: false

Required: false

Data type: boolean

logoutPageRedirectDomainNames

A pipe (|) separated list of domain names allowed for the logout page redirect (localhost is implied). The equivalent custom property in the full application server profile is com.ibm.websphere.security.logoutExitPageDomainList.

Required: false

Data type: string

postParamCookieSize

Size of the POST parameter cookie. If the size of the cookie is larger than the browser limit, unexpected behavior may occur. The value of this property must be a positive integer and represents the maximum size of the cookie in bytes. The equivalent custom property in the full application server profile is com.ibm.websphere.security.util.postParamMaxCookieSize.

Default: 16384

Required: false

Data type: int

postParamSaveMethod

Where POST parameters are stored upon redirect. Valid values are cookie (POST parameters are stored in a cookie), session (POST parameters are stored in the HTTP Session) and none (POST parameters are not preserved). The equivalent custom property in the full application server profile is com.ibm.websphere.security.util.postParamSaveMethod.

Default: Cookie

Range:

Cookie

Session

None

Required: false

Data type: string

preserveFullyQualifiedReferrerUrl

Setting this to true may open the systems to potential URL redirect attacks. This property specifies whether the fully qualified referrer URL for form login redirects is preserved. If false, the host for the referrer URL is removed and the redirect is to localhost. The equivalent custom property in the full application server profile is com.ibm.websphere.security.util.fullyQualifiedURL

Default: false

Required: false

Data type: boolean

singleSignonEnabled

Whether single sign-on is enabled.

Default: true

Required: false

Data type: boolean

ssoCookieName

Customizes the SSO cookie name. A custom cookie name allows you to logically separate authentication between SSO domains and to enable customized authentication to a particular environment. Before setting this value, consider that setting a custom cookie name can cause an authentication failure. For example, a connection to a server that has a custom cookie property set sends this custom cookie to the browser. A subsequent connection to a server that uses either the default cookie name or a different cookie name, is not able to authenticate the request via a validation of the in-bound cookie. The equivalent custom property in the full application server profile is com.ibm.websphere.security.customSSOCookieName.

Default: LtpaToken2

Required: false

Data type: string

ssoDomainNames

A pipe (|) separated list of domain names that SSO Cookies should be presented. The equivalent custom property in the full application server profile is com.ibm.ws.security.config.SingleSignonConfig

Required: false

Data type: string

ssoRequiresSSL

Whether a SSO cookie is sent over SSL. The equivalent custom property in the full application server profile is com.ibm.websphere.security.customSSOCookieName

Default: false

Required: false

Data type: boolean

ssoUseDomainFromURL

Whether to use the domain name from the request URL for the cookie domain.

Default: false

Required: false

Data type: boolean

useAuthenticationDataForUnprotectedResource

Whether authentication data can be used when accessing an unprotected resource. The unprotected resource can access validated authenticated data that it previously could not access. This option enables the unprotected resource to call the getRemoteUser, isUserInRole, and getUserPrincipal methods to retrieve an authenticated identity. The equivalent custom property in the full application server profile is com.ibm.wsspi.security.web.webAuthReq=persisting.

Default: true

Required: false

Data type: boolean

webAlwaysLogin

Whether the login() method will throw an exception when an identity has already been authenticated.

Default: false

Required: false

Data type: boolean

webContainer

Configuration for the web container.

PID: com.ibm.ws.webcontainer.

Attributes

listeners

A comma separated list of listener classes.

Default:

Required: false

Data type: string

decodeUrlAsUtf8

Decode URLs using an encoding setting of UTF-8.

Default: true

Required: false

Data type: boolean

fileServingEnabled

Enable file serving if this setting was not explicitly specified for the application.

Default: true

Required: false

Data type: boolean

disallowAllFileServing

Disables all file serving by applications. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.disallowAllFileServing.

Default: false

Required: false

Data type: boolean

directoryBrowsingEnabled

Enable directory browsing of an application.

Default: false

Required: false

Data type: boolean

serveServletsByClassnameEnabled

Enable servlets to be accessed in a web application using a class name if not explicitly specified.

Default: false

Required: false

Data type: boolean

disallowServeServletsByClassName

Disallows the use of serveServletsByClassnameEnabled on the application server level. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.disallowserveservletsbyclassname.

Default: false

Required: false

Data type: boolean

doNotServeByClassName

A semi-colon delimited list of classes to be completely disallowed from being served by classname. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.donotservebyclassname.

Default:

Required: false

Data type: string

trustHostHeaderPort

Set this property to true and the com.ibm.ws.webcontainer.extractHostHeaderPort custom property to true to return the port number from the request host header first.

Default: false

Required: false

Data type: boolean

trusted

Enables the application server to use inbound private headers from the web server plug-in.

Default: true

Required: false

Data type: boolean

extractHostHeaderPort

The web container will return a port number from the host header, if any, or the URL port on which the client connection was accepted. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.extracthostheaderport.

Default: false

Required: false

Data type: boolean

httpsIndicatorHeader

For SSL offloading, set to the name of the HTTP header variable inserted by the SSL accelerator/proxy/load balancer.

Default:

Required: false

Data type: string

exposeWebInfOnDispatch

If true, a servlet can access files in the WEB-INF directory. If false (default), a servlet cannot access files the WEB-INF directory.

Default: false

Required: false

Data type: boolean

decodeUrlPlusSign

Decode the plus sign when it is part of the URL. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.decodeurlplussign.

Default: false

Required: false

Data type: boolean

channelWriteType

When set to 'sync', responses will be written synchronously; otherwise, responses will be written asychronously. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.channelwritetype.

Default: async

Required: false

Data type: string

suppressHtmlRecursiveErrorOutput

Suppresses the exception information from appearing in the HTML output when there is a recursive error that cannot be handled by an application's configured error page. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.suppressHtmlRecursiveErrorOutput.

Default: false

Required: false

Data type: boolean

fileWrapperEvents

Web container will generate SMF and PMI data when serving the static files. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.fileWrapperEvents.

Default: false

Required: false

Data type: boolean

defaultTraceRequestBehavior

Restore HTTP TRACE processing. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.DefaultTraceRequestBehavior.

Default: false

Required: false

Data type: boolean

defaultHeadRequestBehavior

Restore the behavior where the HEAD request is not subject to the security constraint defined for the GET method. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.DefaultHeadRequestBehavior.

Default: false

Required: false

Data type: boolean

tolerateSymbolicLinks

Enables the web container to support the use of symbolic links. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.TolerateSymbolicLinks.

Default: false

Required: false

Data type: boolean

symbolicLinksCacheSize

Initial size of the symbolic link cache. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.SymbolicLinksCacheSize.

Default: 1000

Required: false

Data type: int

enableErrorExceptionTypeFirst

Web container is updated to search and use the exception-type before the error-code. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.enableErrorExceptionTypeFirst.

Default: false

Required: false

Data type: boolean

enableMultiReadOfPostData

Retain post data for multiple read accesses. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.enablemultireadofpostdata.

Default: false

Required: false

Data type: boolean

copyAttributesKeySet

Web container will return an enumeration of a copy of the list of attributes to the servlet to avoid a concurrent access error by the servlet. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.copyattributeskeyset.

Default: false

Required: false

Data type: boolean

dispatcherRethrowsEr

Web container will re-throw errors allowing interested resources to process them. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.dispatcherRethrowser.

Default: true

Required: false

Data type: boolean

ignoreSessiononStaticFileRequest

Improves performance by preventing the web container from accessing a session for static file requests involving filters. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.IgnoreSessiononStaticFileRequest.

Default: false

Required: false

Data type: boolean

invokeFilterInitAtStartup

Web container will call the filter's init() method at application startup. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.invokeFilterInitAtStartup.

Default: true

Required: false

Data type: boolean

enableJspMappingOverride

Allow the JSP mapping to be overridden so the application can serve the JSP contents itself. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.enablejspmappingoverride.

Default: false

Required: false

Data type: boolean

enableDefaultIsElIgnoredInTag

Always evaluate whether to ignore EL expressions in tag files. If parent JSP files have different isELIgnored settings, the setting will be re-evaluated in the tag file. The equivalent custom property in the full profile application server is com.ibm.ws.jsp.enabledefaultiselignoredintag.

Default: false

Required: false

Data type: boolean

parseUtf8PostData

Web container will detect non URL encoded UTF-8 post data and include it in the parameter values. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.parseutf8postdata.

Default: false

Required: false

Data type: boolean

logServletContainerInitializerClassLoadingErrors

Log servlet container class loading errors as warnings rather than logging them only when debug is enabled. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.logservletcontainerinitializerclassloadingerrors.

Default: false

Required: false

Data type: boolean

allowIncludeSendError

Allow RequestDispatch to send errors on Include methods. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.allowincludesenderror.

Default: false

Required: false

Data type: boolean

skipMetaInfResourcesProcessing

Do not search the meta-inf directory for application resources. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.skipmetainfresourcesprocessing.

Default: false

Required: false

Data type: boolean

metaInfResourcesCacheSize

Initial size (number of entries) of the meta-inf resource cache. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.metainfresourcescachesize.

Default: 20

Required: false

Data type: int

xPoweredBy

Alternative string for the X-Powered-By header setting. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.xpoweredby.

Required: false

Data type: string

disableXPoweredBy

Disable setting of the X-Powered-By header. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.disablexpoweredby.

Default: false

Required: false

Data type: boolean

deferServletLoad

Defer servlet loading and initialization until the first request.

Default: true

Required: false

Data type: boolean

asyncMaxSizeTaskPool

Maximum size of tasks in the Async task pool before automatically purging canceled tasks. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.asyncmaxsizetaskpool.

Default: 5000

Required: false

Data type: int

asyncPurgeInterval

Time interval to wait between each required purge of the cancelled task pool. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.asyncpurgeinterval.

Default: 30000

Required: false

Data type: int

asyncTimeoutDefault

Async servlet timeout value used when a timeout value has not been explcitly specified. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.asynctimeoutdefault.

Default: 30000

Required: false

Data type: int

asyncTimerThreads

Maximum number of threads to use for async servlet timeout processing. The equivalent custom property in the full application server profile is com.ibm.ws.webcontainer.asynctimerthreads.

Default: 2

Required: false

Data type: int

Parent topic: Server configuration

Parent topic: Administer the Liberty profile

Tasks:
View the schema documentation for the server configuration
Administer the Liberty profile using developer tools
Edit the Liberty profile configuration using developer tools
Displaying the server configuration in a merged view
Control dynamic updates
Deploy applications to the Liberty profile
Add and remove Liberty features
Specify Liberty profile bootstrap properties
Use include elements in configuration files
Configure TAI
Access local and JMX REST connectors
Mapping the administrator role
Tune the Liberty profile
Configure session persistence
Intel Advanced Encryption Standard New Instructions