Skip Headers
Oracle® Coherence Release Notes for Oracle Coherence
Release 3.6

Part Number E17969-02
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

2 Documentation Errata

This chapter describes changes, enhancements, and corrections made to the Oracle Coherence documentation library for the 3.6 release. The library can be found at the following URL:

http://download.oracle.com/docs/cd/E15357_01/index.htm

Documentation issues:

2.1 Packaging EAR Files When Using the Coherence Resource Adapter

The "Include the Required Libraries" section in the Oracle Coherence Developer's Guide provides instructions for packaging an EAR file when using the Coherence resource adapter. The instructions recommend placing the coherence.jar file in the root of the EAR file. This is a generic recommendation. When deploying to WebLogic Server, the coherence.jar file should be placed in the /APP-INF/lib directory of the EAR file. For example:

/coherence-transaction.rar
/APP-INF/lib/coherence.jar 

2.2 Using Oracle Coherence for C++ with MSVC 2005 SP1

Using Oracle Coherence for C++ with MSVC 2005 SP1 (x86 and x64) requires both the Microsoft Visual C++ 2005 Service Pack 1 Redistributable and the Microsoft Visual C++ 2005 Service Pack 1 Redistributable Package ATL Security Update. Coherence will not run without the security update. For more information on this update, see:

http://support.microsoft.com/?kbid=973544

The security update is available from the Microsoft Update Web site or directly from this URL:

http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=766a6af7-ec73-40ff-b072-9112bab119c2

2.3 Avoid Using the size() Operation on Transactional Caches

The size() operation, when performed transactional caches, is fairly complex. Avoid using this operation in a tight loop as it may result in blocking partition transfers.

2.4 The CohQL BACKUP CACHE Command Does Not Support POF

The "Writing a Serialized Representation of a Cache to a File" section of the Oracle Coherence Developer's Guide fails to mention that the CohQL BACKUP CACHE command does not back up cached POF objects. Objects must implement Serializable or ExternalizableLite to be backed up by this command.

2.5 Deprecated Elements Referenced in Developer's Guide

The Oracle Coherence Developer's Guide refers to the following elements which are no longer supported in the coherence.dtd:

<burst-mode>—This was a subelement of <packet-publisher>.

<serializer-name>—This was a subelement of <serializer>.

2.6 Maximum Value for Time-Based Configuration Elements

Time-based configuration elements, such as <expiry-delay> that are entered as an integer will max out to Integer.MAX_VALUE (2147483647) regardless of how they are entered (as milliseconds, seconds, minutes, hours, or days).

2.7 Typo in the manifest.mf File in the ActiveCache Documentation

There is a typo in the manifest.mf file in Example 6-3 in the Oracle® Fusion Middleware Using ActiveCache 11g Release 1 (10.3.3) documentation. "Implementation" was mis-spelled. Following is the corrected configuration:

Extension-List: active-cache
active-cache-Extension-Name: active-cache
active-cache-Specification-Version: 1.0
active-cache-Implementation-Version: 1.0

2.8 Error in .NET SSL Example

Example 5-8 in the Oracle Coherence Client Guide contains an element sequence error which prevents the example from successfully running. To run the example, the <stream-provider> node must precede the <remote-addresses> node within the <tcp-initiator> element as follows:

<tcp-initiator>
   <stream-provider>
      <ssl>
         <protocol>Tls</protocol>
         <local-certificates>
            <certificate>
               <url>C:\</url>
                  <password>password</password>
                  <flags>DefaultKeySet</flags>
            </certificate>
         </local-certificates>
      </ssl>
   </stream-provider>
   <remote-addresses>
      <socket-address>
         <address>198.168.1.5</address>
         <port>9099</port>
      </socket-address>
   </remote-addresses>
   <connect-timeout>10s</connect-timeout>
</tcp-initiator>

2.9 Updated Instructions for Configuring Cluster Nodes for Coherence*Web

There were errors in the instructions for configuring Coherence*Web for cluster nodes in the User's Guide for Oracle Coherence*Web. The following sections provide the corrected instructions.

2.9.1 Configure Cluster Nodes (WebLogic Server 10.3.3 and Later)

Coherence*Web can have application server-scope, EAR-scope, or WAR-scope. Like Coherence clusters, scoping of Coherence*Web depends on the placement of the coherence.jar in the classloader's hierarchy.

WebLogic Server 10.3.3 provides several features that allow your applications to more easily interact with the Coherence cache. For a complete discussion of these features see Using ActiveCache. To employ ActiveCache functionality in your applications, you must also deploy the active-cache.jar file, which you can find in the WL_HOME/common/deployable-libraries directory.

Note:

The application server-scoped cluster configuration should be considered very carefully and never used in environments where application interaction is unknown or unpredictable.

An example of such an environment may be a deployment where multiple application teams are deploying applications written independently, without carefully coordinating and enforcing their conventions and naming standards. With this configuration, all applications are part of the same cluster and the likelihood of collisions between namespaces for caches, services, and other configuration settings is quite high and may lead to unexpected results.

For these reasons, Oracle Coherence strongly recommends that you use EAR-scoped and WAR-scoped cluster node configurations. If you are in doubt regarding which deployment topology to choose, or if this warning applies to your deployment, then do not choose the application server-scoped cluster node configuration.

2.9.1.1 Configuring Application Server-Scoped Cluster Nodes

If you are adding Coherence*Web for session management to a Coherence cluster, follow these steps:

  1. Edit your WebLogic Server system classpath to include coherence.jar and WL_HOME/common/deployable-libraries/active-cache.jar in the system classpath. The active-cache.jar should be referenced only from the deployable-libraries folder in the system classpath and should not be copied to any other location.

  2. Use the WebLogic Server Administration Console or the command line to deploy coherence-web-spi.war as a shared library.

  3. Enable Coherence*Web in your Web application.

    Add the library reference stanza illustrated in Example 2-1 to the weblogic.xml in each WAR file deployed in the WebLogic server that intends to use Coherence*Web.

    Example 2-1 Library Reference for a WAR File

    <weblogic-web-app>
      ...
        <library-ref>
          <library-name>coherence-web-spi</library-name>
        </library-ref>
      ...
    </weblogic-web-app>
    
  4. (Optional) If you must configure Coherence cluster properties, create a CoherenceClusterSystemResourceMBean and reference it in the ServerMBean.

    You can use WLST to reference the MBean. See createServerScopedCoherenceSystemResource in Using ActiveCache.

2.9.1.2 Configuring EAR-Scoped Cluster Nodes

Follow these steps to use Coherence*Web for session management:

  1. Use the WebLogic Server Administration Console or the command line to deploy the coherence.jar, active-cache.jar and coherence-web-spi.war files as shared libraries to all of the target servers where the application will be deployed.

    See "Install a Java EE Library" in the Oracle Fusion Middleware Oracle WebLogic Server Administration Console Help.

  2. Reference the coherence.jar, active-cache.jar, and coherence-web-spi.war files in the weblogic-application.xml file. Store the file in the EAR's META-INF/ directory.

    Example 2-2 illustrates a sample weblogic-application.xml file.

    Example 2-2 Coherence, Coherence Web SPI, and ActiveCache Referenced in weblogic-application.xml

    <weblogic-application ... >
    ...
          <library-ref>
               <library-name>coherence</library-name>
          </library-ref>
          <library-ref>
               <library-name>coherence-web-spi</library-name>
         </library-ref>
         <library-ref>
               <library-name>active-cache</library-name>
         </library-ref>
    ...
    </weblogic-application>
    
  3. (Optional) If you must configure Coherence cluster properties, create a CoherenceClusterSystemResourceMBean and reference it as a coherence-cluster-ref element in weblogic.xml file. This element allows the applications to enroll in the Coherence cluster as specified by the CoherenceClusterSystemResourceMBean attributes. For more information, see Using ActiveCache.

    Example 2-3 illustrates a sample configuration. The myCoherenceCluster MBean in the example is of type CoherenceClusterSystemResourceMBean.

    Example 2-3 Identifying a Coherence Cluster for EAR-Scoped Cluster Nodes

    <weblogic-web-app>
    ...
      <coherence-cluster-ref>
        <coherence-cluster-name>
         myCoherenceCluster
        </coherence-cluster-name>
      </coherence-cluster-ref> 
    ...
    </weblogic-web-app>  
    

2.9.1.3 Configuring WAR-Scoped Cluster Nodes

If you are using Coherence*Web for session management, follow these steps:

  1. Use the WebLogic Server Administration Console or the command line to deploy active-cache.jar and coherence-web-spi.war as shared libraries to all of the target servers where the application will be deployed. See "Install a Java EE Library" in the Oracle Fusion Middleware Oracle WebLogic Server Administration Console Help.

  2. Copy coherence.jar to the WAR file's WEB-INF/lib directory.

  3. If you deploy the coherence-web-spi.war file as a shared library, you must also create a shared library reference by adding the stanza illustrated in Example 2-4 to the weblogic.xml file in the WAR file's WEB-INF directory.

    Example 2-4 Library Reference for a Web Application

    <weblogic-web-app>
         ...
          <library-ref>
               <library-name>coherence-web-spi</library-name>
         </library-ref>
         ...
    <weblogic-web-app>
    
  4. Create a manifest.mf file to reference the active-cache.jar file. Copy the file to each WAR file's META-INF directory.

    Example 2-5 manifest.mf File to Reference active-cache.jar

    Extension-List: active-cache
    active-cache-Extension-Name: active-cache
    active-cache-Specification-Version: 1.0
    active-cache-Implementation-Version: 1.0
    
  5. (Optional) If you must configure Coherence cluster properties, create a CoherenceClusterSystemResourceMBean and reference it as a coherence-cluster-ref element in weblogic.xml or weblogic-ejb-jar.xml file.illustrates a sample configuration for WAR-scoped cluster nodes in the weblogic.xml file. The myCoherenceCluster MBean is of type CoherenceClusterSystemResourceMBean. For more information, see Using ActiveCache.

    Example 2-6 illustrates a sample configuration for WAR-scoped cluster nodes in the weblogic.xml file. The myCoherenceCluster MBean is of type CoherenceClusterSystemResourceMBean.

    Example 2-6 Identifying a Coherence Cluster for EAR-Scoped Cluster Nodes

    <weblogic-web-app>
    ...
      <coherence-cluster-ref>
        <coherence-cluster-name>
         myCoherenceCluster
        </coherence-cluster-name>
      </coherence-cluster-ref> 
    ...
    </weblogic-web-app>
    

2.9.2 Configure Cluster Nodes (WebLogic Server 10.3.2 and Earlier)

WebLogic Server 10.3.2 and earlier does not support ActiveCache.

Coherence cluster nodes are class loader scoped. Therefore, you must configure the number of unique Coherence cluster nodes in a Coherence*Web deployment before packaging the application(s). The packing and configuration options are described in the following sections:

Note:

The application server-scoped cluster configuration should be considered very carefully and never used in environments where application interaction is unknown or unpredictable.

An example of such an environment may be a deployment where multiple application teams are deploying applications written independently, without carefully coordinating and enforcing their conventions and naming standards. With this configuration, all applications are part of the same cluster and the likelihood of collisions between namespaces for caches, services, and other configuration settings is quite high and may lead to unexpected results.

For these reasons, Oracle Coherence strongly recommends that you use EAR-scoped and WAR-scoped cluster node configurations. If you are in doubt regarding which deployment topology to choose, or if this warning applies to your deployment, then do not choose the application server-scoped cluster node configuration.

2.9.2.1 Configuring Application Server-Scoped Cluster Nodes

  1. Deploy coherence-web-spi.war as a shared library on each WebLogic Server.

  2. Edit your WebLogic Server system classpath to include coherence.jar or copy the JAR to your $DOMAIN_HOME/lib directory.

  3. Enable Coherence*Web in your Web application.

    Add the library reference stanza illustrated in Example 2-7 to the weblogic.xml in each WAR file deployed in the WebLogic server that intends to use Coherence*Web.

    Example 2-7 Library Reference for a WAR File

    <weblogic-web-app>
         ...
          <library-ref>
               <library-name>coherence-web-spi</library-name>
         </library-ref>
         ...
    </weblogic-web-app> 
    

2.9.2.2 Configuring EAR-Scoped Cluster Nodes

  1. Use the WebLogic Server Administration Console to deploy coherence.jar and coherence-web-spi.war as shared libraries to all of the target servers where the application will be deployed. See "Install a Java EE Library" in the Oracle Fusion Middleware Oracle WebLogic Server Administration Console Help for more information.

  2. Reference the coherence.jar and coherence-web-spi.war files in the weblogic-application.xml file. Store the file in the EAR's META-INF directory.

    Example 2-8 illustrates a weblogic-application.xml file.

    Example 2-8 Coherence and Coherence Web SPI Referenced in weblogic-application.xml

    <weblogic-application ...>
    ...
          <library-ref>
               <library-name>coherence</library-name>
          </library-ref>
          <library-ref>
               <library-name>coherence-web-spi</library-name>
         </library-ref>
    ...
    </weblogic-application>
    

2.9.2.3 Configuring WAR-Scoped Cluster Nodes

  1. Use the WebLogic Server Administration Console or the command line to deploy coherence-web-spi.war as shared libraries to all of the target servers where the application will be deployed. See "Install a Java EE Library" in the Oracle Fusion Middleware Oracle WebLogic Server Administration Console Help.

  2. Copy coherence.jar to the WAR file's WEB-INF/lib directory.

  3. If you deploy coherence-web-spi.war as shared libraries, create a shared library reference by adding the stanza illustrated in Example 2-9 to the weblogic.xml file in the WAR file's WEB-INF directory.

    Example 2-9 Library Reference for a Web Application

    <weblogic-web-app>
         ...
          <library-ref>
               <library-name>coherence-web-spi</library-name>
         </library-ref>
         ...
    <weblogic-web-app>