org.safs.staf

Class STAFProcessHelpers

java.lang.Object

org.safs.staf.STAFProcessHelpers

public class STAFProcessHelpers
extends java.lang.Object

Retrieves the only allowed instance of a STAFHelper for a given process name. This prevents attempts of registering multiple processes with the same name.

Since:

NOV 09, 2003
NOV 09, 2003 (Carl Nagle) Original Release
APR 26, 2011 (Lei Wang) Modify method unRegisterALLHelpers() If we clear the holders before calling unRegisterHelper(processname), unRegisterHelper(processname) may not work.
MAY 17, 2012 (Carl Nagle) Enhance launchSTAFProc to make more than 1 attempt.

Author:

Carl Nagle

Field Summary

Fields

Modifier and Type	Field and Description
protected static GetText	errorText
protected static java.lang.String	NULL_ERROR

Method Summary

Modifier and Type	Method and Description
static java.util.Enumeration	getSTAFHelperProcessNames() Retrieve the Process Names of any registered STAFHelpers--regardless of Class.
static boolean	hasSTAFHelpers()
static STAFHelper	launchSTAFProc(java.lang.String processName) Attempt to launch STAF.
static STAFHelper	launchSTAFProcClass(java.lang.String processName, java.lang.Class clazz) Attempt to launch STAF.
static STAFHelper	registerHelper(java.lang.String process_name) Create/Register/Retrieve a STAFHelper with the given process name.
static STAFHelper	registerHelperClass(java.lang.String process_name, java.lang.Class clazz) create/Register/Retrieve a STAFHelper with the given process name.
static void	shutdownDebugLog() Attempt to shutdown the SAFS Debug Log, if any.
static void	shutdownSTAFProc() Attempt to shutdown STAF.
static void	unRegisterALLHelpers() Unregisters ALL STAFHelpers for ALL processes ever registered via this class.
static void	unRegisterHelper(java.lang.String process_name) unRegister a STAFHelper with the given process name.

Methods inherited from class java.lang.Object

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

Field Detail

errorText

protected static GetText errorText

NULL_ERROR

protected static final java.lang.String NULL_ERROR

See Also:

Constant Field Values

Method Detail

registerHelperClass

public static STAFHelper registerHelperClass(java.lang.String process_name,
                                             java.lang.Class clazz)
                                      throws SAFSSTAFRegistrationException

create/Register/Retrieve a STAFHelper with the given process name. The returned STAFHelper will already be initialized.

If the STAFHelper was not already registered then a STAFHelper of the provided subclass will be instantiated.

Parameters:

process_name - The name of the process to register with STAF.

clazz - Allows us to specify a specific STAFHelper subclass to instantiate, if needed.

Returns:

STAFHelper instance

Throws:

SAFSStafRegistrationException - may be thrown if the process was registered by some other means outside of the control of this class.

SAFSSTAFRegistrationException

registerHelper

public static STAFHelper registerHelper(java.lang.String process_name)
                                 throws SAFSSTAFRegistrationException

Create/Register/Retrieve a STAFHelper with the given process name. The returned STAFHelper will already be initialized unless an exception is thrown. Will instantiate a STAFHelper.class instance if not already registered.

Parameters:

process_name - The name of the process to register with STAF.

Returns:

STAFHelper instance

Throws:

SAFSStafRegistrationException - may be thrown if the process was registered by some other means outside of the control of this class.

SAFSSTAFRegistrationException

unRegisterHelper

public static void unRegisterHelper(java.lang.String process_name)
                             throws SAFSSTAFRegistrationException

unRegister a STAFHelper with the given process name. This will only unregister the STAFHelper if it is the last known reference to the object.

The user can also simply wait until the end of everything and call the unRegisterALLHelpers method. This will unRegister all known STAFHelpers for all processes ever registered via this class.

Parameters:

process_name - The name of the process to unRegister with STAF.

Throws:

SAFSStafRegistrationException - may be thrown if some problem occurs.

SAFSSTAFRegistrationException

unRegisterALLHelpers

public static void unRegisterALLHelpers()

Unregisters ALL STAFHelpers for ALL processes ever registered via this class. Only recommended at the end of absolutely everything in SAFS testing.

launchSTAFProc

public static STAFHelper launchSTAFProc(java.lang.String processName)
                                 throws SAFSSTAFRegistrationException

Attempt to launch STAF. Instantiates and registers STAFHelper.class instance by default. Normally you would only do this if other operations detected it was not running.

Parameters:

processName - to automatically register with STAF and detect ServiceLoader.

Throws:

SAFSSTAFRegistrationException

launchSTAFProcClass

public static STAFHelper launchSTAFProcClass(java.lang.String processName,
                                             java.lang.Class clazz)
                                      throws SAFSSTAFRegistrationException

Attempt to launch STAF. Normally you would only do this if other operations detected it was not running.

Parameters:

processName - to automatically register with STAF and detect ServiceLoader.

a - STAFHelper subclass Class to instantiate.

Throws:

SAFSSTAFRegistrationException

See Also:

registerHelperClass(String, Class)

shutdownDebugLog

public static void shutdownDebugLog()
                             throws SAFSException

Attempt to shutdown the SAFS Debug Log, if any.

Throws:

SAFSException

shutdownSTAFProc

public static void shutdownSTAFProc()
                             throws SAFSException

Attempt to shutdown STAF. Normally you would only do this if all running engines, services, and queues would not prevent a successful shutdown. For example, you should NOT attempt to shutdown STAF if there is a running SAFS Engine or independent SAFS Debug Log process running. Those should be shutdown first.

However, calling this routine will make an attempt to shutdown any running SAFS Debug Log.

Throws:

SAFSException

See Also:

shutdownDebugLog()

hasSTAFHelpers

public static boolean hasSTAFHelpers()

Returns:

true if we have ANY initialized STAFHelpers stored.

getSTAFHelperProcessNames

public static java.util.Enumeration getSTAFHelperProcessNames()
                                                       throws java.lang.NullPointerException

Retrieve the Process Names of any registered STAFHelpers--regardless of Class.

Returns:

Enumeration of registered Process Names, if any. Thus, the Enumeration could have 0 entries.

Throws:

java.lang.NullPointerException