org.lsst.ccs.scripting

Class CCS

java.lang.Object

org.lsst.ccs.scripting.CCS

public abstract class CCS
extends Object

Main scripting entry point to CCS. This class is used to create scripting entry points to CCS subsystems through ScriptingSubsystemWrapper, register a ScriptingStatusBusListener to listen to Status messages on the CCS Status Bus and to suspend the script execution until a given Status message meets the criteria of a filter: ScriptingStatusBusMessageFilter.

Author:

The LSST CCS Team

Method Summary

Modifier and Type	Method and Description
static void	addStatusBusListener(ScriptingStatusBusListener listener) Add a Status bus listener.
static void	addStatusBusListener(ScriptingStatusBusListener listener, ScriptingStatusBusMessageFilter filter) Add a Status bus listener with a filter.
static ScriptingSubsystemWrapper	attachSubsystem(String subsystemName) Creates and instance of a ScriptingSubsystemWrapper by making sure that the given subsystemName corresponds to a CCS subsystem that is currently available, not locked and alive.
static void	cleanUp() Clean up the ThreadLocal stack, (close all subsystems and remove all listeners).
static AgentMessagingLayer	getMessagingAccess()
protected static List<String>	getTargetsForSubsystem(String subsystemName)
static boolean	getThrowExceptions() Returns true if exceptions are thrown, otherwise they are returned as the Object on the invoke methods.
static void	initializeScriptingEnvironment() In a test context, this method has to be called in the first place
static void	removeStatusBusListener(ScriptingStatusBusListener listener) Removes the Status bus listener.
static void	setThrowExceptions(boolean throwExceptions) In the scripting environment, exceptions resulted from method invocation can either be thrown or returned.
static void	shutdownScriptingEnvironment() In a test context, this method has to be called in the first place
static Future<ScriptingStatusBusMessage>	startListeningForStatusBusMessage(ScriptingStatusBusMessageFilter filter, int timeout) Get a Future on a ScriptingStatusBusMessage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getMessagingAccess

public static AgentMessagingLayer getMessagingAccess()

initializeScriptingEnvironment

public static void initializeScriptingEnvironment()

In a test context, this method has to be called in the first place

shutdownScriptingEnvironment

public static void shutdownScriptingEnvironment()
                                         throws Exception

In a test context, this method has to be called in the first place

Throws:

Exception

setThrowExceptions

public static void setThrowExceptions(boolean throwExceptions)

In the scripting environment, exceptions resulted from method invocation can either be thrown or returned. Use this method to toggle between the two options.

Parameters:

throwExceptions - boolean flag. If true exceptions will be thrown.

getThrowExceptions

public static boolean getThrowExceptions()

Returns true if exceptions are thrown, otherwise they are returned as the Object on the invoke methods.

Returns:

true/false to indicate if exceptions are thrown/returned

attachSubsystem

public static ScriptingSubsystemWrapper attachSubsystem(String subsystemName)
                                                 throws RuntimeException

Creates and instance of a ScriptingSubsystemWrapper by making sure that the given subsystemName corresponds to a CCS subsystem that is currently available, not locked and alive. The process of creating the ScriptingSubsystemWrapper involves acquiring a lock on the subsystem. Should we be able to specify the lock level?

Parameters:

subsystemName - The name of the CCS subsystem. e.g. ccs-rafts.

Returns:

The ScriptingSubsystemWrapper representing the CCS subsystem

Throws:

RuntimeException

cleanUp

public static void cleanUp()

Clean up the ThreadLocal stack, (close all subsystems and remove all listeners).

addStatusBusListener

public static void addStatusBusListener(ScriptingStatusBusListener listener)

Add a Status bus listener.

Parameters:

listener - The ScriptingStatusListener

addStatusBusListener

public static void addStatusBusListener(ScriptingStatusBusListener listener,
                                        ScriptingStatusBusMessageFilter filter)

Add a Status bus listener with a filter.

Parameters:

listener - The ScriptingStatusListener

filter - The ScriptingStatusBusMessageFilter

removeStatusBusListener

public static void removeStatusBusListener(ScriptingStatusBusListener listener)

Removes the Status bus listener.

Parameters:

listener - The listener to be removed.

startListeningForStatusBusMessage

public static Future<ScriptingStatusBusMessage> startListeningForStatusBusMessage(ScriptingStatusBusMessageFilter filter,
                                                                                  int timeout)

Get a Future on a ScriptingStatusBusMessage. The content of the Future is filled when the first StatusBusMessage that satisfies the ScriptingStatusBusMessageFilter is received. When the Future is exercised it will return the first ScriptingStatusBusMessage or an ExecutionException will be thrown when the timeout is reached.

Parameters:

filter - ScriptingStatusBusMessageFilter The message filter

timeout - Timeout in seconds, after which a ScriptiongTimeoutException is thrown. This timeout is from the time the method is invoked. If this timeout is reached an exception will be thrown if/when the Future is exercised.

Returns:

A Future on a ScriptingStatusBusMessage.

getTargetsForSubsystem

protected static List<String> getTargetsForSubsystem(String subsystemName)