public class SAFSMAPS extends DriverConfiguredSTAFInterfaceClass implements MapsInterface
[STAF] ;NOSTAF=TRUE will launch this service as an embedded services. [SAFS_MAPS] AUTOLAUNCH=TRUE ;ITEM=org.safs.tools.input.SAFSMAPS ;Service=SAFSMAPS ;ServiceClass=org.safs.staf.service.SAFSAppMapService ;ServiceClass=org.safs.staf.service.EmbeddedMapService ;OPTIONS=
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.
The default ITEM value is org.safs.tools.input.SAFSMAPS
The default SERVICECLASS value is org.safs.staf.service.SAFSAppMapService
The default SERVICEJAR value is [safsroot]/lib/safsmaps.jar
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_SAFSMAPS_3_CLASS
"org.safs.staf.service.map.SAFSAppMapService3"
|
protected static java.lang.String |
DEFAULT_SAFSMAPS_CLASS
"org.safs.staf.service.map.SAFSAppMapService"
|
protected static java.lang.String |
DEFAULT_SAFSMAPS_EMBEDDED_CLASS
"org.safs.staf.service.map.EmbeddedMapService"
|
protected static java.lang.String |
DEFAULT_SAFSMAPS_JAR
"safsmaps.jar"
|
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 and Description |
---|
SAFSMAPS()
Constructor for SAFSMAPS.
|
Modifier and Type | Method and Description |
---|---|
void |
clearCache(UniqueIDInterface map)
NOT YET SUPPORTED BY SAFSMAPS service.
|
void |
closeMap(UniqueIDInterface map)
Close a previously opened App Map.
|
UniqueIDInterface |
getDefaultMap()
Get the ID of the current default map.
|
UniqueSectionInterface |
getDefaultMapSection()
Get the current maps default map section.
|
java.lang.String |
getMapItem(UniqueItemInterface item)
Retrieve the value of an item from an App Map.
|
void |
launchInterface(java.lang.Object configInfo)
Expects a DriverInterface for initialization.
|
void |
openMap(UniqueMapInterface map)
Open a new App Map for reference.
|
void |
reset()
Clear all App Map caches from the service.
|
void |
setDefaultMap(UniqueIDInterface map)
Set a previously opened map to be the default map.
|
void |
setDefaultMapSection(UniqueSectionInterface section)
Set a specific 'section' of a Map to be the default section.
|
configureJSTAFServiceEmbeddedJVMOption, extendedGenericMessage, finalize, getCoreInterface, getEmbedded64JVMBinPath, getEmbeddedJVMBinPath, getSTAFHelper, isToolRunning, logMessage, setLogUtilities, setLogUtilities, shutdown, shutdownService, simpleGenericMessage, simpleGenericSuccessMessage, simpleGenericWarningMessage, simpleSuccessMessage, simpleSuccessMessage, simpleSuccessUsingMessage, standardErrorMessage, waitForServiceStartCompletion
protected static final java.lang.String DEFAULT_SAFSMAPS_CLASS
protected static final java.lang.String DEFAULT_SAFSMAPS_3_CLASS
protected static final java.lang.String DEFAULT_SAFSMAPS_EMBEDDED_CLASS
protected static final java.lang.String DEFAULT_SAFSMAPS_JAR
protected java.lang.String classpath
public SAFSMAPS()
public void launchInterface(java.lang.Object configInfo)
launchInterface
in interface ConfigurableToolsInterface
launchInterface
in class DriverConfiguredSTAFInterfaceClass
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.ConfigurableToolsInterface#launchInterface(Object)
public void openMap(UniqueMapInterface map)
openMap
in interface MapsInterface
MapsInterface.openMap(UniqueMapInterface)
public void setDefaultMap(UniqueIDInterface map)
setDefaultMap
in interface MapsInterface
MapsInterface.setDefaultMap(UniqueIDInterface)
public UniqueIDInterface getDefaultMap()
getDefaultMap
in interface MapsInterface
MapsInterface.getDefaultMap()
public void setDefaultMapSection(UniqueSectionInterface section)
setDefaultMapSection
in interface MapsInterface
MapsInterface.setDefaultMapSection(UniqueSectionInterface)
public UniqueSectionInterface getDefaultMapSection()
getDefaultMapSection
in interface MapsInterface
setDefaultMapSection(UniqueSectionInterface)
public java.lang.String getMapItem(UniqueItemInterface item)
getMapItem
in interface MapsInterface
MapsInterface.getMapItem(UniqueItemInterface)
public void clearCache(UniqueIDInterface map)
clearCache
in interface MapsInterface
MapsInterface.clearCache(UniqueIDInterface)
public void closeMap(UniqueIDInterface map)
closeMap
in interface MapsInterface
MapsInterface.closeMap(UniqueIDInterface)
public void reset()
reset
in interface GenericToolsInterface
GenericToolsInterface#reset()
Copyright © SAS Institute. All Rights Reserved.