Liberty profile web feature properties

Specify the web feature for your server definition to identify web-based applications and add functions, such as session replication.

Deprecated feature The web feature is deprecated. Use the webApp feature when you want to replicate HTTP session data for fault tolerance.

You can set the following attributes on the xsWebAppV85 element of the server.xml file:

Parameters

objectGridType

A string value that is set to REMOTE, which specifies that session data is stored outside of the server on which the web application is running.

objectGridName

A string value that defines the name of the ObjectGrid instance used for a particular web application. The default name is session.

This property must reflect the objectGridName in both the ObjectGrid XML and deployment XML files used to start the eXtreme Scale container servers.

catalogHostPort

The catalog server can be contacted to obtain a client side ObjectGrid instance. The value must be of the form host:port<,host:port>. The host is the listener host on which the catalog server is running. The port is the listener port for that catalog server process. This list can be arbitrarily long and is used for bootstrapping only. The first viable address is used. It is optional inside WebSphere® Application Server if the catalog.services.cluster property is configured.

replicationInterval

An integer value (in seconds) that defines the time between writing of updated sessions to ObjectGrid. The default is 10 seconds. Possible values are from 0 to 60. 0 means that updated sessions are written to the ObjectGrid at the end of servlet service method call for each request. A higher replicationInterval value improves performance because fewer updates are written to the data grid. However, a higher value makes the configuration less fault tolerant.

This setting applies only when objectGridType is set to REMOTE.

sessionTableSize

An integer value that defines the number of session references kept in memory. The default is 1000.

This setting pertains only to a REMOTE topology.

Sessions are evicted from the in-memory table based on least recently used (LRU) logic. When a session is evicted from the in-memory table, it is invalidated from the web container. However, the data is not removed from the grid, so subsequent requests for that session can still retrieve the data. This value must be set higher than the web container maximum thread pool value, which reduces contention on the session cache.

fragmentedSession

A string value of either true or false. The default value is true. Use this setting to control whether the product stores session data as a whole entry, or stores each attribute separately.

Set the fragmentedSession parameter to true if the web application session has many attributes or attributes with large sizes. Set fragmentedSession to false if a session has few attributes, because all the attributes are stored in the same key in the data grid.

In the previous, filter-based implementation, this property was referred to as persistenceMechanism, with the possible values of ObjectGridStore (fragmented) and ObjectGridAtomicSessionStore (not fragmented).

securityEnabled

A string value of either true or false. The default value is false. This setting enables eXtreme Scale client security. It must match the securityEnabled setting in the eXtreme Scale server properties file. If the settings do not match, an exception occurs.

credentialAuthentication

Indicates if credential authentication is enforced or supported.

Never

No client certificate authentication is enforced.

Required
Credential authentication is always enforced. If the server does not support credential authentication, the client cannot to connect to the server.
Supported
(Default) Credential authentication is enforced only if both the client and server support credential authentication.
authenticationRetryCount
Specifies the name of the class that implements the com.ibm.websphere.objectgrid.security.plugins.CredentialGenerator interface. This class is used to get credentials for clients. The default value is 0.
credentialGeneratorClass

The name of the class that implements the com.ibm.websphere.objectgrid.security.plugins.CredentialGenerator interface. This class is used to obtain credentials for clients.

credentialGeneratorProps

The properties for the CredentialGenerator implementation class. The properties are set to the object with the setProperties(String) method. The credentialGeneratorProps value is used only if the value of the credentialGeneratorClass property is not null.

objectGridXML

The file location of the objectgrid.xml file.

objectGridDeploymentXML

Specifies the location of the objectGrid deployment policy XML file.

cookieDomain
Specifies if you require sessions to be accessible across hosts. Set the value to the name of the common domain between the hosts.
cookiePath
The default path is "/".
reuseSessionID
Set to true if the underlying web container reuses session IDs across requests to different hosts. The default value is false. The value of this property must be the same as the value in the web container. If you are using WebSphere Application Server and configuring eXtreme Scale HTTP session persistence using the administrative console or wsadmin tool scripting, the web container custom property HttpSessionIdReuse=true is added by default. The reuseSessionID is also set to true. If you do not want the session IDs to be reused, set the HttpSessionIdReuse=false custom property on the web container custom property before you configure eXtreme Scale session persistence.
shareSessionsAcrossWebApps
Specifies if sessions are shared across web applications, specified as a string value of either true or false. The default is false. The servlet specification states that HTTP Sessions cannot be shared across web applications. An extension to the servlet specification is provided to allow this sharing.
useURLEncoding
Set to true if you want to enable URL rewriting. The default value is false, which indicates that cookies are used to store session data. The value of this parameter must be the same as the web container settings for session management.
useCookies
The default value is false.