Contents

List of Examples

List of Figures

List of Tables

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

Part I Coherence Features

1 Create and Use Coherence Caches

• Creating a Cache in Your Application
• Configuring the Caches
• Cache Configuration Descriptor Location
• Putting It all Together: Your First Coherence Cache Example
• Setting Up Your Test Environment
• Modifying the Cache Configuration

2 Implement Transactions, Locks, and Concurrency

• Concurrency Options
• Explicit Locking
• Transactions
• Container Integration
  • JCA
  • XA
• Entry Processors
• Data Source Integration

3 Perform Continuous Query

• Uses of Continuous Query Caching
• The Coherence Continuous Query Cache
• Constructing a Continuous Query Cache
  • Cleaning up the resources associated with a ContinuousQueryCache
• Caching only keys, or caching both keys and values
  • CacheValues Property and Event Listeners
• Listening to the ContinuousQueryCache
  • Achieving a Stable Materialized View
  • Support for Synchronous and Asynchronous Listeners
• Making the ContinuousQueryCache Read-Only

4 Managing Map Operations with Triggers

• A Map Trigger Example

5 Data Affinity

• Specifying Affinity
• Specifying Data Affinity with a KeyAssociation
• Specifying Data Affinity with a KeyAssociator
• Example of Using Affinity

6 Query the Cache

• Query Functionality
• Simple Queries
  • Querying Partitioned Caches
  • Querying Near Caches
• Query Concepts
• Queries Involving Multi-Value Attributes
• ChainedExtractor

7 Security Framework

• Transport Layer Security
• Access Controller
• Proof of Identity
• Proof of Trustworthiness
• Default Access Controller implementation
• Working in applications with installed security manager

8 Network Filters

• Compression Filters
• Encryption Filters
  • Symmetric Encryption Filter
  • Symmetric Encryption Filter Parameters
  • PKCS Encryption Filter
  • PKCS Encryption Filter Parameters
• Configuring Filters
• Creating a Custom Filter

9 Priority Tasks

• Priority Tasks — Timeouts
  • Configuring Execution Timeouts
  • Execution Timeout Parameters
  • Command Line Options
• Priority Task Execution — Custom Objects
  • APIs for Creating Priority Task Objects
  • Errors Thrown by Task Timeouts

10 Specifying a Custom Eviction Policy

11 Serialization Paged Cache

• Understanding Serialization Paged Cache
• Configuring Serialization Paged Cache
• Optimizing a Partitioned Cache Service
• Configuring for High Availability
• Configuring Load Balancing and Failover
• Supporting Huge Caches

12 Pre-Loading the Cache

• Performing Bulk Loading and Processing
  • Bulk Writing to a Cache
  • Efficient processing of filter results
  • A Bulk Loading and Processing Example
• Performing Distributed Bulk Loading
  • A Distributed Bulk Loading Example
  • Running a Distributed Bulk Loading Example
    • Building the Sample Application
    • Running the Sample Application

13 Constraints on Re-entrant Calls

• Re-entrancy, Services, and Service Threads
  • Parent-Child Object Relationships
  • Avoiding Deadlock
• Re-entrancy and Listeners

Part II Testing and Tuning

14 Evaluating Performance and Scalability

• Measuring Latency and Throughput
• Demonstrating Scalability
• Tuning Your Environment
• Measurements on a Large Cluster

15 Performing a Multicast Connectivity Test

• Running the Multicast Test Utility
  • Sample Commands
• Multicast Test Example
• Troubleshooting Multicast Communications

16 Performing a Datagram Test for Network Performance

• Running the Datagram Test Utility
  • Sample Commands for a Listener and a Publisher
• Datagram Test Example
• Reporting
  • Publisher Statistics
  • Listener Statistics
    • Throttling
    • Bidirectional Testing
    • Distributed Testing

17 Configuring and Using Coherence*Extend

• General Instructions
• Configuring and Using Coherence*Extend-TCP
  • Client-side Cache Configuration Descriptor
  • Cluster-side Cache (a.k.a Coherence Extend Proxy) Configuration Descriptor
  • Launching an Extend-TCP DefaultCacheServer Process
  • Launching an Extend-TCP Client Application
• Sample Coherence*Extend Client Application
  • Coherence*Extend InvocationService
• Advanced Configuration
  • Network Filters
  • Connection Error Detection and Failover
  • Read-only NamedCache Access
  • Client-side NamedCache Locking
  • Disabling Proxied Services

18 High Resolution Timesource (Linux)

19 Performance Tuning

• Operating System Tuning
  • Socket Buffer Sizes
  • High Resolution timesource (Linux)
  • Datagram size (Microsoft Windows)
  • Thread Scheduling (Microsoft Windows)
  • Swapping
• Network Tuning
  • Network Interface Settings
  • Bus Considerations
  • Network Infrastructure Settings
  • Ethernet Flow-Control
  • Path MTU
• JVM Tuning
  • Server Mode
  • Sizing the Heap
  • GC Monitoring & Tuning
• Coherence Network Tuning
  • Validation

20 Setting Single Server Mode

• Setting Single Server Mode in the Operation Configuration Descriptor
• Setting Single Server Mode on the Command Line

Part III Managing and Monitoring Oracle Coherence

21 How to Manage Coherence Using JMX

• Add JMX libraries to the Coherence classpath
• Configure the Coherence Management Framework
• Access Coherence MBeans
• Using Coherence MBeanConnector to Access MBeans
• Configuring Management Refresh Methodology

22 JMX Reporter

• Basic Configuration
• Administration
• Data Analysis
• Advanced Configuration
  • Creating Custom Reports
  • Running Reporter in a Distributed Configuration

23 How to Create a Custom Report

• Configuring a Report File
  • file-name Element
    • file-name Macros
    • file-name Macro Examples
• Specifying Data Columns
  • How to Include an Attribute
  • How to Include Part of the Key
  • How to Include Information from Composite Attributes
  • How to Include Information from Multiple MBeans
  • Including Multiple MBean Information Example
  • How to Use Report Macros
  • How to Include Constant Values
• Including Queries in a Report
• Using Filters to Construct Reports
• Using Functions to Construct a Report
  • Function Examples
• Using Aggregates to Construct a Report
  • Aggregate Examples
• Constructing Delta Functions
  • Delta Function Examples

24 How to Modify Report Batch

• Report Batch Deployment Descriptor
  • Document Location
  • Document Root
  • System Properties
  • Document Format
• Report Batch Element Index
  • frequency
  • location
  • init-param
  • init-params
  • output-directory
  • param-name
  • param-type
  • param-value
  • report-config
  • report-group
  • report-list

25 Analyzing Reporter Content

• Network Health
• Network Health Detail
• Memory Status
• Cache Size
• Service Report
• Node List
• Proxy Report

26 How to Run a Report on Demand

• How to Run ReportControl MBean at Node Startup
• How to Configure the ReportControl MBean

27 Configuring Custom MBeans

• Creating an MBean XML Configuration File
  • Configuring Standard MBeans
  • Configuring MXBeans
  • Configuring JMX MBeans
• Enabling a Custom MBean Configuration File
  • Setting a System Property
  • Adding a Custom MBean Configuration File to the Class Path

28 How to Manage Custom MBeans Within the Cluster

• Custom MBean Configuration
  • How to Add a Standard MBean to Coherence
  • How to Programatically Add a Standard MBean to Coherence
  • How to Add a the Results of a JMX Query to Coherence

A Production Checklist

• Network
• Hardware
• Operating System
• JVM
• Java Security Manager
• Application Instrumentation
• Coherence Editions and Modes
  • Ensuring that RTC nodes don't use Coherence TCMP
• Coherence Operational Configuration
• Coherence Cache Configuration
• Large Cluster Configuration
• Death Detection
• tangosol-license.xml Deprecated

B Types of Caches in Coherence

• Distributed Cache
• Replicated Cache
• Optimistic Cache
• Near Cache
• Local Cache
• Remote Cache
• Summary of Cache Types

C Cache Semantics

D Cache Configuration Elements

• Cache Configuration Deployment Descriptor
  • Document Location
  • Document Root
  • Document Format
  • Command Line Override
  • Examples
• Element Index
  • acceptor-config
  • address-provider
  • async-store-manager
  • backing-map-scheme
  • backup-storage
  • bdb-store-manager
  • bundle-config
  • cache-config
  • cache-mapping
  • cache-service-proxy
  • cachestore-scheme
  • caching-scheme-mapping
  • caching-schemes
  • class-scheme
  • custom-store-manager
  • disk-scheme
  • distributed-scheme
  • external-scheme
  • initiator-config
  • init-param
  • init-params
  • invocation-scheme
  • invocation-service-proxy
  • jms-acceptor
  • jms-initiator
  • key-associator
  • key-partitioning
  • lh-file-manager
  • listener
  • local-scheme
  • near-scheme
  • nio-file-manager
  • nio-memory-manager
  • operation-bundling
  • optimistic-scheme
  • outgoing-message-handler
  • overflow-scheme
  • paged-external-scheme
  • partition-listener
  • partitioned
  • proxy-config
  • proxy-scheme
  • read-write-backing-map-scheme
  • remote-cache-scheme
  • remote-invocation-scheme
  • replicated-scheme
  • tcp-acceptor
  • tcp-initiator
  • version-persistent-scheme
  • version-transient-scheme
  • versioned-backing-map-scheme
  • versioned-near-scheme

E Cache Configuration Parameter Macros

F Sample Cache Configurations

• Local Caches (accessible from a single JVM)
  • In-memory Cache
  • NIO In-memory Cache
  • Size Limited In-memory Cache
  • In-memory Cache with Expiring Entries
  • Cache on Disk
  • Size Limited Cache on Disk
  • Persistent Cache on Disk
  • In-memory Cache with Disk Based Overflow
  • Cache of a Database
• Clustered Caches (accessible from multiple JVMs)
  • Replicated Cache
  • Replicated Cache with Overflow
  • Partitioned Cache
  • Partitioned Cache with Overflow
  • Partitioned Cache of a Database
  • Partitioned Cache with a Serializer
  • Local Cache of a Partitioned Cache (Near cache)

G Sample CacheStores

• Sample CacheStore
• Sample Controllable CacheStore

H Operational Configuration Elements

• Operational Configuration Deployment Descriptors
  • Document Location
  • Document Root
  • Document Format
  • Operational Override File (tangosol-coherence-override.xml)
  • Command Line Override
• Element Index
  • access-controller
  • address-provider
  • authorized-hosts
  • burst-mode
  • callback-handler
  • class-name
  • cluster-config
  • coherence
  • configurable-cache-factory-config
  • filters
  • flow-control
  • host-range
  • incoming-message-handler
  • init-param
  • init-params
  • license-config
  • logging-config
  • management-config
  • member-identity
  • multicast-listener
  • notification-queueing
  • outgoing-message-handler
  • outstanding-packets
  • packet-buffer
  • packet-bundling
  • packet-pool
  • packet-delivery
  • packet-publisher
  • packet-size
  • packet-speaker
  • pause-detection
  • security-config
  • service-guardian
  • services
  • shutdown-listener
  • socket-address
  • tcp-ring-listener
  • traffic-jam
  • unicast-listener
  • volume-threshold
  • well-known-addresses
• Element Attributes

I Initialization Parameter Settings

• DistributedCache Service Parameters
• ReplicatedCache Service Parameters
• InvocationService Parameters
• ProxyService Parameters
• Compression Filter Parameters

J POF User Type Configuration Elements

• POF User Type Deployment Descriptor
  • Document Location
  • Document Root
  • Document Format
  • Command Line Override
• Element Index
  • allow-interfaces
  • allow-subclasses
  • class-name
  • include
  • init-param
  • init-params
  • param-type
  • param-value
  • pof-config
  • serializer
  • type-id
  • user-type
  • user-type-list

K MBean Configuration Elements

• MBeans in the Coherence Deployment Descriptor
  • Document Root
  • Document Format
• MBean Configuration Element Index
  • extend-lifecycle
  • enabled
  • mbean
  • mbean-accessor
  • mbean-class
  • mbean-factory
  • mbean-name
  • mbean-query
  • mbeans

L Command Line Overrides

• Override Example
• Preconfigured Override Values

M Platform-Specific Deployment Considerations

• Deploying to AIX
  • Socket Buffers sizes and JVMs
  • Multicast and IPv6
  • Unique Multicast Addresses and Ports
• Deploying to Oracle JRockit JVMs
  • JRockit and the Native Posix Thread Library (NPTL)
  • AtomicLong
  • OutOfMemoryError
• Deploying to Cisco Switches
  • Buffer Space and Packet Pauses
  • Multicast Connectivity on Large Networks
  • Multicast Outages
• Deploying to Foundry Switches
  • Multicast Connectivity
• Deploying to IBM BladeCenters
  • MAC Address Uniformity and Load Balancing
• Deploying to IBM JVMs
  • UDP Socket Buffer Sizes
  • OutOfMemoryError
  • Heap Sizing
• Deploying to Linux
  • Native POSIX Thread Library (NPTL)
  • TSC High Resolution Timesource
• Deploying to OS X
  • Multicast and IPv6
  • Unique Multicast Addresses and Ports
  • Socket Buffer Sizing
• Deploying to Solaris
  • Solaris 10 (x86 and SPARC)
  • Solaris 10 Networking
• Deploying to Sun JVMs
  • Heap Sizes
  • AtomicLong
  • OutOfMemoryError
• Deploying to Virtual Machines
  • Supported Deployment
  • Multicast Connectivity
  • Performance
  • Fault Tolerance
• Deploying to Windows
  • Performance Tuning
  • Personal Firewalls
• Deploying to z OS
  • EBCDIC
  • Multicast

N Best Practices for Coherence Extend

• Run Proxy Servers with Local Storage Disabled
• Do Not Run a Near Cache on a Proxy Server
• Configure Heap NIO Space to be Equal to the Max Heap Size
• Set Worker Thread Pool Sizes According to the Needs of the Application
• Be Careful When Making InvocationService Calls
• Be Careful When Placing Collection Classes in the Cache
• Run Multiple Proxies Instead of Increasing Thread Pool Size
• Configure POF Serializers for Cache Servers
• Use Node Locking Instead of Thread Locking

O Scaling Out Your Data Grid Aggregations Linearly

• The Data
• Configure a Partitioned Cache
• Add an Index to the Price Property
• Code to perform a Parallel Aggregation
• The Testing Environment and Process
  • Performing a "Test Run"
  • This "Test Suite" (and Subsequent Results) Includes Data from Four "Test Runs":
  • JDK Version
• The Results
• Conclusion

P The PIF-POF Binary Format

• Stream Format
  • Integer Values
  • Type Identifiers
• Binary Formats for Predefined Types
  • Int
    • Coercion of Integer Types
  • Decimal
  • Floating Point
  • Boolean
  • Octet
  • Octet String
  • Char
  • Char String
  • Date
  • Year-Month Interval
  • Time
  • Time Interval
  • Date-Time
    • Coercion of Date and Time Types
  • Day-Time Interval
  • Collections
  • Arrays
  • Sparse Arrays
  • Key-Value Maps (Dictionaries)
  • Identity
  • Reference
• Binary Format for User Types
  • Versioning of User Types

Q Log Message Glossary

• TCMP Log Messages
• Configuration Log Messages
• Partitioned Cache Service Log Messages