org.safs.staf.embedded

Class EmbeddedHandles

java.lang.Object

org.safs.staf.embedded.EmbeddedHandles

public class EmbeddedHandles
extends java.lang.Object

Handles the storage, registration, and un-registration of Handles and Services.

Author:

Carl Nagle

Method Summary

Modifier and Type	Method and Description
static boolean	cleanQueues()
static EmbeddedHandle	getHandle(java.lang.String handleId)
static EmbeddedServiceHandle	getService(java.lang.String serviceId)
static boolean	isServiceRunning(java.lang.String serviceId)
static boolean	isToolRunning(java.lang.String handleId)
static void	registerHandle(java.lang.String handleId, EmbeddedHandle ihandle)
static void	registerService(java.lang.String handleId, java.lang.String serviceId, EmbeddedServiceHandle ihandle)
static void	unRegister(java.lang.String handleId) Unregister (remove) the registered Handle.

Methods inherited from class java.lang.Object

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

Method Detail

registerHandle

public static void registerHandle(java.lang.String handleId,
                                  EmbeddedHandle ihandle)
                           throws java.lang.IllegalArgumentException,
                                  SAFSException

Parameters:

handleId - -- unique name for registering the Handle

ihandle - -- unique Handle object to be registered.

Throws:

java.lang.IllegalArgumentException - - if null parameters are provided

SAFSException - -- if the handle is already registered.

registerService

public static void registerService(java.lang.String handleId,
                                   java.lang.String serviceId,
                                   EmbeddedServiceHandle ihandle)
                            throws java.lang.IllegalArgumentException,
                                   SAFSException

Parameters:

handleId - -- unique name for registering the Handle

ihandle - -- unique Handle object to be registered.

Throws:

java.lang.IllegalArgumentException - - if null parameters are provided

SAFSException - -- if the handle is already registered.

unRegister

public static void unRegister(java.lang.String handleId)

Unregister (remove) the registered Handle. Does nothing if the handleId is invalid or was not registered.

Parameters:

handleId -

getHandle

public static EmbeddedHandle getHandle(java.lang.String handleId)
                                throws java.lang.IllegalArgumentException

Parameters:

handleId -

Returns:

HandleInterface to the embedded handler.

Throws:

java.lang.IllegalArgumentException - -- if the id provided is NOT for a registered Handle.

getService

public static EmbeddedServiceHandle getService(java.lang.String serviceId)
                                        throws java.lang.IllegalArgumentException

Parameters:

serviceId -

Returns:

ServiceInterface to the embedded service handler.

Throws:

java.lang.IllegalArgumentException - -- if the id provided is null or is NOT for a registered Service.

isToolRunning

public static boolean isToolRunning(java.lang.String handleId)

Parameters:

handleId - -- of the client/service sought.

Returns:

true if the handleId is registered. false if not.

isServiceRunning

public static boolean isServiceRunning(java.lang.String serviceId)

Parameters:

serviceId - -- of the service sought.

Returns:

true if the service is registered. false if not.

cleanQueues

public static boolean cleanQueues()