1 Introduction

Coherence*Web is an HTTP session management module dedicated to managing session state in clustered environments. Built on top of Oracle Coherence, Coherence*Web:

Coherence*Web and other Application Servers

For third-party application servers and a few legacy versions of WebLogic Server (9.2.1, 9.2.3, 10.3, 10.3.1), Coherence*Web provides a generic installer, the WebInstaller, that transparently instruments your Web applications. Chapter 3, "Installing Coherence*Web on Other Application Servers," describes how to use the WebInstaller to install Coherence*Web on these servers.

1.1 Supported Web Containers

Table 1-1 summarizes the Web containers supported by the Coherence*Web Session Management Module. It also provides links to the information required to install Coherence*Web. Notice that all of the Web containers (except Oracle WebLogic Server 10.3.3) share the same general installation instructions. A few, such as Caucho Resin, and WebLogic 10.x, require extra, container-specific steps that you must complete before starting the general installation instructions.

To install the Coherence*Web Session Management Module on WebLogic Server 10.3.1 and later, you can use SPI-based installation. For instructions on installing the Management Module on WebLogic Server 10.3.3, see Chapter 2, "Using Coherence*Web with WebLogic Server."

Note:

The value in the Server Type Alias column is used only by the Coherence*Web WebInstaller installation. The value is passed to the WebInstaller though the -server command line option.

Table 1-1 Web Containers Supported by Coherence*Web

Application Server Server Type Alias See this Installation Section

Apache Tomcat 5.5.x

Tomcat/5.5.x

"General Instructions for Installing Coherence*Web Session Management Module" and "Enabling Sticky Sessions for Apache Tomcat Servers"

Apache Tomcat 6.0.x

Tomcat/6.0.x

"General Instructions for Installing Coherence*Web Session Management Module" and "Enabling Sticky Sessions for Apache Tomcat Servers"

Caucho Resin 3.1.x

Resin/3.1.x

"Installing on Caucho Resin 3.1.x"

IBM WebSphere 5.x

WebSphere/5.x

"General Instructions for Installing Coherence*Web Session Management Module"

IBM WebSphere 6.x

WebSphere/6.x

"General Instructions for Installing Coherence*Web Session Management Module"

IBM WebSphere 7.x

WebSphere/7.x

"General Instructions for Installing Coherence*Web Session Management Module" and "Decoding URL Session IDs for IBM WebSphere 7.x Servers"

JBoss Application Server

Generic or Jetty/5.1.x

"General Instructions for Installing Coherence*Web Session Management Module"

Jetty 5.1.x

Jetty/5.1.x

"General Instructions for Installing Coherence*Web Session Management Module"

Jetty 6.1.x

Generic

"General Instructions for Installing Coherence*Web Session Management Module"

Oracle OC4J 10.1.2.x

Oracle/10.1.2.x

"General Instructions for Installing Coherence*Web Session Management Module"

Oracle OC4J 10.1.3.x

Oracle/10.1.3.x

"General Instructions for Installing Coherence*Web Session Management Module"

Oracle WebLogic 9.2 MP1 Oracle WebLogic 10.3

WebLogic/9.x WebLogic/10.x

For WebInstaller and SPI-based installations, see the User's Guide for Oracle Coherence*Web, Release 3.5

Oracle WebLogic 10.x

WebLogic/10.x

For WebInstaller installations, see "Installing on Oracle WebLogic 10.x"

Sun Application Server 8.x

Generic

"General Instructions for Installing Coherence*Web Session Management Module"

Sun GlassFish 2.x

Generic

"General Instructions for Installing Coherence*Web Session Management Module"


1.2 Installation and Deployment Road Map

This section provides a general outline of the deployment decisions you should make before you configure and deploy Coherence*Web. Coherence*Web is supported on many different application servers. Regardless of which application server you are using, you might have to change some Coherence*Web configuration options to meet your particular requirements, such as packaging considerations, session model, session locking mode and deployment topology.

1.2.1 Choose your Cluster Node Isolation

Cluster node isolation refers to the scope of the Coherence nodes that are created within each application server JVM. Several different isolation modes are supported.

For example: you may be deploying multiple applications to the container that require the use of the same cluster (or one Coherence node); you may have multiple Web applications packaged in a single EAR file that want to use a single cluster; or you may have Web applications that must keep their session data separate and must be deployed to their own individual Coherence cluster. These choices and the deployment descriptors and elements that must be configured are described in "Cluster Node Isolation".

1.2.2 Choose your Locking Mode

Locking mode refers to the behavior of HTTP sessions when they are accessed concurrently by multiple Web container threads. Coherence*Web offers several different session locking options. For example, you can allow multiple nodes in a cluster to access an HTTP session simultaneously, or allow only one thread at a time to access an HTTP session. You can also allow multiple threads to access the same Web application instance while prohibiting concurrent access by threads in different Web application instances. These choices, and the deployment descriptors and elements that must be configured, are described in "Session Locking Modes".

1.2.3 Choose How to Scope Sessions and Session Attributes

Session and session attribute scoping refers to the fine-grained control over how both session data and session attributes are scoped (or "shared") across application boundaries. Coherence*Web supports sharing sessions across Web applications and restricts which session attributes are shared across the application boundaries. These choices, and the deployment descriptors and elements that must be configured, are described in "Session and Session Attribute Scoping".

1.2.4 Choose When to Clean Up Expired HTTP Sessions

Coherence*Web provides a Session Reaper which invalidates sessions that have expired. "Cleaning Up Expired HTTP Sessions" describes the Session Reaper.

1.2.5 Choose the Installation Method

The installation procedure that you follow depends on your application server. "Supported Web Containers" provides a list of the application servers supported by Coherence*Web.