App Server Configuration for Failover

This documentation is an older version of JasperReports Server Ultimate Guide. View the latest documentation.

As of release 5.5, JasperReports Server supports partial session replication and provides the beans to enable it. The app server usually manages the user session for a web application and is responsible for the policies that allow the session to be replicated in a cluster environment. However, you must also configure parts of JasperReports Server, including the Ehcache component.

To configure JasperReports Server nodes for partial session replication:

Make sure that the subnet that contains all the cluster nodes is configured to allow IP multicasting. This is usually required by the app server for replication, and it is also required by the server's Ehcache component in a cluster environment.

On each node of the cluster, edit the file <web-app>/WEB-INF/web.xml to make the following changes:

Locate the listener of class RequestContextListener and replace it with the listener of class TolerantRequestContextListener. The new listener class is given in comments that you need to uncomment as follows:

Locate the ClusterFilter that is given in comments and uncomment it as follows:

Locate the corresponding mapping for the ClusterFilter and uncomment it as well. You must also uncomment the <distributable> element as well.

On each node of the cluster, enable session replication in your app server or web container. For example, to enable session replication on Apache Tomcat 6.x, edit the file <tomcat>/conf/server.xml as follows.

Add the Cluster definition within the <Engine name="Catalina" defaultHost="localhost"> configuration. In this example, 123.45.6.701 is the IP address of the node being configured. This example uses Delta Manager, but you can also use Backup Manager: