@ComponentProfile(summary="Send an IDoc to SAP", tag="producer,sap,idoc", recommended=IdocProduceConnection.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
Constructor and Description |
---|
IdocProducer() |
Modifier and Type | Method and Description |
---|---|
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.
|
protected void |
doProduce(com.adaptris.core.AdaptrisMessage msg,
java.lang.String endpoint) |
java.lang.String |
endpoint(com.adaptris.core.AdaptrisMessage msg) |
com.adaptris.core.ProduceDestination |
getDestination() |
IdocFormat.Format |
getIdocXmlFormat() |
java.lang.String |
getParsingOptions() |
void |
init() |
boolean |
isEnabled(com.adaptris.core.licensing.License license) |
void |
prepare() |
void |
setDestination(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.
|
produce, produce, request, request, request, request
createQualifier, decode, encode, getEncoder, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory, withUniqueID
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
protected void doProduce(com.adaptris.core.AdaptrisMessage msg, java.lang.String endpoint) throws com.adaptris.core.ProduceException
doProduce
in class com.adaptris.core.ProduceOnlyProducerImp
com.adaptris.core.ProduceException
public void init() throws com.adaptris.core.CoreException
init
in interface com.adaptris.core.ComponentLifecycle
com.adaptris.core.CoreException
public void prepare() throws com.adaptris.core.CoreException
prepare
in interface com.adaptris.core.ComponentLifecycleExtension
com.adaptris.core.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
public com.adaptris.core.ProduceDestination getDestination()
public void setDestination(com.adaptris.core.ProduceDestination destination)
public java.lang.String endpoint(com.adaptris.core.AdaptrisMessage msg) throws com.adaptris.core.ProduceException
endpoint
in class com.adaptris.core.AdaptrisMessageProducerImp
com.adaptris.core.ProduceException
Copyright Adaptris