com.adaptris.core.sap.jco3.idoc

Class IdocConsumer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageConsumerImp

com.adaptris.core.sap.jco3.idoc.IdocConsumer

All Implemented Interfaces:

com.adaptris.core.AdaptrisComponent, com.adaptris.core.AdaptrisMessageConsumer, com.adaptris.core.AdaptrisMessageWorker, com.adaptris.core.ComponentLifecycle, com.adaptris.core.ComponentLifecycleExtension, com.adaptris.core.licensing.LicensedComponent, com.adaptris.core.MessageEventGenerator, IdocContext, com.adaptris.core.StateManagedComponent

@ComponentProfile(summary="Receive an IDoc from SAP",
                  tag="consumer,sap,idoc",
                  recommended=IdocConsumeConnection.class)
public class IdocConsumer
extends com.adaptris.core.AdaptrisMessageConsumerImp
implements IdocContext, com.adaptris.core.licensing.LicensedComponent

Implementation of AdaptrisMessageConsumer based on SAP JCO libraries.

In order to use these classes you will have previously downloaded, installed and configured SAP Java Connector and SAP Java Connector IDoc Class Library. The jar files should be copied into the adapter's lib directory, but any native libraries should be configured as per the SAP Java Connector documentation.

Note that because of the nature of the SAP libraries, all ConsumeDestination configuration is ignored.

Note : The classes here were compiled against SAP Java Connector3 3.0.3, SAP IDoc Class Library 3.0.1 They will not work with SAP Java Connector 2.x and SAP Java Connector IDoc Class Library 1.x

• The connection associated with this Consumer must be IdocConnection
• Only provides minimal TransactionId support, in that the JCoIDocServer functions of checkTID and confirmTID are implemented only. Calls to onCommit and onRollback are ignored, but logged. checkTID returns true only if the TID supplied by SAP is not in the configured transaction id repository

In the adapter configuration file this class is aliased as sapjco3-idoc-consumer which is the preferred alternative to the fully qualified classname when building your configuration.

License Required: ENTERPRISE

Field Summary

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Constructor Summary

Constructors

Constructor and Description
IdocConsumer() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	close()
IdocFormat.Format	configuredIdocXmlFormat() Get the IDoc XML Format that will be used to parsing or rendering.
java.lang.String	configuredOptions() Get the options for parsing or rendering the IDoc.
IdocConnection	currentConnection() Get the current connection.
com.adaptris.core.ConsumeDestination	getDestination()
IdocFormat.Format	getIdocXmlFormat()
java.lang.String	getRenderingOptions()
com.adaptris.core.sap.jco3.idoc.ConsumerAgent	getServer()
void	init()
boolean	isEnabled(com.adaptris.core.licensing.License license)
protected java.lang.String	newThreadName()
void	prepare()
java.lang.String	renameThread()
void	setDestination(com.adaptris.core.ConsumeDestination destination)
void	setIdocXmlFormat(IdocFormat.Format format) Set the IDoc XML format.
void	setRenderingOptions(java.lang.String options) Set the rendering options.
void	setServer(com.adaptris.core.sap.jco3.idoc.ConsumerAgent server)
void	start()
void	stop()

Methods inherited from class com.adaptris.core.AdaptrisMessageConsumerImp

changeState, registerAdaptrisMessageListener, requestClose, requestInit, requestStart, requestStop, retrieveAdaptrisMessageListener, retrieveComponentState

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

createName, createQualifier, decode, encode, getEncoder, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory, withUniqueID

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.AdaptrisMessageConsumer

consumeLocationKey

Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker

decode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactory

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Constructor Detail

IdocConsumer

public IdocConsumer()

Default constructor. Defaults are:

• splitIdocs = true

Method Detail

init

public void init()
          throws com.adaptris.core.CoreException

Specified by:

init in interface com.adaptris.core.ComponentLifecycle

Throws:

com.adaptris.core.CoreException

See Also:

ComponentLifecycle.init()

prepare

public void prepare()
             throws com.adaptris.core.CoreException

Specified by:

prepare in interface com.adaptris.core.ComponentLifecycleExtension

Throws:

com.adaptris.core.CoreException

isEnabled

public boolean isEnabled(com.adaptris.core.licensing.License license)

Specified by:

isEnabled in interface com.adaptris.core.licensing.LicensedComponent

start

public void start()
           throws com.adaptris.core.CoreException

Specified by:

start in interface com.adaptris.core.ComponentLifecycle

Throws:

com.adaptris.core.CoreException

See Also:

ComponentLifecycle.start()

stop

public void stop()

Specified by:

stop in interface com.adaptris.core.ComponentLifecycle

See Also:

ComponentLifecycle.stop()

close

public void close()

Specified by:

close in interface com.adaptris.core.ComponentLifecycle

See Also:

ComponentLifecycle.close()

renameThread

public java.lang.String renameThread()

Overrides:

renameThread in class com.adaptris.core.AdaptrisMessageConsumerImp

getIdocXmlFormat

public IdocFormat.Format getIdocXmlFormat()

setIdocXmlFormat

public void setIdocXmlFormat(IdocFormat.Format format)

Set the IDoc XML format.

Parameters:

format - the IDoc XML Format

See Also:

IdocFormat.Format

getRenderingOptions

public java.lang.String getRenderingOptions()

setRenderingOptions

public void setRenderingOptions(java.lang.String options)

Set the rendering options.

Parameters:

options - the rendering options

See Also:

RenderingOptions, RenderingOptions.Option

configuredIdocXmlFormat

public IdocFormat.Format configuredIdocXmlFormat()

Description copied from interface: IdocContext

Get the IDoc XML Format that will be used to parsing or rendering.

Specified by:

configuredIdocXmlFormat in interface IdocContext

Returns:

the format.

See Also:

IdocFormat.Format

configuredOptions

public java.lang.String configuredOptions()

Description copied from interface: IdocContext

Get the options for parsing or rendering the IDoc.

Specified by:

configuredOptions in interface IdocContext

Returns:

the options.

See Also:

ParsingOptions, RenderingOptions

currentConnection

public IdocConnection currentConnection()

Description copied from interface: IdocContext

Get the current connection.

Specified by:

currentConnection in interface IdocContext

Returns:

the current connection.

getServer

public com.adaptris.core.sap.jco3.idoc.ConsumerAgent getServer()

setServer

public void setServer(com.adaptris.core.sap.jco3.idoc.ConsumerAgent server)

newThreadName

protected java.lang.String newThreadName()

Specified by:

newThreadName in class com.adaptris.core.AdaptrisMessageConsumerImp

getDestination

public com.adaptris.core.ConsumeDestination getDestination()

setDestination

public void setDestination(com.adaptris.core.ConsumeDestination destination)