com.adaptris.core.sap.jco3.rfc.dynamic

Class DynamicBapiProducer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageProducerImp

com.adaptris.core.RequestReplyProducerImp

com.adaptris.core.sap.jco3.rfc.dynamic.DynamicProducer

com.adaptris.core.sap.jco3.rfc.dynamic.DynamicBapiProducer

All Implemented Interfaces:

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

@ComponentProfile(summary="Execute a SAP BAPI where the BAPI is dynamically inferred from the Document",
                  tag="producer,sap,bapi",
                  recommended={ConfiguredRfcConnection.class,DynamicRfcConnection.class})
public final class DynamicBapiProducer
extends DynamicProducer

Implementation of AdaptrisMessageProducer based on SAP JCO3 libraries.

In order to use this producer you will have previously downloaded, installed and configured SAP Java Connector. 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.

In order to use this producer you will have previously downloaded, installed and configured SAP Java Connector. 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.

The input file for this producer should be the one generated by BapiXmlGenerator which creates a sample XML document for the given BAPI. If you map your input file to the associated generated sample, then this producer instance can be used to dynamically execute the RFC without having to explicitly configure any ExportParameter or ImportParameter instances.

Note that any ProduceDestination implementation is completely ignored as everything is derived from the AdaptrisMessage object itself.

This producer type extends DynamicRfcProducer and provides the additional functionality:

• If configured, the BapiReturnParser will be used to automatically handle the RETURN export parameter, so there is no requirement to explicitly configure one.

See Also:

ConfiguredRfcConnection, RfcServiceList, DynamicRfcProducer, BapiXmlGenerator

In the adapter configuration file this class is aliased as sapjco3-dynamic-bapi-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
DynamicBapiProducer()

Method Summary

Modifier and Type	Method and Description
protected AdaptrisMessage	doRequest(AdaptrisMessage msg, ProduceDestination dest, long timeout)
BapiReturnParser	getReturnParser()
void	produce(AdaptrisMessage msg, ProduceDestination destination)
void	setReturnParser(BapiReturnParser returnParser) Set the BAPIRETURN parser implementation.

Methods inherited from class com.adaptris.core.sap.jco3.rfc.dynamic.DynamicProducer

additionalDebug, close, defaultTimeout, getAdditionalDebug, init, isEnabled, prepare, setAdditionalDebug, start, stop

Methods inherited from class com.adaptris.core.RequestReplyProducerImp

getIgnoreReplyMetadata, produce, request, request, request, request, setIgnoreReplyMetadata, shouldIgnoreReplyMetadata

Methods inherited from class com.adaptris.core.AdaptrisMessageProducerImp

getDestination, setDestination

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

createName, createQualifier, decode, encode, getEncoder, getIsConfirmation, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isConfirmation, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsConfirmation, 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, isConfirmation, isTrackingEndpoint

Constructor Detail

DynamicBapiProducer

public DynamicBapiProducer()

Method Detail

produce

public void produce(AdaptrisMessage msg,
                    ProduceDestination destination)
             throws ProduceException

Throws:

ProduceException

See Also:

(AdaptrisMessage, ProduceDestination)

doRequest

protected AdaptrisMessage doRequest(AdaptrisMessage msg,
                                    ProduceDestination dest,
                                    long timeout)
                             throws ProduceException

Specified by:

doRequest in class RequestReplyProducerImp

Throws:

ProduceException

See Also:

RequestReplyProducerImp.doRequest(com.adaptris.core.AdaptrisMessage, com.adaptris.core.ProduceDestination, long)

getReturnParser

public BapiReturnParser getReturnParser()

setReturnParser

public void setReturnParser(BapiReturnParser returnParser)

Set the BAPIRETURN parser implementation.

Parameters:

returnParser -

See Also:

AddAllToMetadata, AddBasicMetadata, AddFirstReturnToMetadata