Scripting Examples

Tcat Server reached its End of Life in 2017. Contact your Customer Success Manager to determine options for managing, monitoring, or deploying your application.

This page provides examples of using scripts.

Executing Custom Shell Scripts Before and After Deployment

This script registers itself as a listener for pre and post deployment events. The callback methods are used to call custom shell scripts. Replace your own shell scripts with the ones listed in this example.

Pre and Post Deployment Events

package com.mulesoft.tcat
import org.mule.galaxy.event.annotation.Async
import org.mule.galaxy.event.annotation.BindToEvents
import org.mule.galaxy.event.annotation.OnEvent
import org.mule.galaxy.event.EventManager;
import org.springframework.context.ApplicationContext;
public class ScriptExecutor {
    def ApplicationContext applicationContext;
    def EventManager eventManager;

    public ScriptExecutor(ApplicationContext applicationContext) {
        this.applicationContext = applicationContext;

    public void install() {
        eventManager = applicationContext.getBean("eventManager");
        // Remove the previous listener, if any
        eventManager.listeners.each {
            if (it.class.simpleName == "ScriptExecutor") {
                println "Removed previous listener"
        // Add the event listener again

    void onEvent(com.mulesoft.tcat.PreServerDeploymentEvent e) {
        println "/Users/karanmalhi/tmp/".execute().text;
    void onEvent(com.mulesoft.tcat.PostServerDeploymentEvent e) {
         println "/Users/karanmalhi/tmp/".execute().text;
new ScriptExecutor(applicationContext).install();

Redeploying a Named Package

This simple script grabs a package with a particular name and redeploys it using the provisioning service.

def provisioningService = applicationContext.getBean("provisioningService")
def deployment = provisioningService.getDeploymentByName("MyPackage")

Automatically Redeploying After an Artifact Update

If you’re using the Maven plug-in or the API to update a WAR, you may want to listen for the update and automatically redeploy any packages associated with it. The following script installs an event listener, which listens for updates to an item’s artifact property, which changes when the WAR file data has been changed. When this event occurs, the script searches for any deployment packages with this particular artifact and redeploys them.

import com.mulesoft.tcat.DeploymentService;
import com.mulesoft.tcat.DeploymentAction.Action;
import org.mule.galaxy.Item;
import org.mule.galaxy.Registry;
import org.mule.galaxy.event.EventManager;
import org.mule.galaxy.event.PropertyChangedEvent;
import org.mule.galaxy.event.annotation.Async;
import org.mule.galaxy.event.annotation.BindToEvent;
import org.mule.galaxy.event.annotation.OnEvent;

import org.springframework.context.ApplicationContext;

public class AutomaticRedeployer {
    def Registry registry;
    def DeploymentService deploymentService;
    def EventManager eventManager;
    def ApplicationContext applicationContext;

    public AutomaticRedeployer(ApplicationContext applicationContext) {
        this.applicationContext = applicationContext;

    public void install() {
        registry = applicationContext.getBean("registry");
        eventManager = applicationContext.getBean("eventManager");
        deploymentService = applicationContext.getBean("deploymentService");

        // remove the previous listener, if any
        eventManager.listeners.each {
            if (it.class.simpleName == "AutomaticRedeployer") {
                println "Removed previous listener"
        // add the event listener again

    void onEvent(PropertyChangedEvent e) {
        if ("artifact" != e.propertyName)

        println "Artifact for ${e.itemPath} has been updated. Looking for deployments..."


     * Redeploy any packages which have the specified artifact version.
    void doRedeploy(String artifactVersionPath) {
        def query = "select where = 'Deployment Version' and package.latest = 'true' and deployment.artifacts = '${artifactVersionPath}'"

        println "Query: ${query}"

        def results =, 0, -1)

        for (Item deployVersion : results.results) {
            println "Redeploying ${}"


new AutomaticRedeployer(applicationContext).install()

Sending Notifications of New Artifact Versions

This script watches for new artifact versions and sends an email to any user who is registered in the "contacts" property.

import org.mule.galaxy.event.*;
import org.mule.galaxy.event.annotation.*;

import org.mule.galaxy.Registry
import org.mule.galaxy.Item

import javax.mail.*;
import javax.mail.internet.*;

import java.util.Properties;

// An event listener which fires emails when new entry versions are created
public class EmailNotifier {

    def String userProperty = "contacts"
    def String server = ''
    def String port = '465'
    def String username = 'XXXX'
    def String password = 'XXXX'
    def Registry registry

    void onEvent(EntryVersionCreatedEvent e) {

    void notifyUsers(ItemEvent e) {
        Properties props = new Properties();

        props.setProperty("", server);
        props.setProperty("mail.user", username);
        props.setProperty("mail.smtp.port", port);
        props.setProperty("mail.password", password);
        props.setProperty("mail.smtp.auth", "true");

        Item item = registry.getItemById(e.itemId);

        def mailSession = Session.getDefaultInstance(props, null);
        Transport transport = mailSession.getTransport("smtps");

        MimeMessage message = new MimeMessage(mailSession);
        message.setSubject("Artifact/entry ${} was created");
        message.setContent("Artifact/entry was created in ${item.path}", "text/plain");

        def contacts = item.getProperty(userProperty);
        contacts?.each {
                 new InternetAddress(;

        if (!contacts) { return };

        transport.sendMessage(message, message.getAllRecipients());

// Remove the previous listener, if any
eventManager.listeners.each {
    if (it.class.simpleName == "EmailNotifier") {
        println("Removed listener");

// Add the event listener again
eventManager.addListener(new EmailNotifier(registry: registry));

Replicating Workspaces

You can replicate workspaces from one Tcat Server instance to another. Replications are performed via custom scripts. This allows you to easily customize the replication process and schedule it via the Scheduler.

Replication occurs by copying artifacts and entries from one workspace to another. If you’re replicating to a remote Tcat Server instance, you must first attach it as a remote workspace.

Once you have both your origin and destination workspace in mind, you can create a script that performs this replication. Following is an example script:

// Create a replicator called "myReplicator"
def replicator = new Replicator(registry, activityManager, "myReplicator");

// Copy from the first workspace, to the second one.
replicator.copy("/LocalWorkspace", "/RemoteWorkspace");

This script copies all artifacts and entries from LocalWorkspace to RemoteWorkspace. Note that it is beneficial to give your replicators an ID, in this case myReplicator. This makes it easy to view the actions of the replicator in the activity log.

Restarting Servers

If you need to restart a server, you can easily do it through the administration console. However, what if you want to schedule a automatic restart at a particular day/time? You can achieve this by writing a script and scheduling it with the Tcat scheduler. Following is an example script:

def serverName= "Tcat-8081"; // Replace this with your server name
def serverManager = applicationContext.getBean("serverManager");
def server = serverManager.getServerByName(serverName,false);
def serverId = server.getId();

The following script restarts all servers, except the Tcat Admin Console Server:

// Get the server manager
def sm = applicationContext.getBean("serverManager");
// Get all servers from all groups
def results = sm.getServersForGroup(null,0,-1,null);
def allServers =  results.getData();
// Server IDs array
def serverIds = [];
// Loop through all servers and extract their IDs except for the console
for(server in allServers){
// Replace the agentUrl with the URL for your console agent
 def agentUrl = "https://localhost:51443/agent";
// Skip the console server, we do not want to restart it, so do not need its ID
// For the remaining servers, extract the ID and add it to the list
// Restart all servers
// Return the ID of the restarted servers
return serverIds;

After you save this script, it is easy to schedule this script to be run periodically via the scheduler.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub