SAFSMAPS (SAFS API DOCUMENT)

java.lang.Object
- org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass
- - org.safs.tools.input.SAFSMAPS

All Implemented Interfaces:: ConfigurableToolsInterface, GenericToolsInterface, MapsInterface

public class SAFSMAPS
extends DriverConfiguredSTAFInterfaceClass
implements MapsInterface

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

ConfigureInterface Information

 [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=

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 MapsInterface class for SAFSMAPS. This parameter is only needed if an alternate/custom MapsInterface is used. The class must be findable by the JVM and Class.forName functions.

The default ITEM value is org.safs.tools.input.SAFSMAPS

SERVICECLASS

The full class name for an alternate service class for SAFSMAPS. 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.

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

SERVICEJAR

The full path and name for an alternate service JAR for SAFSMAPS. 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/safsmaps.jar

SERVICE

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

OPTIONS

Any additional PARMS to be sent to the service upon initialization. We already handle sending the DIR parameter with the path obtained from the Driver. Any other options needed for service initialization should be specified here. There typically will be none.

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 SAFSAppMapService according to STAF's version., 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_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"

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

SAFSMAPS()
Constructor for SAFSMAPS.

Constructors
Constructor and Description
`SAFSMAPS()` Constructor for SAFSMAPS.

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_SAFSMAPS_CLASS
```
protected static final java.lang.String DEFAULT_SAFSMAPS_CLASS
```
    "org.safs.staf.service.map.SAFSAppMapService"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SAFSMAPS_3_CLASS
```
protected static final java.lang.String DEFAULT_SAFSMAPS_3_CLASS
```
    "org.safs.staf.service.map.SAFSAppMapService3"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SAFSMAPS_EMBEDDED_CLASS
```
protected static final java.lang.String DEFAULT_SAFSMAPS_EMBEDDED_CLASS
```
    "org.safs.staf.service.map.EmbeddedMapService"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SAFSMAPS_JAR
```
protected static final java.lang.String DEFAULT_SAFSMAPS_JAR
```
    "safsmaps.jar"
    
    See Also:
    
    Constant Field Values
  - classpath
```
protected java.lang.String classpath
```
    Stores classname or JAR file fullpath for STAF service initialization.
- Constructor Detail
  - SAFSMAPS
```
public SAFSMAPS()
```
    Constructor for SAFSMAPS. The object cannot do much of anything at all until the DriverInterface and ConfigureInterface have been received via the launchInterface function.
- Method Detail
  - launchInterface
```
public void launchInterface(java.lang.Object configInfo)
```
    Expects a DriverInterface for initialization. The superclass handles generic initialization and then we provide SAFSMAPS-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)
  - openMap
```
public void openMap(UniqueMapInterface map)
```
    Open a new App Map for reference. Always sets the opened map as the new default map. The UniqueMapInterface is expected to simply have the mapid, and the String map filename or fullpath.
    
    Specified by:
    
    openMap in interface MapsInterface
    
    See Also:
    
    MapsInterface.openMap(UniqueMapInterface)
  - setDefaultMap
```
public void setDefaultMap(UniqueIDInterface map)
```
    Set a previously opened map to be the default map. Most clients will probably never do this.
    
    Specified by:
    
    setDefaultMap in interface MapsInterface
    
    See Also:
    
    MapsInterface.setDefaultMap(UniqueIDInterface)
  - getDefaultMap
```
public UniqueIDInterface getDefaultMap()
```
    Get the ID of the current default map.
    
    Specified by:
    
    getDefaultMap in interface MapsInterface
    
    See Also:
    
    MapsInterface.getDefaultMap()
  - setDefaultMapSection
```
public void setDefaultMapSection(UniqueSectionInterface section)
```
    Set a specific 'section' of a Map to be the default section. The default section is normally 'ApplicationConstants'. The user can change this if desired.
    
    Specified by:
    
    setDefaultMapSection in interface MapsInterface
    
    See Also:
    
    MapsInterface.setDefaultMapSection(UniqueSectionInterface)
  - getDefaultMapSection
```
public UniqueSectionInterface getDefaultMapSection()
```
    Get the current maps default map section. The default section is normally 'ApplicationConstants'. The user can change this if desired.
    
    Specified by:
    
    getDefaultMapSection in interface MapsInterface
    
    See Also:
    
    setDefaultMapSection(UniqueSectionInterface)
  - getMapItem
```
public java.lang.String getMapItem(UniqueItemInterface item)
```
    Retrieve the value of an item from an App Map.
    
    Specified by:
    
    getMapItem in interface MapsInterface
    
    See Also:
    
    MapsInterface.getMapItem(UniqueItemInterface)
  - clearCache
```
public void clearCache(UniqueIDInterface map)
```
    NOT YET SUPPORTED BY SAFSMAPS service. Currently calls 'reset()'.
    
    Specified by:
    
    clearCache in interface MapsInterface
    
    See Also:
    
    MapsInterface.clearCache(UniqueIDInterface)
  - closeMap
```
public void closeMap(UniqueIDInterface map)
```
    Close a previously opened App Map.
    
    Specified by:
    
    closeMap in interface MapsInterface
    
    See Also:
    
    MapsInterface.closeMap(UniqueIDInterface)
  - reset
```
public void reset()
```
    Clear all App Map caches from the service.
    
    Specified by:
    
    reset in interface GenericToolsInterface
    
    See Also:
    
    GenericToolsInterface#reset()

Class SAFSMAPS

ConfigureInterface Information

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SAFSMAPS_CLASS

DEFAULT_SAFSMAPS_3_CLASS

DEFAULT_SAFSMAPS_EMBEDDED_CLASS

DEFAULT_SAFSMAPS_JAR

classpath

Constructor Detail

SAFSMAPS

Method Detail

launchInterface

openMap

setDefaultMap

getDefaultMap

setDefaultMapSection

getDefaultMapSection

getMapItem

clearCache

closeMap

reset