Skip Headers
Oracle® Coherence User's Guide for Oracle Coherence*Web
Release 3.7.1

Part Number E22620-03
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

10 Using Coherence*Web with WebLogic Portal

Coherence*Web can be used in an WebLogic Portal environment to provide session state management based on Coherence. Coherence*Web allows for more advanced deployment models, session models, and locking modes in a clustered environment. For more information about these features, see Chapter 5, "Coherence*Web Session Management Features."

This chapter contains the following sections:

10.1 Downloading Required Patches (Optional)

Note:

Oracle WebLogic Server releases 10.3.1 or later do not require a patch. If you are using release 10.3.1 or later, you can skip this section.

If you are using WebLogic Server 10.3 or earlier, apply the appropriate software patch to all WebLogic Server instances that are hosting the Web applications that will use Coherence*Web. Table 10-1 lists the appropriate patches for your version of WebLogic Server and Coherence release level.

Table 10-1 Required WebLogic Server and Coherence Patch Release Levels


WebLogic Server 9.2 MP1 WebLogic Server 10.3 WebLogic Server 10.3.1 and later

WebLogic Smart Update

Patch ID: AJQB

Patch ID: 6W2W

No patch required.


The patches can be downloaded by using either the MyOracleSupport Web site or the WebLogic Server's Smart Update utility.

To Download from MyOracleSupport: 

  1. Go to the MyOracleSupport Web site to manually locate the patch.

    http://support.oracle.com/

  2. Select the Patches tab and click the Simple Search link. On the subsequent screen, submit a search for a Patch Number/Name with the appropriate value (for example, 11399293).

  3. Download the patch zip file from the displayed results.

  4. See the README.txt included in the patch zip file for instructions for applying the Coherence patch.

To Download Using Smart Update: 

  1. Review the instructions in the Smart Update Guide for using Smart Update to install WebLogic Server patches.

    For production environments, Oracle recommends that you review the Smart Update production installation.

    You can find the Smart Update Guide at this URL:

    http://download.oracle.com/docs/cd/E14759_01/doc.32/e14143/toc.htm

  2. Select Start then All Programs then Oracle WebLogic then Smart Update to open the login dialog box. Use your support ID and password to log in.

    Figure 10-1 Oracle Smart Update Login Dialog Box

    WebLogic Smart Update Login Dialog Box
    Description of "Figure 10-1 Oracle Smart Update Login Dialog Box"

  3. Download and apply the appropriate patch for your release of WebLogic Server. Figure 10-2 illustrates the Oracle Smart Update browser.

    Figure 10-2 Oracle Smart Update Browser

    WebLogic Smart Update Tree Browser
    Description of "Figure 10-2 Oracle Smart Update Browser"

10.2 Using Coherence*Web with WebLogic Portal—Main Steps

Follow these steps to use Coherence*Web with WebLogic Portal:

  1. Start a Cache Server

  2. Modify the Session Configuration (Optional)

  3. Enable a P13N (Personalization) Cache Provider (Optional)

  4. Locate the Coherence JAR File

  5. Reference the SPI in the Portal Application

  6. Enable Coherence*Web Sessions

  7. Create and Deploy the Application

10.2.1 Start a Cache Server

A cache server JVM is a dedicated Coherence JVM that is responsible for storing and managing all cached data (in this case, the HTTP Session state). One or more cache server JVMs must be started before the WebLogic Server or WebLogic Portal JVMs can be started. Follow these steps to start a cache server:

  1. Create a script for starting a Cache Server JVM. The following is an example of a script that starts a storage-enabled cache server for use with Coherence*Web. See "JVM Tuning" in Developer's Guide for Oracle Coherence for more information about tuning your particular JVM.

    java -server -Xms512m -Xmx512m -cp <Coherence installation dir>/lib/coherence.jar:<Coherence installation dir>/lib/coherence-web-spi.war -Dtangosol.coherence.management.remote=true -Dtangosol.coherence.cacheconfig=WEB-INF/classes/session-cache-config.xml -Dtangosol.coherence.session.localstorage=true com.tangosol.net.DefaultCacheServer
    
  2. Start one or more cache server JVMs using the script described in the previous step.

10.2.2 Modify the Session Configuration (Optional)

Modify the session-cache-config.xml file (if necessary) to customize the cache topology for Coherence*Web.

This configuration file is located in the coherence-web.jar file. If you modify the session-cache-config.xml file, then you must replace it in the JAR file.

See Appendix C, "Session Cache Configuration File" for a description of the default configuration of the session-cache-config.xml file.

10.2.3 Enable a P13N (Personalization) Cache Provider (Optional)

If you want to use the Coherence P13N (Personalization) cache provider, then copy the coherence-wlp.jar file into the APP-INF\lib directory of the portal enterprise application.

See Integration Guide for Oracle Coherence for more information about the P13N CacheProvider SPI implementation and Web Services for Remote Portlets (WSRP)-federated portals.

If you want to use the Coherence P13N cache as the default cache provider, add the following line before the first <cache> element to the META-INF\p13n-cache-config.xml file in the portal enterprise application:

<default-provider-id>com.tangosol.coherence.weblogic</default-provider-id>

10.2.4 Locate the Coherence JAR File

Copy the coherence.jar file into the APP-INF\lib directory of the portal enterprise application.

10.2.5 Reference the SPI in the Portal Application

Reference the coherence-web-spi.war file by using a library reference (library-ref) in the WEB-INF\weblogic.xml file in the portal Web application:

<wls:library-ref>
   <wls:library-name>coherence-web-spi</wls:library-name>
</wls:library-ref>

10.2.6 Enable Coherence*Web Sessions

To enable Coherence*Web sessions, set the application parameter coherence-web-sessions-enabled to true in the WEB-INF\web.xml file in the portal Web application:

<context-param>
          <param-name>coherence-web-sessions-enabled</param-name>
          <param-value>true</param-value>
      </context-param>

10.2.7 Create and Deploy the Application

  1. In the portal domain, deploy the coherence-web-spi.war file as a library to the cluster.

  2. Create an EAR file for the application.

  3. In the portal domain, deploy the application EAR file to the cluster.

10.3 Using the Coherence Cache Provider with WebLogic Portal

The Coherence cache provider can be configured to provide caching services for enterprise applications that run on WebLogic Portal. To accomplish this, the cache providers and the WebLogic portal servers are set up to run in an out-of-process deployment topology.

In out-of-process topology, the WebLogic portal servers (or, WebLogic Portal server tier) are configured as cache clients with local storage disabled (that is, the tangosol.coherence.weblogic.localstorage, tangosol.coherence.distributed.localstorage, and tangosol.coherence.session.localstorage system properties are set to false) and there are dedicated JVMs running as cache servers, physically storing and managing the clustered data.

This approach has these benefits:

Out-of-process topology is the default recommendation of Oracle Coherence due to its flexibility. Figure 10-3 illustrates the out of process topology. Each of the WebLogic Portal servers in the portal tier maintain their own near cache. These near caches communicate with the session data cache which runs in a separate cache server tier.

See "Deploying Coherence Cache Provider for Out-of-Process Topology" for instructions on how to configure this topology.

Figure 10-3 Out-of-Process Deployment Topology for WebLogic Portal

Description of Figure 10-3 follows
Description of "Figure 10-3 Out-of-Process Deployment Topology for WebLogic Portal"

10.3.1 Deploying Coherence Cache Provider for Out-of-Process Topology

  1. Obtain the session cache and portal cache configuration files:

    • Extract the session-cache-config.xml file from the coherence-web.jar file.

    • Extract the portal-cache-config.xml file from the coherence-wlp.jar file.

  2. Merge the contents of the session-cache-config.xml and portal-cache-config.xml files so that a set of Coherence grid nodes can support both types of objects: session and P13N cache.

    You will need two copies of this file: one that will be used by the Coherence cache servers and one that will be used by the WebLogic Portal managed servers. The contents of the two files will be identical, except for the values of the local-storage properties in the portal cache and the session cache sections.

    Example D-1 in Appendix D, "Cache Configuration for WebLogic Portal and Oracle Coherence" illustrates a merged configuration file that can be used for the WebLogic Portal managed servers. The local-storage values for the session cache and portal cache are set to false. The configuration file for the Coherence cache server can be the same as Example D-1, except the values for the local-storage system property in the session cache configuration section and portal cache configuration section must be set to true.

  3. Use the merged configuration file for the WebLogic Portal managed server as the cache configuration file for the servers. For each application that will run on the WebLogic Portal managed server, copy the file to the application's APP-INF/classes directory.

  4. Set the merged configuration file for the Coherence caches as the cache configuration for the Coherence grid JVMs. For example, in the following system property to locate the cache configuration file, portal-session-cache-config.xml represents the merged file:

    -Dtangosol.coherence.cacheconfig=D:\Coherence37\coherence\temp\portal-session-cache-config.xml
    
  5. Add the system properties to disable local storage for the WebLogic Portal managed servers. For example, you can add the following properties to your Coherence cache server startup script:

    -Dtangosol.coherence.weblogic.localstorage=false -Dtangosol.coherence.distributed.localstorage=false -Dtangosol.coherence.session.localstorage=false
    
  6. Deploy the coherence.jar, coherence-wlp.jar, and coherence-web-spi.war files as shared libraries to all of the WebLogic Portal managed servers where the application will be deployed.

    See the deployment instructions in "Using Coherence*Web with WebLogic Portal—Main Steps".

  7. Start the Coherence grid with the command line system properties for local storage and session storage set to true:

    ... -Dtangosol.coherence.weblogic.localstorage=true -Dtangosol.coherence.session.localstorage=true ...
    
  8. Start the WebLogic Portal managed servers.