com.adaptris.core.sap.jco3.idoc

Class IdocProducer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageProducerImp

com.adaptris.core.ProduceOnlyProducerImp

com.adaptris.core.sap.jco3.idoc.IdocProducer

All Implemented Interfaces:

com.adaptris.core.AdaptrisComponent, com.adaptris.core.AdaptrisMessageProducer, com.adaptris.core.AdaptrisMessageSender, com.adaptris.core.AdaptrisMessageWorker, com.adaptris.core.ComponentLifecycle, com.adaptris.core.ComponentLifecycleExtension, com.adaptris.core.licensing.LicensedComponent, com.adaptris.core.MessageEventGenerator, IdocContext

@ComponentProfile(summary="Send an IDoc to SAP",
                  tag="producer,sap,idoc",
                  recommended=IdocConsumeConnection.class)
public class IdocProducer
extends com.adaptris.core.ProduceOnlyProducerImp
implements IdocContext, com.adaptris.core.licensing.LicensedComponent

Implementation of AdaptrisMessageProducer 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 ProduceDestination configuration is ignored. The associated connection must be a IdocProduceConnection

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

In the adapter configuration file this class is aliased as sapjco3-idoc-producer 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

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
IdocProducer()

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.
IdocFormat.Format	getIdocXmlFormat()
java.lang.String	getParsingOptions()
void	init()
boolean	isEnabled(com.adaptris.core.licensing.License license)
void	prepare()
void	produce(com.adaptris.core.AdaptrisMessage msg, com.adaptris.core.ProduceDestination destination)
void	setIdocXmlFormat(IdocFormat.Format format) Set the IDoc XML format.
void	setParsingOptions(java.lang.String options) Set the parse options.
void	start()
void	stop()

Methods inherited from class com.adaptris.core.ProduceOnlyProducerImp

produce, request, request, request, request

Methods inherited from class com.adaptris.core.AdaptrisMessageProducerImp

getDestination, setDestination

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

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.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

IdocProducer

public IdocProducer()

Method Detail

produce

public void produce(com.adaptris.core.AdaptrisMessage msg,
                    com.adaptris.core.ProduceDestination destination)
             throws com.adaptris.core.ProduceException

Specified by:

produce in interface com.adaptris.core.AdaptrisMessageSender

Throws:

com.adaptris.core.ProduceException

close

public void close()

Specified by:

close in interface com.adaptris.core.ComponentLifecycle

init

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

Specified by:

init in interface com.adaptris.core.ComponentLifecycle

Throws:

com.adaptris.core.CoreException

start

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

Specified by:

start in interface com.adaptris.core.ComponentLifecycle

Throws:

com.adaptris.core.CoreException

stop

public void stop()

Specified by:

stop in interface com.adaptris.core.ComponentLifecycle

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

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

getParsingOptions

public java.lang.String getParsingOptions()

setParsingOptions

public void setParsingOptions(java.lang.String options)

Set the parse options.

Parameters:

options - the parse options

See Also:

ParsingOptions.Option, ParsingOptions

currentConnection

public IdocConnection currentConnection()

Description copied from interface: IdocContext

Get the current connection.

Specified by:

currentConnection in interface IdocContext

Returns:

the current connection.

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