org.safs.tools.vars

Class SAFSVARS

java.lang.Object

org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

org.safs.tools.vars.SAFSVARS

All Implemented Interfaces:

ConfigurableToolsInterface, GenericToolsInterface, SimpleVarsInterface, VarsInterface

public class SAFSVARS
extends DriverConfiguredSTAFInterfaceClass
implements VarsInterface

This concrete implementation interfaces clients to the SAFSVARS service. This class expects a DriverInterface object to provide access to all configuration information.

This class can also be configured to run Embedded in the same process space as the Driver.
To do this, configure ServiceClass=org.safs.staf.service.var.EmbeddedVariableService.

When using the EmbeddedVariableService, the class can continue to use the STAF VAR service for the storage of variable values. It can also be configured to store variable values internally instead.
To do this, configure EmbedVars=True.

• ConfigureInterface Information

   [STAF]
   ;NOSTAF=TRUE  will launch this service as an embedded services if AUTOLAUNCH=TRUE.
   
   [SAFS_VARS]
   AUTOLAUNCH=TRUE
   ;ITEM=org.safs.tools.vars.SAFSVARS
   ;Service=SAFSVARS
   ;ServiceClass=org.safs.staf.service.var.SAFSVariableService
   ;ServiceClass=org.safs.staf.service.var.EmbeddedVariableService
   ;OPTIONS=
   ;EmbedVars=TRUE
   

  
  
  Note those items commented with semicolons are only needed when using alternate values.

AUTOLAUNCH

TRUE--Enable this class to launch the STAF service if it is not already running.
FALSE--Do not try to launch the service if it is not running.

The Driver's 'safs.driver.autolaunch' command-line option is also queried for this setting and overrides any other configuration source setting.

The default AUTOLAUNCH setting is TRUE.

ITEM

The full class name for an alternate VarsInterface class for SAFSVARS. This parameter is only needed if an alternate/custom VarsInterface is used. The class must be findable by the JVM and Class.forName functions.

The default ITEM value is org.safs.tools.vars.SAFSVARS

SERVICECLASS

The full class name for an alternate service class for SAFSVARS. This parameter is only needed if an alternate/custom service is used. This class must be findable by the JVM. This setting, if provided, will cause any SERVICEJAR setting to be ignored.

org.safs.staf.service.var.EmbeddedVariableService is one such class. This class will embed the SAFSVARS service inside the Driver process and bypass the initialization of any STAF SAFSVARS service. Combined with the EmbedVars setting, this will make all variables inaccessible to other tools and processes--effectively eliminating the use of STAF altogether.

The default SERVICECLASS value is org.safs.staf.service.SAFSVariableService

SERVICEJAR

The full path and name for an alternate service JAR for SAFSVARS. This parameter is only needed if an alternate/custom service is used. This class must be findable by the JVM. If a value is specified for SERVICECLASS, then this setting is ignored.

The default SERVICEJAR value is [safsroot]/lib/safsvars.jar

SERVICE

The service name for an alternate service instead of "SAFSVARS". This parameter is only needed if an alternate/custom service is used. Note: All of the standard SAFS Framework tools currently expect the default "SAFSVARS" service name.

OPTIONS

Any additional PARMS to be sent to the service upon initialization. The default SAFSMAPS service name parameter is already provided. Any additional options should be specified here. There typically will be none.

EmbedVars

Only valid when using the EmbeddedVariableService class. When set to TRUE this will cause the service to store all variable values internally and bypass the use of the STAF VAR service. This effectively bypasses the use of STAF altogether for the SAFSVARS service.

Author:

Carl Nagle DEC 14, 2005 Refactored with DriverConfiguredSTAFInterface superclass, JunwuMa MAY 15, 2009 Added support for SAFSVARS, make it work with STAF2 or STAF3, loading different version of SAFSVariableService according to STAF's version., Carl Nagle JUL 03, 2014 Commencing support for embedded non-STAF services., Carl Nagle JUL 11, 2014 Enabling EmbedVars support for the EmbeddedVariableService., Carl Nagle JUL 16, 2014 Added NOSTAF support for the Embedded Service.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	classpath Stores classname or JAR file fullpath for STAF service initialization.
protected static java.lang.String	DEFAULT_SAFSVARS_3_CLASS "org.safs.staf.service.var.SAFSVariableService3"
protected static java.lang.String	DEFAULT_SAFSVARS_CLASS "org.safs.staf.service.var.SAFSVariableService"
protected static java.lang.String	DEFAULT_SAFSVARS_EMBEDDED_CLASS "org.safs.staf.service.var.EmbeddedVariableService"
protected static java.lang.String	DEFAULT_SAFSVARS_JAR "safsvars.jar"
protected SafsExpression	se

Fields inherited from class org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

config, customStr, customText, debugStr, debugText, driver, DRIVER_TEMP_PROCESS, failedStr, failedText, genericStr, genericText, launchCount, log, machine, otherStr, otherText, passedStr, passedText, processName, running, SAFS_RESBUN_NAME, servicename, shutdownCount, staf, STAFPROC_EXE, warningStr, warningText, weStartedService, weStartedSTAF

Constructor Summary

Constructors

Constructor and Description
SAFSVARS() Constructor for SAFSVARS

Method Summary

Modifier and Type	Method and Description
void	deleteVariable(java.lang.String var) delete a variable from storage.
protected void	finalize() Invoke all superclass finalization.
java.lang.String	getValue(java.lang.String var) Get the value of a named variable.
void	launchInterface(java.lang.Object configInfo) Expects a DriverInterface for initialization.
void	reset() Reset or clear any cached information in the underlying tool or service.
java.lang.String	resolveExpressions(java.lang.String record, java.lang.String sep) Process the input record for supported numeric and string expressions.
java.lang.String	setValue(java.lang.String var, java.lang.String value) Set the value of a named variable.

Methods inherited from class org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

configureJSTAFServiceEmbeddedJVMOption, extendedGenericMessage, getCoreInterface, getEmbeddedJVMBinPath, getSTAFHelper, isToolRunning, logMessage, setLogUtilities, setLogUtilities, shutdown, shutdownService, simpleGenericMessage, simpleGenericSuccessMessage, simpleGenericWarningMessage, simpleSuccessMessage, simpleSuccessMessage, simpleSuccessUsingMessage, standardErrorMessage, waitForServiceStartCompletion

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SAFSVARS_CLASS

protected static final java.lang.String DEFAULT_SAFSVARS_CLASS

"org.safs.staf.service.var.SAFSVariableService"

See Also:

Constant Field Values

DEFAULT_SAFSVARS_3_CLASS

protected static final java.lang.String DEFAULT_SAFSVARS_3_CLASS

"org.safs.staf.service.var.SAFSVariableService3"

See Also:

Constant Field Values

DEFAULT_SAFSVARS_EMBEDDED_CLASS

protected static final java.lang.String DEFAULT_SAFSVARS_EMBEDDED_CLASS

"org.safs.staf.service.var.EmbeddedVariableService"

See Also:

Constant Field Values

DEFAULT_SAFSVARS_JAR

protected static final java.lang.String DEFAULT_SAFSVARS_JAR

"safsvars.jar"

See Also:

Constant Field Values

classpath

protected java.lang.String classpath

Stores classname or JAR file fullpath for STAF service initialization.

se

protected SafsExpression se

Constructor Detail

SAFSVARS

public SAFSVARS()

Constructor for SAFSVARS

Method Detail

launchInterface

public void launchInterface(java.lang.Object configInfo)

Expects a DriverInterface for initialization. The superclass handles generic initialization and then we provide SAFSVARS-specific initialization.

Specified by:

launchInterface in interface ConfigurableToolsInterface

Overrides:

launchInterface in class DriverConfiguredSTAFInterfaceClass

Parameters:

configInfo - can be whatever the final implementation needs it to be. This might be a String with configuration information, the name of a class, or an instance of some object used to provide configuration assets.

See Also:

ConfigurableToolsInterface#launchInterface(Object)

resolveExpressions

public java.lang.String resolveExpressions(java.lang.String record,
                                           java.lang.String sep)

Description copied from interface: VarsInterface

Process the input record for supported numeric and string expressions. The input record fields are delimited by the provided separator, and each field is separately processed for expressions.

Specified by:

resolveExpressions in interface VarsInterface

Returns:

Copy of input record with all expressions processed.

See Also:

VarsInterface.resolveExpressions(String, String)

setValue

public java.lang.String setValue(java.lang.String var,
                                 java.lang.String value)

Description copied from interface: SimpleVarsInterface

Set the value of a named variable.

Specified by:

setValue in interface SimpleVarsInterface

Returns:

the value as retrieved from the variable after it was set.

See Also:

SimpleVarsInterface.setValue(String, String)

getValue

public java.lang.String getValue(java.lang.String var)

Description copied from interface: SimpleVarsInterface

Get the value of a named variable.

Specified by:

getValue in interface SimpleVarsInterface

Returns:

the current value of the variable, or an empty string.

See Also:

SimpleVarsInterface.getValue(String)

deleteVariable

public void deleteVariable(java.lang.String var)

Description copied from interface: VarsInterface

delete a variable from storage.

Specified by:

deleteVariable in interface VarsInterface

See Also:

VarsInterface.deleteVariable(String)

reset

public void reset()

Description copied from interface: GenericToolsInterface

Reset or clear any cached information in the underlying tool or service. The implementation should be able to recognize if the underlying tool or service is not actually running. If the tool is not running, then this should exit gracefully without adversely affecting anything.

Specified by:

reset in interface GenericToolsInterface

See Also:

GenericToolsInterface#reset()

finalize

protected void finalize()
                 throws java.lang.Throwable

Invoke all superclass finalization.

Overrides:

finalize in class DriverConfiguredSTAFInterfaceClass

Throws:

java.lang.Throwable

See Also:

DriverConfiguredSTAFInterfaceClass.finalize()