com.ibm.ctc.b2b.connector

Class ApplicationConnector

java.lang.Object

com.ibm.ctc.b2b.connector.ApplicationConnector

Direct Known Subclasses:

NewQuoteRequestConnector, OrderRequestConnector, ProfileRequestConnector, PunchoutSetupRequestConnector

public abstract class ApplicationConnector
extends java.lang.Object

Abstract class for application connectors. Class defines connector flow and provides methods to be used by subclasses. Subclasses should be defined for each request type.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CLASSNAME
private static B2bRepository	config
private java.lang.String	connectorClassName
(package private) static java.lang.String	COPYRIGHT
private static org.apache.log4j.Logger	logger
private org.dom4j.Document	request
protected RequestProcessor	requestProcessor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApplicationConnector(RequestProcessor request) Retrieves the connector configuration for the request type.

Method Summary

Modifier and Type	Method and Description
protected org.dom4j.Document	connectorNotAllowed() Throws an exception.
protected org.dom4j.Document	connectorRequired() Throws an exception.
org.dom4j.Document	process() Starts the actual flow of calling the custom application logic for this request type.
protected abstract org.dom4j.Document	processWithConnector() Called when a application connector is defined for the request type.
protected abstract org.dom4j.Document	processWithoutConnector() Called when no connector is defined for the request type.
protected org.dom4j.Document	runConnector() Runs the connector defined in connectorConfig.

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

requestProcessor

protected RequestProcessor requestProcessor

request

private org.dom4j.Document request

connectorClassName

private java.lang.String connectorClassName

CLASSNAME

private static final java.lang.String CLASSNAME

logger

private static org.apache.log4j.Logger logger

config

private static B2bRepository config

Constructor Detail

ApplicationConnector

protected ApplicationConnector(RequestProcessor request)

Retrieves the connector configuration for the request type.

Parameters:

request - the incoming request

Method Detail

process

public org.dom4j.Document process()
                           throws B2bException

Starts the actual flow of calling the custom application logic for this request type. Application connector class will be called if defined in the configuration for this request type. If no application connector is defined, will process request without calling custom application connector code.

Throws:

B2bException

processWithConnector

protected abstract org.dom4j.Document processWithConnector()
                                                    throws B2bException

Called when a application connector is defined for the request type. Subclasses should make use of runConnector() or connectorNotAllowed() method for implementation.

Throws:

B2bException

runConnector

protected org.dom4j.Document runConnector()
                                   throws B2bException

Runs the connector defined in connectorConfig. Instantiates class which must implement the interface ApplicationConnectorInterface. Calls run() method on the defined connector class, and then processes the returned result. Subclasses should call this method from the processWithConnector() method if using a connctor is supported for the request type.

Throws:

B2bException

connectorNotAllowed

protected org.dom4j.Document connectorNotAllowed()
                                          throws B2bException

Throws an exception. To be used by subclasses which do not support connectors.

Throws:

B2bException

processWithoutConnector

protected abstract org.dom4j.Document processWithoutConnector()
                                                       throws B2bException

Called when no connector is defined for the request type. Subclass should build the response using configuration information, or call connectorRequired() if this is not supported.

Throws:

B2bException

connectorRequired

protected org.dom4j.Document connectorRequired()
                                        throws B2bException

Throws an exception. To be used by subclasses.

Throws:

B2bException