Home

User interface settings


Enable session management

Enable session management to use WebSphere eXtreme Scale embedded or remote data grid or a WebSphere DataPower XC10 appliance for session persistence.

Choose one of the following options to manage session persistence:

  • WebSphere DataPower XC10 appliance
  • Remote eXtreme Scale data grid
  • Embedded eXtreme Scale data grid

To configure, you can use the enterprise application installation wizard, or use the application or server detail pages...

  • Version 7.0: Applications | New application | New Enterprise Application | Detailed path for creating the application

  • Version 7.0: Applications | Application Types | WebSphere enterprise applications | application_name | Web Module properties | Session management | Session management settings

  • Version 7.0: Servers | Server Types | WebSphere application servers | server_name | Container settings | Session management settings


WebSphere DataPower XC10 appliance specific settings

The following settings are specific to configuring the XC10 appliance for session persistence.

IP or host name of the WebSphere DataPower XC10 appliance IP or host name of the appliance to use for persisting sessions.
IBM WebSphere DataPower XC10 appliance administrative credentials User name and Password used to log in to the XC10 appliance user interface. To test the connection to the appliance click

Session persistence preference Data grid on which sessions are persisted.

  • Persist sessions in a new data grid on the XC10 appliance. You can then specify a Data grid name.

  • Persist sessions in an existing data grid on the XC10 appliance. You can then enter or browse for an Existing data grid name.


Remote eXtreme Scale data grid configuration

The following settings are specific to configuring the remote eXtreme Scale grid for session persistence.

Catalog service domain that manages the remote session data grid Catalog service domain to use to manage the sessions. If no catalog service domains are displayed, or you want to create a new catalog service domain, click...

    System administration | WebSphere eXtreme Scale | Catalog service domains
Remote data grid in which to store session information Name of the data grid in the catalog service domain in which you want to store the session information. The list of active remote grids is populated when you select a catalog service. The remote data grid must already exist in the eXtreme Scale configuration.


Embedded eXtreme Scale data grid configuration

The following settings are specific to configuring an embedded eXtreme Scale configuration. In the embedded eXtreme Scale scenario, the eXtreme Scale processes are hosted by WebSphere Application Server processes.

  • Use default ObjectGrid configuration

  • Specify custom ObjectGrid configuration files

    Full path to objectgrid.xml file to copy into configuration

    Full path to objectgrid.xml file for the configuration to use.

    Full path to objectgriddeployment.xml file to copy into configuration

    Full path to objectgriddeployment.xml file for the configuration to use.


Catalog service domain collection

Catalog service domains define a group of catalog servers that manage the placement of shards and monitors the health of container servers in the data grid.

To view this administrative console page, click System administration > WebSphere eXtreme Scale > Catalog service domains. To create a new catalog service domain, click New. To delete a catalog service domain, select the catalog service domain you want to remove and click Delete.


Test Connection

When you click the Test connection button, all of the defined catalog service domain end points are queried one by one, if any one end point is available, returns a message that indicates that the connection to the catalog service domain was successful.

Set false Defines the service domain used as the default. Select one catalog service domain as the default and click Set default. Only one catalog service domain can be selected as the default.
Name Name for the catalog service domain.
Default Which catalog service domain in the list is the default. The default catalog service domain is indicated with the following icon: .


Catalog service domain settings

Use this page to manage the settings for a specific catalog service domain. Catalog service domains define a group of catalog servers that manage the placement of shards and monitors the health of container servers in the data grid. You can define a catalog service domain that is in the same cell as the dmgr. You can also define remote catalog service domains if the WXS configuration is in a different cell or the data grid is made up of Java SE processes.

To view this administrative console page, click...

    System administration | WebSphere eXtreme Scale | Catalog service domains | catalog_service_domain_name

Test connection When you click the Test connection button, all of the defined catalog service domain end points are queried one by one, if any one end point is available, returns a message that indicates that the connection to the catalog service domain was successful. Use this button to test configured the connection and security information correctly.

Name Name of the catalog service domain.
Enable this catalog service domain as the default unless another catalog service domain is explicitly specified The selected catalog service domain becomes the default catalog service domain for the cell. Each server profile in the cell that is augmented with the WebSphere eXtreme Scale profile belongs to the selected catalog service domain.

All eXtreme Scale containers that are embedded in Java EE application modules connect to the default domain. Clients can connect to the default domain using the API...

    ServerFactory.getServerProperties().getCatalogServiceBootstrap() API

...to retrieve the catalog service endpoints to use when calling the ObjectGridManager.connect() API.

If you change the default domain to point to a different set of catalog servers, then all containers and clients refer to the new domain after they are restarted.

Enable IBM eXtremeIO (XIO) communication Specifies if the catalog service domain uses XIO communication. If this option is not selected, the Object Request Broker (ORB) is used.

Note: You cannot enable XIO communication on remote servers from the WebSphere Application Server administrative console. Enable XIO on remote servers when you start the servers with the startXsServer script.

Catalog servers List of catalog servers that belong to this catalog service domain.

Click New to add a catalog server to the list. This catalog server must already exist in the eXtreme Scale configuration. You can also edit or delete a server from the list by selecting the endpoint and then clicking Edit or Delete.  Define the following properties for each catalog server endpoint:

Catalog server endpoint

Name of the existing application server or remote server on which the catalog service is running. A catalog service domain cannot contain a mix of existing application servers and remote server endpoints.

  • Existing application server: Path of an application server, node agent, or dmgr in the cell. A catalog service starts automatically in the selected server. Select from the list of the existing application servers. All of the application servers that you define within the catalog service domain must be in the same core group.

  • Remote server: Host name of the remote catalog server.

    For WebSphere eXtreme Scale remote endpoints: Host name of the remote catalog server process. Start the remote servers with the startOgServer or startXsServer script or the embedded server API.

    Note: You cannot enable XIO communication on remote servers from the WebSphere Application Server administrative console. Enable XIO on remote servers when you start the servers with the startXsServer script.

Client Port

Port used for communication between the catalog servers in the catalog service domain. Required for catalog servers running in WebSphere Application Server processes. You can set the value to any port that is not being used by another process.

Listener Port

Port used for communication with clients. Required for remote endpoints and must match the value used when the catalog service was started. The listener port is used by clients and containers to communicate with the catalog service.

For WebSphere eXtreme Scale remote endpoints:

  • If you are using the ORB transport, the BOOTSTRAP_ADDRESS value for each WebSphere Application Server application server is used.
  • If you are using the IBM eXtremeIO transport, the XIO_ADDRESS value is used.

Status

Catalog server endpoint status...

Icon Definition

Unknown

Started

Stopped


Client security properties

Use this page to configure client security for a catalog service domain. These settings apply to all the servers in the catalog service domain. These properties can be overridden by specifying a splicer.properties file with the com.ibm.websphere.xs.sessionFilterProps custom property or by splicing the application EAR file.

To view this administrative console page, click System administration > WebSphere eXtreme Scale > Catalog service domains > catalog_service_domain_name > Client security properties.

Enable client security Client security is enabled for the catalog server. The server properties file that is associated with the selected catalog server must have a matching securityEnabled setting in the server properties file. If these settings do not match, an exception results.

Credential authentication Indicates if credential authentication is enforced or supported.

Never

No client credential 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

Credential authentication is enforced only if both the client and server support credential authentication.
Authentication retry count Number of times that authentication gets tried again if the credential is expired. If you do not want to try authentication again, set the value to 0.
Credential generator class Indicates the com.ibm.websphere.objectgrid.security.plugins.CredentialGenerator implementation class, so the client retrieves the credential from the CredentialGenerator object.

You can choose from two predefined credential generator classes, or you can specify a custom credential generator. If you choose a custom credential generator, you must indicate the name of the credential generator class.

  • com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredentialGenerator
  • com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredentialGenerator
  • Custom credential generator

Subject type Specifies if you are using the J2EE caller or the J2EE runAs subject type. Specify this value when you choose the WSTokenCredentialGenerator credential generator.

  • runAs: The subject contains the principal of the J2EE run as identity and the J2EE run as credential.

  • caller: The subject contains the principal of the J2EE caller and the J2EE caller credential.

User ID User ID when you are using the UserPasswordCredentialGenerator credential generator implementation.
Password Password when you are using the UserPasswordCredentialGenerator credential generator implementation.
Credential generator properties Properties for a custom CredentialGenerator implementation class. The properties are set in the object with the setProperties(String) method. The credential generator properties value is used only when a value is specified for the Credential generator class field.


Catalog service domain custom properties

You can further edit the configuration of the catalog service domain by defining custom properties.

To view this administrative console page, click System administration > WebSphere eXtreme Scale > Catalog service domains > Custom properties. To create a new custom property, click New. Name Name of the custom property for the catalog service domain. Value Value for the custom property for the catalog service domain.