@ComponentProfile(summary="Send an IDoc to SAP", tag="producer,sap,idoc", recommended=IdocConsumeConnection.class) public class IdocProducer extends 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
log
CONFIRMATION_ID_KEY
Constructor and Description |
---|
IdocProducer() |
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(AdaptrisMessage msg,
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() |
produce, request, request, request, request
getDestination, setDestination
createName, createQualifier, decode, encode, getEncoder, getIsConfirmation, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isConfirmation, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsConfirmation, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
decode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactory
getUniqueId
createName, createQualifier, isConfirmation, isTrackingEndpoint
public void produce(AdaptrisMessage msg, ProduceDestination destination) throws ProduceException
produce
in interface AdaptrisMessageSender
ProduceException
public void close()
close
in interface ComponentLifecycle
public void init() throws CoreException
init
in interface ComponentLifecycle
CoreException
public void start() throws CoreException
start
in interface ComponentLifecycle
CoreException
public void stop()
stop
in interface ComponentLifecycle
public void prepare() throws CoreException
prepare
in interface ComponentLifecycleExtension
CoreException
public boolean isEnabled(com.adaptris.core.licensing.License license)
isEnabled
in interface com.adaptris.core.licensing.LicensedComponent
public IdocFormat.Format getIdocXmlFormat()
public void setIdocXmlFormat(IdocFormat.Format format)
format
- the IDoc XML FormatIdocFormat.Format
public java.lang.String getParsingOptions()
public void setParsingOptions(java.lang.String options)
options
- the parse optionsParsingOptions.Option
,
ParsingOptions
public IdocConnection currentConnection()
IdocContext
currentConnection
in interface IdocContext
public IdocFormat.Format configuredIdocXmlFormat()
IdocContext
configuredIdocXmlFormat
in interface IdocContext
IdocFormat.Format
public java.lang.String configuredOptions()
IdocContext
configuredOptions
in interface IdocContext
ParsingOptions
,
RenderingOptions
Copyright Adaptris