com.ibm.di.parser
Class SPMLv2Parser

java.lang.Object
  com.ibm.di.parser.ParserImpl
      com.ibm.di.parser.SPMLv2Parser

All Implemented Interfaces:

ParserInterface, VersionInfoInterface

public class SPMLv2Parser
extends ParserImpl

A ITDI Parser class for reading and writing Entries in SPMLv2 DSMLv2 Profile format

Field Summary

static String	ATTR_NAME_ATTR_DESCRIPTIONS
static String	ATTR_NAME_CONTAINERID
static String	ATTR_NAME_CONTAINERID_TARGETID
static String	ATTR_NAME_ERROR_CODE
static String	ATTR_NAME_ERROR_MESSAGES
static String	ATTR_NAME_PSO_TARGETID
static String	ATTR_NAME_PSOID
static String	ATTR_NAME_REQUESTID
static String	ATTR_NAME_RESULT_ENTRIES
static String	ATTR_NAME_SEARCH_SCOPE
static String	ATTR_NAME_SPML_OP_TYPE
static String	ATTR_NAME_SPML_OPERATION
static String	ATTR_NAME_STATUS
static String	ATTR_NAME_SUBSTRINGS_ANY
static String	ATTR_NAME_SUBSTRINGS_FINAL
static String	ATTR_NAME_SUBSTRINGS_INITIAL
static String	ATTR_NAME_SUBSTRINGS_NAME
static String	ATTR_NAME_TARGETID
static String	OP_TYPE_REQUEST
static String	OP_TYPE_RESPONSE
static String	OPERATION_ADD
static String	OPERATION_DELETE
static String	OPERATION_LOOKUP
static String	OPERATION_MODIFY
static String	OPERATION_SEARCH
static String	PARAMETER_BINARY_ATTRIBUTES

Fields inherited from class com.ibm.di.parser.ParserImpl

_debug, myConfiguration

Constructor Summary

SPMLv2Parser()

Method Summary

void	closeParser() Closes the parser
void	flush() Flushes the parser's outputstream or writer
String	getVersion() Returns version information
void	initParser() Initializes the Parser
Entry	readEntry() Reads a request or response from a batch message
void	writeEntry(Entry aEntry) Writes down a request or response to a batch message

Methods inherited from class com.ibm.di.parser.ParserImpl

debug, debugMode, getClassInstance, getContext, getDebug, getInputStream, getOutputStream, getParam, getParser, getReader, getWriter, isDeltaSupported, logmsg, registerScriptBeans, setConfiguration, setContext, setDebug, setInputStream, setInputStream, setInputStream, setOutputStream, setOutputStream, setParam, setParser

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_BINARY_ATTRIBUTES

public static final String PARAMETER_BINARY_ATTRIBUTES

See Also:

Constant Field Values

ATTR_NAME_SPML_OP_TYPE

public static final String ATTR_NAME_SPML_OP_TYPE

See Also:

Constant Field Values

OP_TYPE_REQUEST

public static final String OP_TYPE_REQUEST

See Also:

Constant Field Values

OP_TYPE_RESPONSE

public static final String OP_TYPE_RESPONSE

See Also:

Constant Field Values

ATTR_NAME_SPML_OPERATION

public static final String ATTR_NAME_SPML_OPERATION

See Also:

Constant Field Values

OPERATION_ADD

public static final String OPERATION_ADD

See Also:

Constant Field Values

OPERATION_SEARCH

public static final String OPERATION_SEARCH

See Also:

Constant Field Values

OPERATION_MODIFY

public static final String OPERATION_MODIFY

See Also:

Constant Field Values

OPERATION_DELETE

public static final String OPERATION_DELETE

See Also:

Constant Field Values

OPERATION_LOOKUP

public static final String OPERATION_LOOKUP

See Also:

Constant Field Values

ATTR_NAME_CONTAINERID

public static final String ATTR_NAME_CONTAINERID

See Also:

Constant Field Values

ATTR_NAME_CONTAINERID_TARGETID

public static final String ATTR_NAME_CONTAINERID_TARGETID

See Also:

Constant Field Values

ATTR_NAME_SEARCH_SCOPE

public static final String ATTR_NAME_SEARCH_SCOPE

See Also:

Constant Field Values

ATTR_NAME_REQUESTID

public static final String ATTR_NAME_REQUESTID

See Also:

Constant Field Values

ATTR_NAME_TARGETID

public static final String ATTR_NAME_TARGETID

See Also:

Constant Field Values

ATTR_NAME_RESULT_ENTRIES

public static final String ATTR_NAME_RESULT_ENTRIES

See Also:

Constant Field Values

ATTR_NAME_PSOID

public static final String ATTR_NAME_PSOID

See Also:

Constant Field Values

ATTR_NAME_PSO_TARGETID

public static final String ATTR_NAME_PSO_TARGETID

See Also:

Constant Field Values

ATTR_NAME_STATUS

public static final String ATTR_NAME_STATUS

See Also:

Constant Field Values

ATTR_NAME_ERROR_MESSAGES

public static final String ATTR_NAME_ERROR_MESSAGES

See Also:

Constant Field Values

ATTR_NAME_ERROR_CODE

public static final String ATTR_NAME_ERROR_CODE

See Also:

Constant Field Values

ATTR_NAME_ATTR_DESCRIPTIONS

public static final String ATTR_NAME_ATTR_DESCRIPTIONS

See Also:

Constant Field Values

ATTR_NAME_SUBSTRINGS_NAME

public static final String ATTR_NAME_SUBSTRINGS_NAME

See Also:

Constant Field Values

ATTR_NAME_SUBSTRINGS_INITIAL

public static final String ATTR_NAME_SUBSTRINGS_INITIAL

See Also:

Constant Field Values

ATTR_NAME_SUBSTRINGS_ANY

public static final String ATTR_NAME_SUBSTRINGS_ANY

See Also:

Constant Field Values

ATTR_NAME_SUBSTRINGS_FINAL

public static final String ATTR_NAME_SUBSTRINGS_FINAL

See Also:

Constant Field Values

Constructor Detail

SPMLv2Parser

public SPMLv2Parser()

Method Detail

initParser

public void initParser()
                throws Exception

Initializes the Parser

Specified by:

initParser in interface ParserInterface

Overrides:

initParser in class ParserImpl

Throws:

Exception - if the initialization fails

readEntry

public Entry readEntry()
                throws Exception

Reads a request or response from a batch message

Returns:

The next entry from the input stream

Throws:

Exception

writeEntry

public void writeEntry(Entry aEntry)
                throws Exception

Writes down a request or response to a batch message

Parameters:

aEntry - TDI Entry that presents the request/response that is to be written to a batch message

Throws:

Exception

getVersion

public String getVersion()

Returns version information

closeParser

public void closeParser()
                 throws Exception

Closes the parser

Specified by:

closeParser in interface ParserInterface

Overrides:

closeParser in class ParserImpl

Throws:

Exception - Throws exception if closing fails

flush

public void flush()

Flushes the parser's outputstream or writer

Specified by:

flush in interface ParserInterface

Overrides:

flush in class ParserImpl