Class IdocSenderImpl

java.lang.Object

org.frankframework.extensions.sap.jco3.SapFunctionFacade

org.frankframework.extensions.sap.jco3.SapSenderBase

org.frankframework.extensions.sap.jco3.IdocSenderImpl

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, NameAware, ISapFunctionFacade, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

IdocSender, IdocSender

public abstract class IdocSenderImpl
extends SapSenderBase

Implementation of sender that sends an IDoc to SAP. N.B. The sending of the iDoc is committed right after the XA transaction is completed.

Since:

5.0

Author:

Gerrit van Brakel, Jaco de Groot

Field Summary

Fields inherited from class SapSenderBase

paramList

Fields inherited from class SapFunctionFacade

log

Constructor Summary

Constructors

Constructor	Description
IdocSenderImpl()

Method Summary

Modifier and Type	Method	Description
protected String	getFunctionName()	Listeners and IdocSenders don't use a functionName
com.sap.conn.idoc.IDocDocument	parseIdoc(SapSystemImpl sapSystem, Message message)
@NonNull SenderResult	sendMessage(@NonNull Message message, @NonNull PipeLineSession session)	Send a message to some destination (as configured in the Sender object).

Methods inherited from class SapSenderBase

addParameter, configure, getDestination, getParameterList, getSystem, getTid, setLuwHandleSessionKey, setSapSystemNameParam, setSynchronous, start, stop

Methods inherited from class SapFunctionFacade

calculateStaticFieldIndices, closeFacade, findFieldIndex, functionCall2message, functionResult2message, getCorrelationIdFromField, getFunctionTemplate, getFunctionTemplate, getLogPrefix, getPhysicalDestinationName, getSapSystem, getSapSystem, message2FunctionCall, message2FunctionResult, openFacade, setCorrelationIdFieldIndex, setCorrelationIdFieldName, setName, setParameters, setReplyFieldIndex, setReplyFieldName, setRequestFieldIndex, setRequestFieldName, setSapSystemName

Methods inherited from class Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Methods inherited from interface ISender

isSynchronous, sendMessageOrThrow

Methods inherited from interface ISenderWithParameters

consumesSessionVariable

Methods inherited from interface NameAware

setName

Constructor Details

IdocSenderImpl

public IdocSenderImpl()

Method Details

parseIdoc

public com.sap.conn.idoc.IDocDocument parseIdoc(SapSystemImpl sapSystem,
 Message message)
                                         throws SenderException

Throws:

SenderException

sendMessage

public @NonNull SenderResult sendMessage(@NonNull Message message,
 @NonNull PipeLineSession session)
                                  throws SenderException,
TimeoutException

Description copied from interface: ISender

Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

The following table shows the difference between synchronous and a-synchronous senders:

	synchronous	a-synchronous
ISender.isSynchronous() returns	true	false
return value of sendMessage() is	the reply-message	the messageId of the message sent
the correlationID specified with sendMessage()	may be ignored	is sent with the message
a {link TimeOutException}	may be thrown if a timeout occurs waiting for a reply	should not be expected

Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Throws:

SenderException

TimeoutException

getFunctionName

protected String getFunctionName()

Description copied from class: SapFunctionFacade

Listeners and IdocSenders don't use a functionName

Specified by:

getFunctionName in class SapFunctionFacade