Call us: +1-415-738-4000

Terracotta Documentation

for versions 3.7.0 through 3.7.3

Terracotta documentation focuses on the use of Terracotta products in a Terracotta cluster. Documentation covers the following products and core components:

  • Enterprise Ehcache – Standards-based Java cache. Separate chapters cover Enterprise Ehcache and Enterprise Ehcache for Hibernate.
  • BigMemory – Massive boost for data in server memory without Java GC constraints. This product is covered in the Terracotta Server Array chapter. Documentation on BigMemory for Ehcache is covered by Ehcache documentation.
  • Quartz Scheduler – Scalable Java job scheduler. Chapter covers how to install and use the TerracottaJobStore for Quartz Scheduler.
  • Web Sessions – Solution for clustering web sessions.
  • Terracotta Server Array – The Terracotta platform forming the backbone of Terracotta clusters.

For a general list of practices that prevent or solve the most common issues in a Terracotta cluster, see Best Practices.

Product Information

Terracotta products are Enterprise Edition (ee) versions of Terracotta software, also known as commercial versions. Users of the Terracotta Enterprise Suite have access to all of the listed products, including all of the features available with those products. Users of open-source versions of Terracotta software can also use this documentation, but have access to a limited number of products and features.

The Release Information page lists current and previous releases, has links to release notes and platform compatibility tables, and more.

See the Compatibility Matrix for information on version matching Terracotta products.

Information on the Terracotta license is available here.


Using Documentation

Documentation is aimed at helping you quickly get a clustered application up and running. Start by choosing the installation section in the chapter for your Terracotta product. Following installation, or if you experience trouble, see the reference sections that follow the installation section.

note: standard and dso installations
The installation procedures given in the chapters on Terracotta products are the recommended standard installations. If you require object identity, must share non-serializable objects, or have other requirements that can only be met by using a cluster based on Terracotta Distributed Shared Objects (DSO), see the chapter on installing with DSO. DSO uses object identity, instrumented classes (byte-code instrumentation), object-graph roots, and cluster-wide locks to maintain data coherence.

The threshold for successfully setting up a DSO cluster can be substantially higher than for a non-DSO cluster due to DSO’s stricter code and configuration requirements. It is recommended that if possible you use the standard installation (also called express installation) to set up a non-DSO cluster. Use the DSO installation only if your deployment requires the features of DSO.

You cannot combine a standard installation with a DSO installation.

To learn more about cluster configuration options, production architectures, security, High Availability, and performance optimization, see the chapter on Terracotta Server Arrays.

To learn more about using the tools available through the Terracotta API in your application, see the chapter on the Terracotta Toolkit. This chapter is appropriate for developers who want to integrate Terracotta functionality directly.

A number of useful Terracotta tools are available with the kit, including the Developer Console. See the chapter on tools for more information on Terracotta tools.