com.ibm.ctc.b2b.connector

Class ConnectorParameters

java.lang.Object

com.ibm.ctc.b2b.connector.ConnectorParameters

public class ConnectorParameters
extends java.lang.Object

Encapsulates the request and response.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CLASSNAME
(package private) static java.lang.String	COPYRIGHT
private static org.apache.log4j.Logger	logger
private org.dom4j.Document	requestDocument
protected ResponseDocument	responseDocument
private java.lang.String	user

Constructor Summary

Constructors

Constructor and Description
ConnectorParameters(RequestProcessor requestProcessor) Encapsulates the incoming request and a shell representing the outgoing result.

Method Summary

Modifier and Type	Method and Description
org.dom4j.Element	addOutputField(java.lang.String parentNode, java.lang.String fieldName) Creates an output node
java.lang.String	getInputField(java.lang.String fieldName) Returns the text value of the node, or the attribute value as a string.
java.util.List	getInputFieldList(java.lang.String fieldName) Returns a list of nodes with the specified name criteria
org.dom4j.Node	getOutputField(java.lang.String fieldName) Returns the first node that matches the input, or null if no matches.
java.util.List	getOutputFieldList(java.lang.String fieldName) Returns a list of nodes with the specified name criteria
java.lang.String	getUser()

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

CLASSNAME

private static final java.lang.String CLASSNAME

logger

private static org.apache.log4j.Logger logger

requestDocument

private org.dom4j.Document requestDocument

responseDocument

protected ResponseDocument responseDocument

user

private java.lang.String user

Constructor Detail

ConnectorParameters

public ConnectorParameters(RequestProcessor requestProcessor)
                    throws java.lang.Exception

Encapsulates the incoming request and a shell representing the outgoing result.

Parameters:

requestProcessor -

Throws:

java.lang.Exception - if there is an error creating the response document

Method Detail

getInputFieldList

public java.util.List getInputFieldList(java.lang.String fieldName)

Returns a list of nodes with the specified name criteria

Parameters:

fieldName - an XPath representation of the input fields to return

Returns:

List of Nodes that match the fieldName

getInputField

public java.lang.String getInputField(java.lang.String fieldName)

Returns the text value of the node, or the attribute value as a string. The first match is returned, or null if no matches.

Parameters:

fieldName - an XPath representation of the input field or parameter to return

Returns:

String representing the input field/parameter, or null if the node or attribute does not exist.

getOutputFieldList

public java.util.List getOutputFieldList(java.lang.String fieldName)

Returns a list of nodes with the specified name criteria

Parameters:

fieldName - an XPath representation of the output fields to return

Returns:

List of Nodes that match the fieldName

getOutputField

public org.dom4j.Node getOutputField(java.lang.String fieldName)

Returns the first node that matches the input, or null if no matches.

Parameters:

fieldName - an XPath representation of the input field or parameter to return

Returns:

first node match, or null if no matches

addOutputField

public org.dom4j.Element addOutputField(java.lang.String parentNode,
                                        java.lang.String fieldName)

Creates an output node

Parameters:

parentNode - Node the new node will reside within.

fieldName - Name of the new XML node.

Returns:

the node created

getUser

public java.lang.String getUser()

Returns:

User ID for backend system processing.