AbstractSAFSInputService (SAFS API DOCUMENT)

java.lang.Object
- org.safs.staf.service.input.AbstractSAFSInputService

Direct Known Subclasses:: EmbeddedInputService, SAFSInputService, SAFSInputService3

public abstract class AbstractSAFSInputService
extends java.lang.Object

This AbstractSAFSInputService class is an external STAF service run by the JSTAF Service Proxy.
The intention is to provide global services for reading the content of text files in a manner suitable for a SAFS Drivers(like SAFSDRIVER) and Engines. For example, two different processes (or machines?) can share the file read operations as necessary. However, there will certainly be an array of other uses.

It is important to note that in a normal SAFS environment, Input services may make use of SAFS Variable services (SAFSVARS). This is because some commands may need to evaluate variable values or resolve expressions. This class is defined as an abstract class, for different version of STAF, you may extends this class and implements the staf-version-related interface (STAFServiceInterfaceLevel30 or STAFServiceInterfaceLevel3). We have implemented the class for version 2 and 3: SAFSInputService and SAFSInputService3

The AbstractSAFSInputService service provides the following commands:

OPEN	Open a file for use
NEXT	Get the next line from the file
GOTO	Goto a defined position in the file
BEGIN	Reset a file reader back to the first line
CLOSE	Close and release resources on a file
QUERY	Get information on a file
LIST	List information for all open files
RESET	Close and release all files and resources
HELP	Display this help information

1.0 Service Registration

Each instance of the service must be registered via the STAF Service service.

Example showing comandline registration:

 STAF LOCAL SERVICE ADD SERVICE SAFSINPUT LIBRARY JSTAF /
            EXECUTE c:/safs/lib/SAFSINPUT.JAR [PARMS <Parameters>]
 
 STAF LOCAL SERVICE ADD SERVICE SAFSINPUT LIBRARY JSTAF /
            EXECUTE c:/safs/lib/SAFSINPUT.JAR 
 
 STAF LOCAL SERVICE ADD SERVICE SAFSINPUT LIBRARY JSTAF /
            EXECUTE c:/safs/lib/SAFSINPUT.JAR PARMS DIR "c:/repo/Datapool"

By default, the service expects a "SAFSVARS" SAFSVariableService to handle Variable calls. A future release may add a parameter allowing a different variable service handler.

1.1 Valid Parameters when registering the service:

1.1.1 DIR <default directory>
If provided, the DIR parameter specifies a default directory to use if the OPEN request provides relative path information or no path information at all. File searches do not use system PATH information. The OPEN request expects a full filename path, or a path relative to this DIR option.

EX: <PARMS> DIR "c:/testproject/Datapool"

2.0 Commands

2.1 OPEN

The OPEN command attempts to open a file for read operations.

Syntax:

OPEN <FileID> FILE <Filename>

2.1.1 FileID is a unique ID for this file reader instance.

2.1.2 FILE is the filename of the file to load.
If a default Directory was specified when the service was launched, then the filename can be relative to that directory.

Example: staf local safsinput open myfile file TIDTest.CDD
Example: staf local safsinput open myfile file c:/testproject/datapool/Bench/TIDTest.txt

2.2 NEXT

The NEXT command reads the next line from the file matching FileID.

Syntax:

NEXT <FileID>

2.2.1 FileID is the unique ID for the file reader instance.

Example: staf local safsinput next myfile

2.3 GOTO

The GOTO command moves the file reader pointer to a defined place in the file.
Currently, the "defined place" must take the form of a SAFS BlockID record. Future releases may allow you to specify specific line numbers.

A SAFS BlockID record is a line with two fields separated by a delimiter as shown below:

    B, MyBlockID

The first field contains "B" which specifies a BlockID record. The second field specifies the name or label of the BlockID record. This label is the value identifying this "defined place" in the file.

This command will use the variables service to evaluate SAFS variables and process SAFS expressions in field #1 and/or field #2 in order to accurately locate the target BlockID.

The command will return STAFResult.OK and a (linenum:record) result string if successful; or an error code and error description upon failure.

Syntax:

GOTO <FileID> LOCATE <BlockID> SEPARATOR <SepChar>

2.3.1 FileID is the unique ID for the file reader instance.

2.3.2 BlockID is the target block ID label to locate.

2.3.3 SepChar is the character that delimits the two fields.

Example: staf local safsinput goto myfile locate MyBlockID separator ","

2.4 BEGIN

The BEGIN command resets the file reader matching the FileID back to the beginning of the file.

Syntax:

BEGIN <FileID>

2.4.1 FileID is the unique ID for the file reader instance.

Example: staf local safsinput begin myfile

2.5 CLOSE

The CLOSE command closes the file matching FileID and releases its resources.

Syntax:

CLOSE <FileID>

2.5.1 FileID is the unique ID for the file reader instance.

Example: staf local safsinput close myfile

2.6 QUERY

The QUERY command returns information about the file matching FileID.

Syntax:

QUERY <FileID> [ STATUS | FILENAME | FULLPATH ]

2.6.1 FileID is the unique ID for the file reader instance.

2.6.2 STATUS request status info on this file.

2.6.3 FILENAME request the simple filename of this file.

2.6.4 FULLPATH request the full path and filename of this file.

Example: staf local safsinput query myfile STATUS FULLPATH

2.7 LIST

The LIST command returns information on ALL files.

Syntax:

LIST

Example: staf local safsinput list

2.8 RESET

The RESET command closes all files and resets all resources.

Syntax:

RESET

Example: staf local safsinput reset

2.9 HELP

The HELP command returns a quick reference of supported commands and syntax.

Syntax:

HELP

Example: staf local safsinput list

Software Automation Framework Support (SAFS) http://safsdev.sourceforge.net
Software Testing Automation Framework (STAF) http://staf.sourceforge.net

Author:: Carl Nagle JUL 16, 2004 Inital Release of most functionality, Carl Nagle JAN 25, 2005 Fix to accept case-sensitive filenames
See Also:: SAFSInputService, SAFSInputService3

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.ibm.staf.service.STAFCommandParser`	`beginParser`
`protected static java.lang.String`	`c` a single colon
`protected com.ibm.staf.service.STAFCommandParser`	`closeParser`
`protected ServiceDebugLog`	`debugLog`
`protected java.lang.String`	`dir`
`protected java.lang.String`	`ext`
`protected HandleInterface`	`fHandle`
`protected boolean`	`file_extension_available`
`protected com.ibm.staf.service.STAFCommandParser`	`gotoParser`
`protected com.ibm.staf.service.STAFCommandParser`	`nextParser`
`protected com.ibm.staf.service.STAFCommandParser`	`openParser`
`protected com.ibm.staf.service.STAFCommandParser`	`parser`
`protected static java.lang.String`	`r` a single newline
`protected boolean`	`relative_path_allowed`
`protected com.ibm.staf.service.STAFCommandParser`	`resetParser`
`protected com.ibm.staf.service.STAFCommandParser`	`routeParser`
`protected static java.lang.String`	`s` a single space
`protected static java.util.ResourceBundle`	`safsfilereader_resources`
`protected java.lang.String`	`servicename`
`protected java.lang.String`	`serviceparams`
`protected java.lang.String`	`servicevars` Stores the name of the actual service used to resolve variable expressions.
`java.lang.String`	`SI_DEFAULT_RESOLVE_SERVICE` "SAFSVARS" -- default service used to resolve variable expressions for GOTO
`static java.lang.String`	`SI_RBKEY_ERROR_NOT_INTEGER`
`static java.lang.String`	`SI_RBKEY_NOT_IMPLEMENTED`
`static java.lang.String`	`SI_RBKEY_OPEN_FILES`
`static java.lang.String`	`SI_RBKEY_REQUIRED`
`static java.lang.String`	`SI_RBKEY_SYNC_ERROR`
`static java.lang.String`	`SI_RBKEY_UCPATH`
`static java.lang.String`	`SI_SERVICE_FILE_STATE_CLOSED`
`static java.lang.String`	`SI_SERVICE_FILE_STATE_EOF`
`static java.lang.String`	`SI_SERVICE_FILE_STATE_ERROR`
`static java.lang.String`	`SI_SERVICE_FILE_STATE_OPEN`
`protected int`	`SI_SERVICE_INIT_PARMS_MAX` The maximum number of options/parameters we expect a service initialization request to receive.
`static java.lang.String`	`SI_SERVICE_OPTION_DIR`
`static java.lang.String`	`SI_SERVICE_OPTION_EXT`
`static java.lang.String`	`SI_SERVICE_PARM_FILE`
`static java.lang.String`	`SI_SERVICE_PARM_FILENAME`
`static java.lang.String`	`SI_SERVICE_PARM_FULLPATH`
`static java.lang.String`	`SI_SERVICE_PARM_LASTERROR`
`static java.lang.String`	`SI_SERVICE_PARM_LOCATE`
`static java.lang.String`	`SI_SERVICE_PARM_SEPARATOR`
`static java.lang.String`	`SI_SERVICE_PARM_STATUS`
`protected int`	`SI_SERVICE_REQUEST_ARGS_MAX` The maximum number of options/parameters we expect a running service to receive in a request.
`static java.lang.String`	`SI_SERVICE_REQUEST_BEGIN`
`static java.lang.String`	`SI_SERVICE_REQUEST_CLOSE`
`static java.lang.String`	`SI_SERVICE_REQUEST_GOTO`
`static java.lang.String`	`SI_SERVICE_REQUEST_HELP`
`static java.lang.String`	`SI_SERVICE_REQUEST_LIST`
`static java.lang.String`	`SI_SERVICE_REQUEST_NEXTLINE`
`static java.lang.String`	`SI_SERVICE_REQUEST_OPEN`
`static java.lang.String`	`SI_SERVICE_REQUEST_QUERY`
`static java.lang.String`	`SI_SERVICE_REQUEST_RESET`
`static java.lang.String`	`SI_SERVICE_SAFSFILE_BUNDLE_NAME` The fully qualified name of the localizable ResourceBundle for this class.
`protected java.lang.String`	`SI_SERVICE_SAFSFILE_LISTINFO` The text substring identifying the file type in each file LIST response.

Constructor Summary

Constructors
Constructor and Description

AbstractSAFSInputService()

Constructors
Constructor and Description
`AbstractSAFSInputService()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.ibm.staf.STAFResult`	`acceptRequest(InfoInterface.RequestInfo info)`
`protected java.lang.String`	`buildHELPInfo()`
`protected void`	`createParser()`
`protected java.lang.String`	`getHELPInfo(java.lang.String info)` Add your HELP text response here.
`protected java.lang.String`	`getOPENInfo(com.ibm.staf.service.STAFCommandParseResult parsedData, java.lang.String info)` Handle any added OPEN options here.
`protected SAFSTextFile`	`getParsedDataTextFile(com.ibm.staf.STAFResult result, java.lang.String fileid)`
`protected com.ibm.staf.STAFResult`	`handleBegin(InfoInterface.RequestInfo info, com.ibm.staf.service.STAFCommandParseResult parsedData)`
`protected com.ibm.staf.STAFResult`	`handleClose(InfoInterface.RequestInfo info, com.ibm.staf.service.STAFCommandParseResult parsedData)`
`protected com.ibm.staf.STAFResult`	`handleGoto(InfoInterface.RequestInfo info, com.ibm.staf.service.STAFCommandParseResult parsedData)`
`protected com.ibm.staf.STAFResult`	`handleHelp(InfoInterface.RequestInfo info)`
`protected com.ibm.staf.STAFResult`	`handleList(InfoInterface.RequestInfo info)`
`protected com.ibm.staf.STAFResult`	`handleNext(InfoInterface.RequestInfo info, com.ibm.staf.service.STAFCommandParseResult parsedData)`
`protected com.ibm.staf.STAFResult`	`handleOpen(InfoInterface.RequestInfo info, com.ibm.staf.service.STAFCommandParseResult parsedData)`
`protected com.ibm.staf.STAFResult`	`handleQuery(InfoInterface.RequestInfo info, com.ibm.staf.service.STAFCommandParseResult parsedData)`
`protected com.ibm.staf.STAFResult`	`handleReset(InfoInterface.RequestInfo info)`
`com.ibm.staf.STAFResult`	`init(InfoInterface.InitInfo info)`
`protected boolean`	`isTargetBlock(java.lang.String inputBlockID, java.lang.String inputRecord, java.lang.String fieldsep)`
`protected void`	`locateBlockID(com.ibm.staf.STAFResult result, SAFSTextFile file, java.lang.String inputBlockID, java.lang.String fieldsep)`
`protected SAFSTextFile`	`openFile(java.lang.String machine, java.lang.String process, int handle, java.lang.String fileid, java.io.File file, com.ibm.staf.service.STAFCommandParseResult parsedData)` A subclass must override this function to instantiate its own file type.
`protected java.lang.String`	`processExpression(java.lang.String expression)`
`protected com.ibm.staf.STAFResult`	`processRequest(InfoInterface.RequestInfo info, com.ibm.staf.service.STAFCommandParseResult parseData)` A subclass must override this function to handle requests not handled by the superclass.
`protected void`	`registerHandle(java.lang.String handleId)` Subclasses may override to allow for future subclasses of STAFHandle.
`protected com.ibm.staf.STAFResult`	`terminate()`
`java.lang.String`	`text(java.lang.String resourcekey)` Retrieves potentially localized text from the resource bundle Localized subclasses should provide a similar function or override this function.
`protected int`	`validateBaseServiceParseResult(InfoInterface.InitInfo info)`
`protected int`	`validateServiceParseResult(com.ibm.staf.service.STAFCommandParseResult parsedData)` Use to validate the Service initialization string after a request for initialization has been received.

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

- Field Detail
  - SI_SERVICE_SAFSFILE_LISTINFO
```
protected java.lang.String SI_SERVICE_SAFSFILE_LISTINFO
```
    The text substring identifying the file type in each file LIST response. Subclasses are expected to override this value for differing file types.
  - SI_DEFAULT_RESOLVE_SERVICE
```
public java.lang.String SI_DEFAULT_RESOLVE_SERVICE
```
    "SAFSVARS" -- default service used to resolve variable expressions for GOTO
  - servicevars
```
protected java.lang.String servicevars
```
    Stores the name of the actual service used to resolve variable expressions. This is normally "SAFSVARS".
  - SI_SERVICE_SAFSFILE_BUNDLE_NAME
```
public static final java.lang.String SI_SERVICE_SAFSFILE_BUNDLE_NAME
```
    The fully qualified name of the localizable ResourceBundle for this class. Subclasses are expected to provide their own additional ResourceBundle handling file and subroutine when appropriate.
    
    See Also:
    
    Constant Field Values
  - SI_SERVICE_INIT_PARMS_MAX
```
protected int SI_SERVICE_INIT_PARMS_MAX
```
    The maximum number of options/parameters we expect a service initialization request to receive. Subclasses are expected to override this value when appropriate.
  - SI_SERVICE_REQUEST_ARGS_MAX
```
protected int SI_SERVICE_REQUEST_ARGS_MAX
```
    The maximum number of options/parameters we expect a running service to receive in a request. Subclasses are expected to override this value when appropriate.
  - safsfilereader_resources
```
protected static java.util.ResourceBundle safsfilereader_resources
```
  - SI_RBKEY_NOT_IMPLEMENTED
```
public static final java.lang.String SI_RBKEY_NOT_IMPLEMENTED
```
    See Also:
    
    Constant Field Values
  - SI_RBKEY_OPEN_FILES
```
public static final java.lang.String SI_RBKEY_OPEN_FILES
```
    See Also:
    
    Constant Field Values
  - SI_RBKEY_UCPATH
```
public static final java.lang.String SI_RBKEY_UCPATH
```
    See Also:
    
    Constant Field Values
  - SI_RBKEY_SYNC_ERROR
```
public static final java.lang.String SI_RBKEY_SYNC_ERROR
```
    See Also:
    
    Constant Field Values
  - SI_RBKEY_REQUIRED
```
public static final java.lang.String SI_RBKEY_REQUIRED
```
    See Also:
    
    Constant Field Values
  - SI_RBKEY_ERROR_NOT_INTEGER
```
public static final java.lang.String SI_RBKEY_ERROR_NOT_INTEGER
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_OPTION_DIR
```
public static final java.lang.String SI_SERVICE_OPTION_DIR
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_OPTION_EXT
```
public static final java.lang.String SI_SERVICE_OPTION_EXT
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_REQUEST_OPEN
```
public static final java.lang.String SI_SERVICE_REQUEST_OPEN
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_REQUEST_NEXTLINE
```
public static final java.lang.String SI_SERVICE_REQUEST_NEXTLINE
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_REQUEST_GOTO
```
public static final java.lang.String SI_SERVICE_REQUEST_GOTO
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_REQUEST_CLOSE
```
public static final java.lang.String SI_SERVICE_REQUEST_CLOSE
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_REQUEST_HELP
```
public static final java.lang.String SI_SERVICE_REQUEST_HELP
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_REQUEST_QUERY
```
public static final java.lang.String SI_SERVICE_REQUEST_QUERY
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_REQUEST_BEGIN
```
public static final java.lang.String SI_SERVICE_REQUEST_BEGIN
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_REQUEST_RESET
```
public static final java.lang.String SI_SERVICE_REQUEST_RESET
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_REQUEST_LIST
```
public static final java.lang.String SI_SERVICE_REQUEST_LIST
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_PARM_FILE
```
public static final java.lang.String SI_SERVICE_PARM_FILE
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_PARM_STATUS
```
public static final java.lang.String SI_SERVICE_PARM_STATUS
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_PARM_FILENAME
```
public static final java.lang.String SI_SERVICE_PARM_FILENAME
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_PARM_FULLPATH
```
public static final java.lang.String SI_SERVICE_PARM_FULLPATH
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_PARM_LASTERROR
```
public static final java.lang.String SI_SERVICE_PARM_LASTERROR
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_PARM_LOCATE
```
public static final java.lang.String SI_SERVICE_PARM_LOCATE
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_PARM_SEPARATOR
```
public static final java.lang.String SI_SERVICE_PARM_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_FILE_STATE_OPEN
```
public static final java.lang.String SI_SERVICE_FILE_STATE_OPEN
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_FILE_STATE_CLOSED
```
public static final java.lang.String SI_SERVICE_FILE_STATE_CLOSED
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_FILE_STATE_EOF
```
public static final java.lang.String SI_SERVICE_FILE_STATE_EOF
```
    See Also:
    
    Constant Field Values
  - SI_SERVICE_FILE_STATE_ERROR
```
public static final java.lang.String SI_SERVICE_FILE_STATE_ERROR
```
    See Also:
    
    Constant Field Values
  - parser
```
protected com.ibm.staf.service.STAFCommandParser parser
```
  - routeParser
```
protected com.ibm.staf.service.STAFCommandParser routeParser
```
  - openParser
```
protected com.ibm.staf.service.STAFCommandParser openParser
```
  - closeParser
```
protected com.ibm.staf.service.STAFCommandParser closeParser
```
  - beginParser
```
protected com.ibm.staf.service.STAFCommandParser beginParser
```
  - nextParser
```
protected com.ibm.staf.service.STAFCommandParser nextParser
```
  - resetParser
```
protected com.ibm.staf.service.STAFCommandParser resetParser
```
  - gotoParser
```
protected com.ibm.staf.service.STAFCommandParser gotoParser
```
  - fHandle
```
protected HandleInterface fHandle
```
  - servicename
```
protected java.lang.String servicename
```
  - serviceparams
```
protected java.lang.String serviceparams
```
  - relative_path_allowed
```
protected boolean relative_path_allowed
```
  - file_extension_available
```
protected boolean file_extension_available
```
  - dir
```
protected java.lang.String dir
```
  - ext
```
protected java.lang.String ext
```
  - c
```
protected static java.lang.String c
```
    a single colon
  - s
```
protected static java.lang.String s
```
    a single space
  - r
```
protected static java.lang.String r
```
    a single newline
  - debugLog
```
protected ServiceDebugLog debugLog
```
- Constructor Detail
  - AbstractSAFSInputService
```
public AbstractSAFSInputService()
```
- Method Detail
  - registerHandle
```
protected void registerHandle(java.lang.String handleId)
                       throws com.ibm.staf.STAFException
```
    Subclasses may override to allow for future subclasses of STAFHandle.
    
    Parameters:
    
    handleId -
    
    Throws:
    
    com.ibm.staf.STAFException
  - init
```
public com.ibm.staf.STAFResult init(InfoInterface.InitInfo info)
```
  - acceptRequest
```
public com.ibm.staf.STAFResult acceptRequest(InfoInterface.RequestInfo info)
```
  - terminate
```
protected com.ibm.staf.STAFResult terminate()
```
  - validateBaseServiceParseResult
```
protected final int validateBaseServiceParseResult(InfoInterface.InitInfo info)
```
  - createParser
```
protected void createParser()
```
  - buildHELPInfo
```
protected final java.lang.String buildHELPInfo()
```
  - handleHelp
```
protected com.ibm.staf.STAFResult handleHelp(InfoInterface.RequestInfo info)
```
  - handleReset
```
protected com.ibm.staf.STAFResult handleReset(InfoInterface.RequestInfo info)
```
  - handleNext
```
protected com.ibm.staf.STAFResult handleNext(InfoInterface.RequestInfo info,
                                             com.ibm.staf.service.STAFCommandParseResult parsedData)
```
  - handleClose
```
protected com.ibm.staf.STAFResult handleClose(InfoInterface.RequestInfo info,
                                              com.ibm.staf.service.STAFCommandParseResult parsedData)
```
  - handleOpen
```
protected com.ibm.staf.STAFResult handleOpen(InfoInterface.RequestInfo info,
                                             com.ibm.staf.service.STAFCommandParseResult parsedData)
```
  - handleBegin
```
protected com.ibm.staf.STAFResult handleBegin(InfoInterface.RequestInfo info,
                                              com.ibm.staf.service.STAFCommandParseResult parsedData)
```
  - handleGoto
```
protected com.ibm.staf.STAFResult handleGoto(InfoInterface.RequestInfo info,
                                             com.ibm.staf.service.STAFCommandParseResult parsedData)
```
  - handleQuery
```
protected com.ibm.staf.STAFResult handleQuery(InfoInterface.RequestInfo info,
                                              com.ibm.staf.service.STAFCommandParseResult parsedData)
```
  - handleList
```
protected com.ibm.staf.STAFResult handleList(InfoInterface.RequestInfo info)
```
  - validateServiceParseResult
```
protected int validateServiceParseResult(com.ibm.staf.service.STAFCommandParseResult parsedData)
```
    Use to validate the Service initialization string after a request for initialization has been received.
    This is where you check to see which options exist in the request, and act upon them. Make sure you also forward the validation request up the food chain so the superclasses can validate their service init options, too.
    return super.validateServiceParseResult( parsedData );
    
    Parameters:
    
    parsedData - the result object after parsing was performed
  - processRequest
```
protected com.ibm.staf.STAFResult processRequest(InfoInterface.RequestInfo info,
                                                 com.ibm.staf.service.STAFCommandParseResult parseData)
```
    A subclass must override this function to handle requests not handled by the superclass. The subclass must also forward any unhandled requests to the superclass function.
    return super.processRequest(info, parsedData);
    
    Parameters:
    
    info - InfoInterface.RequestInfo, it contains:
    machine the machine initiating the request.
    process the name of the Process initiating the request.
    handle the Handle of the Process initiating the request.
    
    parsedData - the parsed result containing the command and the user-supplied options provided.
    
    Returns:
    
    the result object after processing the request.
  - text
```
public java.lang.String text(java.lang.String resourcekey)
```
    Retrieves potentially localized text from the resource bundle Localized subclasses should provide a similar function or override this function. If the subclass function fails to locate the message in the subclass's ResourceBundle, then the subclass should call the superclass function to look there.
    text = super.text(resourceKey);
    
    Parameters:
    
    resourceKey - the key name of the message to retrieve.
    
    Returns:
    
    the localized text or a localization error string
  - getOPENInfo
```
protected java.lang.String getOPENInfo(com.ibm.staf.service.STAFCommandParseResult parsedData,
                                       java.lang.String info)
```
    Handle any added OPEN options here. This root class has already added info to the string prior to the call into the subclass. You may still forward the request to any superclass "just in case".
    return super.getOPENInfo( parsedData, info );
    
    Parameters:
    
    parsedData - the parsed request to interrogate for OPEN option parameter values.
    
    info - the status string that will be displayed for the OPEN command.
    
    Returns:
    
    any text to be added to the OPEN response.
  - getHELPInfo
```
protected java.lang.String getHELPInfo(java.lang.String info)
```
    Add your HELP text response here. The root class will handle its own HELP substring. You will still forward the request to any superclass to have their HELP options displayed, too.
    info += MY_LONG_INVOLVED_FORMATTED_HELP_TEXT;
    return super.getHELPInfo( info );
    
    Parameters:
    
    info - the response string that will be displayed for the HELP command.
    
    Returns:
    
    any text to be prepend the superclass response.
  - openFile
```
protected SAFSTextFile openFile(java.lang.String machine,
                                java.lang.String process,
                                int handle,
                                java.lang.String fileid,
                                java.io.File file,
                                com.ibm.staf.service.STAFCommandParseResult parsedData)
```
    A subclass must override this function to instantiate its own file type. The file type, obviously, must be a extension of SAFSFile.
    
    Parameters:
    
    machine - the machine initiating the request to open the file.
    
    process - the name of the Process initiating the request to open the file.
    
    handle - the Handle of the Process initiating the request to open the file.
    
    fileid - the unique fileid to be assigned the file. fileids should be uniquely identifiable among all Handles for a given Process.
    
    file - the File object used to open the file.
    
    parsedData - the parsed result containing the OPEN command and any of the user-supplied options that may be needed when opening the file or setting options in the file handler.
    
    Returns:
    
    the instance of the SAFSFile object that has been created.
  - processExpression
```
protected java.lang.String processExpression(java.lang.String expression)
```
  - isTargetBlock
```
protected boolean isTargetBlock(java.lang.String inputBlockID,
                                java.lang.String inputRecord,
                                java.lang.String fieldsep)
```
  - locateBlockID
```
protected void locateBlockID(com.ibm.staf.STAFResult result,
                             SAFSTextFile file,
                             java.lang.String inputBlockID,
                             java.lang.String fieldsep)
```
  - getParsedDataTextFile
```
protected final SAFSTextFile getParsedDataTextFile(com.ibm.staf.STAFResult result,
                                                   java.lang.String fileid)
```

Class AbstractSAFSInputService

1.0 Service Registration

2.0 Commands

2.1 OPEN

2.2 NEXT

2.3 GOTO

2.4 BEGIN

2.5 CLOSE

2.6 QUERY

2.7 LIST

2.8 RESET

2.9 HELP

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SI_SERVICE_SAFSFILE_LISTINFO

SI_DEFAULT_RESOLVE_SERVICE

servicevars

SI_SERVICE_SAFSFILE_BUNDLE_NAME

SI_SERVICE_INIT_PARMS_MAX

SI_SERVICE_REQUEST_ARGS_MAX

safsfilereader_resources

SI_RBKEY_NOT_IMPLEMENTED

SI_RBKEY_OPEN_FILES

SI_RBKEY_UCPATH

SI_RBKEY_SYNC_ERROR

SI_RBKEY_REQUIRED

SI_RBKEY_ERROR_NOT_INTEGER

SI_SERVICE_OPTION_DIR

SI_SERVICE_OPTION_EXT

SI_SERVICE_REQUEST_OPEN

SI_SERVICE_REQUEST_NEXTLINE

SI_SERVICE_REQUEST_GOTO

SI_SERVICE_REQUEST_CLOSE

SI_SERVICE_REQUEST_HELP

SI_SERVICE_REQUEST_QUERY

SI_SERVICE_REQUEST_BEGIN

SI_SERVICE_REQUEST_RESET

SI_SERVICE_REQUEST_LIST

SI_SERVICE_PARM_FILE

SI_SERVICE_PARM_STATUS

SI_SERVICE_PARM_FILENAME

SI_SERVICE_PARM_FULLPATH

SI_SERVICE_PARM_LASTERROR

SI_SERVICE_PARM_LOCATE

SI_SERVICE_PARM_SEPARATOR

SI_SERVICE_FILE_STATE_OPEN

SI_SERVICE_FILE_STATE_CLOSED

SI_SERVICE_FILE_STATE_EOF

SI_SERVICE_FILE_STATE_ERROR

parser

routeParser

openParser

closeParser

beginParser

nextParser

resetParser

gotoParser

fHandle

servicename

serviceparams

relative_path_allowed

file_extension_available

dir

ext

c

s

r

debugLog

Constructor Detail

AbstractSAFSInputService

Method Detail

registerHandle

init

acceptRequest

terminate

validateBaseServiceParseResult

createParser