About Terracotta Documentation
This documentation is about Terracotta DSO, an advanced distributed-computing technology aimed at meeting special clustering requirements.
Terracotta products without the overhead and complexity of DSO meet the needs of almost all use cases and clustering requirements. To learn how to migrate from Terracotta DSO to standard Terracotta products, see Migrating From Terracotta DSO. To find documentation on non-DSO (standard) Terracotta products, see Terracotta Documentation. Terracotta release information, such as release notes and platform compatibility, is found in Product Information.
- How DSO Clustering Works
- Platform Concepts
- Hello Clustered World
- Setup and Configuration
- Planning for a Clustered App
- Configuring Terracotta DSO
- Configuration Reference
- Using Annotations
- Cluster Events
- Data Locality Methods
- Distributed Cache
- Clustered Async Data Processing
- Tool Guides
- Developer Console
- Operations Center
- tim-get (TIM Management Tool)
- Platform Statistics Recorder
- Eclipse Plugin
- Sessions Configurator
- Clustering Spring Webapp with Sessions Configurator
- Testing, Tuning, and Deployment
- Top 5 Tuning Tips
- Testing a Clustered App
- Tuning a Clustered App
- Deployment Guide
- Operations Guide
- FAQs and Troubleshooting
- General FAQ
- DSO Technical FAQ
- Troubleshooting Guide
- Non-portable Classes
- Migrating From DSO
- Concept and Architecture Guide
- Examinator Reference Application
- Clustered Data Structures Guide
- Integrating Terracotta DSO
- Clustering Spring Framework
- Integration Modules Manual
- AspectWerkz Pattern Language
Publish Date: November, 2011
tim-get is a Terracotta integration module (TIM) management tool that simplifies interaction with the catalog of integration modules available for Terracotta DSO. Utilizing a speedy command-line tool, tim-get offers control over a number of complex tasks, including sorting out dependencies, matching release versions, and setting correct configuration and installation options.
Using tim-get, you can quickly and easily do the following:
- See the most current TIMs available for your version of Terracotta DSO.
- Get in-depth information on a specific TIM.
- Install new TIMs directly from the the Terracotta Forge.
- Update your installed TIMs to the latest version.
- Print a current inventory of available TIMs.
- View the status of each TIM.
- Review potential conflicts using a "dry-run" install.
By using tim-get, you can ensure that the TIMs you install are the ones most suitable for your version of Terracotta.
TIMs are installed on Terracotta clients, which run on your application servers. TIMs should not be installed on Terracotta server instances. Applications and application containers are never integrated with Terracotta server instances, only with Terracotta clients.
To access tim-get, execute the tim-get script. tim-get is a Terracotta tool located in the <Terracotta_Home>/bin directory.
On UNIX/Linux, execute the following:
On Windows, execute the following:
While the examples in this document use
tim-get.sh, they are also valid for
The Terracotta Configuration File
The following table serves as a quick-reference to the commands available to tim-get tim-get script. For a fuller discussion of commands, arguments, and options, click a command name or see the following sections.
Display general help or command-specific help
Display a list of installed or available TIMs
Display information about a specific TIM
Install a TIM
Install the latest TIMs specified in the Terracotta configuration file
Path to Terracotta configuration file
Update a TIM to the latest version
Update and install the TIMs specified in a Terracotta configuration file to the latest versions
Path to the Terracotta configuration file
You can display usage help for the tim-get script as well for each command. To display help on using the tim-get script, run the script without any commands.
To display help on a specific command, run the script with the command and the
Getting Information on TIMs
info commands display information on the TIMs available for, or installed with, your version of Terracotta DSO. The
list command can also be used to search for specific TIMs.
The list Command
list command displays a table of installed and available TIMs. For example:
Each entry in the table has the following components:
- TIM installation status:
- + (plus) – an up-to-date version is installed
- ! (exclamation mark) – an out-of-date version is installed
- - (minus) – a version is available but hasn't been installed
- TIM name, which can include a product name and version
- TIM version, in parentheses
- group-ID value, in square brackets
For example, the entry
-tim-jetty-6.1 (1.2.0-SNAPSHOT) [org.mortbay.jetty] means that a TIM for Jetty 6.1 is available for the local Terracotta installation, but is not installed. The TIM version is
1.2.0-SNAPSHOT, and the group-ID is
org.mortbay.jetty. If the group-ID value is not displayed, then it equals the default value
org.terracotta.modules. The Jetty TIM is installed in
while a TIM with the default group-ID is installed in
The data used to build the TIM table is periodically refreshed. However, if a connection to the Terracotta Forge is unavailable, the table is created using data from the last refresh.
Only installed non-internal TIMs found in the Terracotta
modules directory are displayed in the TIM table. The following types of installed TIMs do not appear in the TIM table:
- "Internal" TIMs required by Terracotta. To see these, use the
listcommand with the -a or --all option.
- TIMs installed in repositories outside the Terracotta
To return a more focused TIM table, specify keywords with the
list command. For example, to find TIMs with the word "synchronized" in their names:
When using keywords with the
- Matches occur only on continuous strings in TIM names.
- Using a leading hyphen ("-") in a keyword returns an error or executes an option.
The info Command
info command displays a detailed report about a specified TIM. For example, to generate a detailed report about the TIM for Terracotta DSO annotations:
The report is organized into a number of sections, including the following:
- Dependencies: Shows which other TIMs are required, and which of those are installed or out of date.
- Maven Coordinates: Gives values for attributes needed if using Apache Maven for project management.
- Configuration: Displays the configuration snippet that must be added to the Terracotta configuration file for the TIM to be loaded. The TIM is loaded by Terracotta if it is started with a configuration file that includes this snippet.
To display detailed information on all available TIMs with one command, enter:
The detailed information in the report also includes version compatibility data on:
- The technology being integrated
- Terracotta DSO
- The TIM being reported on
In the example above, the report gave the following information about the TIM for Hibernate 3.1.2:
- It has modules to integrate Hibernate 3.1.2 and Hibernate 3.2.5
- It is compatible with Terracott DSO version 2.7.0-SNAPSHOT
- No other versions of the TIM for Hibernate 3.1.2 are available
The two ways of installing TIMs are:
- Using the
installcommand – Installs specified individual TIMs, but can also install all available TIMs.
- Using the
install-forcommand – Installs all TIMs configured in a specified Terracotta configuration file.
The install Command
install command to install TIMs to the Terracotta modules directory. To install a specific TIM, pass the TIM name as an argument to the
install command. For example, to install the tim-hibernate-3.2.5 TIM, enter:
If the TIM already exists in the default installation location (see TIM Installation Path), tim-get skips the installation. Use the --overwrite option to overwrite the existing TIM with the version you are downloading:
To download all of the TIMs available for your version of Terracotta, use the --all option:
Downloaded files are verified using a checksum algorithm. To avoid the checksum verification, use the
Installing Configured TIMs
install-for command installs the TIMs configured in the specified Terracotta configuration file, based on the latest index of TIMs cached in your installation of Terracotta.
To download the latest index of TIMs before installing the configured TIMs, use the
-u option (
For example, if you are clustering an application using Spring Security, you must add the following TIM to your Terracotta configuration file:
To install the Spring Security TIM, simply enter the following command:
install-for does not require the TIM version number to be specified in the Terracotta configuration file.
TIM Installation Path
A TIM is installed following the path matching its Maven coordinates (groupID, artifactID, and version values). For example, the tim-ehcache-1.2.4 TIM has the following Maven coordinates:
If you install the tim-ehcache-1.2.4 TIM with tim-get, it is installed in:
Testing with --dry-run
Certain TIMs are installed with a number of dependencies. You can run a test install using the --dry-run option to see how the installation would proceed:
Using install with
--dry-run generates the same messages to standard output as a real installation, but with no affect on installed files.
You can update existing TIMs with the latest versions for your Terracotta installation without having to learn the version numbers.
You can update in the following ways:
- Update specific TIMs
- Update all configured TIMs
Update Specific TIMs
update command to install updates to specific previously installed TIMs. This command saves you the step of having to
manually discover outdated TIMs using the
update has the same options as
install, and the additional option
--force to overwrite TIMs even if
tim-get reports that no updates were found. For example, if you're updating tim-lucene-2.0.0, and the latest version is already
installed, tim-get will reply with
No updates found. To override this, enter:
--force also updates dependencies even if the latest versions are already installed.
Upgrade Configured TIMs
upgrade command to update the TIMs configured in the Terracotta configuration file (
tc-config.xml by default).
upgrade also automatically updates the version numbers in the Terracotta configuration file. This command allows you to keep your TIMs and configuration file current in one step.
upgrade has the same options as
update except for
To update a the configrured TIMs in a Terracotta installation, enter:
Before being edited, the existing Terracotta configuration file is saved with the extension
Troubleshooting Connection Problems
Often connection problems are caused by local firewalls and typically appear as "connection timed out" errors when you attempt tim-get operations. For connection problems resulting from a local firewall, configure tim-get to always use a specified proxy by adding the following property to the file
For example, if your company's proxy server is
myCompany.com:6666, add the following to
tim-get.properties file does not support authorization. If your proxy requires authorization, see these alternatives.
Alternatives for Accessing Projects
If connection problems persist or cannot be solved by using a proxy, try the following:
- If using Maven, access Terracotta projects through the Terracotta Maven repository.
- Use SVN to download the target projects. The root SVN URL is
- If your proxy requires authentication, try a work-around such as using proxy software which allows you to specify authentication. For example, on Microsoft networks based on the NTLM protocol, you may be able to use the NTML Authorisation Proxy Server.