com.eibus.soap

Class ApplicationConnector

java.lang.Object

com.eibus.soap.ApplicationConnector

Direct Known Subclasses:

BsfConnector

public abstract class ApplicationConnector
extends java.lang.Object

Extend from this class to make a custom Application Connector.

See Also:

Processor, ApplicationTransaction, SOAPTransaction

Field Summary

Fields

Modifier and Type	Field and Description
protected Processor	processor

Constructor Summary

Constructors

Constructor and Description
ApplicationConnector()

Method Summary

Modifier and Type	Method and Description
void	close(Processor processor) Method is called by the Processor after the connection to the Cordys ESB is closed.
protected IManagedComponent	createManagedComponent() Create a managed component for this application connector, using the processor as parent component.
ApplicationTransaction	createTransaction(Request request) Deprecated. Implement the method createTransaction(SOAPTransaction) instead.
int	getConfiguration() Returns the XML node that is supposed to contain the configuration information of this ApplicationConnector.
static ApplicationConnector	getInstance(java.lang.String serviceClassName)
protected IManagedComponent	getManagedComponent() Create a managed component for this application connector, using the processor as parent component.
protected java.lang.String	getManagedComponentType() Returns the type of this managed component.
protected ILocalizableString	getManagementDescription() Returns the description of this application connector, suitable for usage in a management tool.
protected java.lang.String	getManagementName() Returns the name of this application connector, suitable for usage in a management tool.
Processor	getProcessor() Returns the workerprocess in which this ApplicationConnector is running.
protected boolean	handleMustUnderstandHeaderEntries(int[] headerEntryNodes, MustUnderstandFault faultHandler) Override this method to handle header entries with SOAP's mustUnderstand attribute set to value '1'.
void	open(Processor processor) Method is called by the Processor just after the connection to the Cordys ESB is opened.
protected boolean	readyForDocPerThread() Overload this method to not that your applicationconnector is optimized for using multiple nom documents iso only one per Connector.
void	reset(Processor processor) Method is called by the Processor when a reset request comes.
void	setConfiguration(int node) Sets the configuration node as it is defined in LDAP.

Methods inherited from class java.lang.Object

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

Field Detail

processor

protected Processor processor

Constructor Detail

ApplicationConnector

public ApplicationConnector()

Method Detail

getInstance

public static final ApplicationConnector getInstance(java.lang.String serviceClassName)
                                              throws java.lang.reflect.InvocationTargetException,
                                                     java.lang.ClassNotFoundException,
                                                     java.lang.NoSuchMethodException,
                                                     java.lang.InstantiationException,
                                                     java.lang.IllegalAccessException

Throws:

java.lang.reflect.InvocationTargetException

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.IllegalAccessException

createTransaction

@Deprecated
public ApplicationTransaction createTransaction(Request request)

Deprecated. Implement the method createTransaction(SOAPTransaction) instead.

getProcessor

public final Processor getProcessor()

Returns the workerprocess in which this ApplicationConnector is running.

setConfiguration

public final void setConfiguration(int node)

Sets the configuration node as it is defined in LDAP. XML Mappers can store their configuration information in the LDAP server as an XML document. When the Processor that loads this ApplicationConnector is retrieving its configuration information from the LDAP server, it will load the XML document and set it as a parameter in the XML Mapper, prior to opening the ApplicationConnector. With the getConfiguration() method, the node can be retrieved and used to configure the ApplicationConnector. This method is public in order for other Java objects to call it as well (in case they instantiate a Processor and load its XMLMappers programmatically).

Parameters:

node - The configuration node.

getConfiguration

public final int getConfiguration()

Returns the XML node that is supposed to contain the configuration information of this ApplicationConnector. Usually, this node is retrieved from the information in the LDAP server and set by the Processor in which this ApplicationConnector is running.

Returns:

Duplicate of an XML node containing the configuration information is returned. It is the responsibility of the application invoking this method must delete the node.

open

public void open(Processor processor)

Method is called by the Processor just after the connection to the Cordys ESB is opened. The default implementation is empty. Messages are queued up until all application connectors are opened.

Parameters:

processor - the Processor in which this ApplicationConnector is started

close

public void close(Processor processor)

Method is called by the Processor after the connection to the Cordys ESB is closed. The default implementation is empty.

Parameters:

processor - the Processor in which this ApplicationConnector was running

reset

public void reset(Processor processor)

Method is called by the Processor when a reset request comes. The default implementation is empty.

Parameters:

processor - the Processor in which this ApplicationConnector was running

readyForDocPerThread

protected boolean readyForDocPerThread()

Overload this method to not that your applicationconnector is optimized for using multiple nom documents iso only one per Connector.

Returns:

false

getManagementName

protected java.lang.String getManagementName()

Returns the name of this application connector, suitable for usage in a management tool. The default implementation returns the simple class name. Sub-classes are supposed to give a more user friendly name.

Returns:

the name of this application connector, suitable for usage in a management tool.

getManagementDescription

protected ILocalizableString getManagementDescription()

Returns the description of this application connector, suitable for usage in a management tool. The default implementation returns a description based on the full class name. Sub-classes are supposed to give a more user friendly description.

Returns:

the name of this application connector, suitable for usage in a management tool.

getManagedComponentType

protected java.lang.String getManagedComponentType()

Returns the type of this managed component. By default, AppConnector is returned. Application connectors that add settings, counters or sub-components should overwrite this method and return a specific managed component type.

Returns:

the type of this application connector.

createManagedComponent

protected IManagedComponent createManagedComponent()

Create a managed component for this application connector, using the processor as parent component.

handleMustUnderstandHeaderEntries

protected boolean handleMustUnderstandHeaderEntries(int[] headerEntryNodes,
                                                    MustUnderstandFault faultHandler)

Override this method to handle header entries with SOAP's mustUnderstand attribute set to value '1'. The default return value of this method is false, this enforces the Application connector to implement handling of the header entries.
NOTE: Do not delete the passed XML Nodes, the framework will delete it as it is part of the request.

Parameters:

headerEntryNodes - a list of headerEntryNodes that has mustUnderstand Attribute value set to 1

faultHandler - A handler that allows the application create SOAP Fault.

Returns:

Return true if the application can process the header entries, false otherwise.

getManagedComponent

protected IManagedComponent getManagedComponent()

Create a managed component for this application connector, using the processor as parent component.