Sun Java System Web Server 7.0 Update 5 Administrator's Guide

Session Replication

Session replication is a mechanism used to replicate the data stored in a session across different instances. However, the replicated instance must be part of the same cluster. When session replication is enabled in a cluster environment, the entire session data is copied on a replicated instance. However, the session replication operation does not copy the attributes that cannot be serialized in a session and any instance specific data.

Session replication along with load balancing provides good failover capabilities for web applications.

Session Replication and Failover Operation

This section describes the session replication operation in detail.

At the end of a web request, the Web Server determines whether the session data needs to be copied through the session replication configuration that is stored in the server configuration file, the server.xml.

Consider a use case of four instances forming a cluster with session replication enabled on the Administration Server.

The session replication process in a Web Server cluster of four instances (A, B, C, and D) running on four nodes is as follows:

The failover process in a Web Server clustered environmentis as follows:

Web Server 7.0 does not support the following features in session replication:

Enabling Session Replication

You can enable session replication in a cluster using either the Admin Console or the CLI. Before you enable session replication, make sure that your browser is cookie enabled.

The server.xml file contains the information related to session replication. A sample server.xml file with session replication enabled is given below:


If you are using the default values for the following elements, the entry for these elements will not be available in the server.xml configuration file:

Port number (default is 1099)

Protocol (default is jrmp)

Encrypted (default is false)

Getattribute Triggers Replication (default is true)

Replica Discovery MaxHops (default is –1)

Startup Discovery Timeout (default is 0. Relies on Java API to get system timimg. In non Unix based operating systems, it may not be accurate.)

Cookie Name (default is CLUSTERSESSIONLOCATOR)

For more information about these session replication properties, see the Sun Java System Web Server 7.0 Update 5 Administrator’s Configuration File Reference.

Configuring a Web Application for Session Replication

To enable the server to replicate the session, the web application must also be enabled for session replication.

  1. To enable session replication for a web application, modify the sun-web.xml configuration file located in the <web-application>/WEB-INF directory.

    The modification needed in the sunweb.xml is as follows:

    Change the element <session-manager/> to <session-manager persistence-type="replicated">

    The sample sun-web.xml file with session replication enabled is given below:

         <session-manager persistence-type="replicated">
  2. After modifying the sunweb.xml file, either rebuild the web application or re-jar the application to create a web application archive (a war file).

  3. Restart all the instances to make the web application available on all the instances.

  4. The web application is accessible from all the nodes in the cluster. To access the web application, in a browser, type the following:


    Note –

    A directory that is accessible to all nodes is the best way to store the applications for deployment. This directory, however, need not be accessible to the Administration Server. It is recommended to make directory-based deployments of web applications that are more than 1 MB in size.

    To create search collections, ensure that the search collection resides in a common directory that is accessible to all the nodes.