nl.nn.adapterframework.extensions.sap.jco3

Class SapListenerImpl

java.lang.Object

nl.nn.adapterframework.extensions.sap.jco3.SapFunctionFacade

nl.nn.adapterframework.extensions.sap.jco3.SapListenerImpl

All Implemented Interfaces:

com.sap.conn.idoc.jco.JCoIDocHandler, com.sap.conn.idoc.jco.JCoIDocHandlerFactory, com.sap.conn.jco.server.JCoServerErrorListener, com.sap.conn.jco.server.JCoServerExceptionListener, com.sap.conn.jco.server.JCoServerFunctionHandler, com.sap.conn.jco.server.JCoServerTIDHandler, HasPhysicalDestination, IConfigurable, IConfigurationAware, IListener<com.sap.conn.jco.JCoFunction>, INamedObject, IPushingListener<com.sap.conn.jco.JCoFunction>, IScopeProvider, ISapFunctionFacade, ISapListener<com.sap.conn.jco.JCoFunction>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

SapListener, SapListener

public abstract class SapListenerImpl
extends SapFunctionFacade
implements ISapListener<com.sap.conn.jco.JCoFunction>, com.sap.conn.jco.server.JCoServerFunctionHandler, com.sap.conn.jco.server.JCoServerTIDHandler, com.sap.conn.idoc.jco.JCoIDocHandlerFactory, com.sap.conn.idoc.jco.JCoIDocHandler, com.sap.conn.jco.server.JCoServerExceptionListener, com.sap.conn.jco.server.JCoServerErrorListener

Implementation of a IPushingListener, that enables a GenericReceiver to receive messages from SAP-systems. In SAP the function to be called is a RFC-function to the destination that is registered using progid. N.B. If no requestFieldIndex or requestFieldName is specified, input is converted to xml; If no replyFieldIndex or replyFieldName is specified, output is converted from xml.

Since:

5.0

Author:

Gerrit van Brakel, Jaco de Groot

See Also:

"http://help.sap.com/saphelp_nw04/helpdata/en/09/c88442a07b0e53e10000000a155106/frameset.htm"

Field Summary

Fields inherited from class nl.nn.adapterframework.extensions.sap.jco3.SapFunctionFacade

log

Constructor Summary

Constructors

Constructor and Description
SapListenerImpl()

Method Summary

Modifier and Type	Method and Description
void	afterMessageProcessed(PipeLineResult processResult, Object rawMessageOrWrapper, Map<String,Object> threadContext) Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
boolean	checkTID(com.sap.conn.jco.server.JCoServerContext serverCtx, String tid) SAP JCo.Server javadoc says: This function will be invoked when a transactional RFC is being called from a SAP R/3 system.
void	close() Close all resources used for listening.
void	commit(com.sap.conn.jco.server.JCoServerContext serverCtx, String tid) SAP JCo.Server javadoc says: This function will be called after all RFC functions belonging to a certain transaction have been successfully completed.
void	configure() configure() is called once at startup of the framework in the configure() method of the owner of this listener.
void	confirmTID(com.sap.conn.jco.server.JCoServerContext serverCtx, String tid) SAP JCo.Server javadoc says: This function will be called after the local transaction has been completed.
Message	extractMessage(com.sap.conn.jco.JCoFunction rawMessage, Map<String,Object> threadContext) Extracts string from message obtained from IPullingListener.getRawMessage(Map).
protected String	getFunctionName() We don't use functions when receiving SAP messages
String	getIdFromRawMessage(com.sap.conn.jco.JCoFunction rawMessage, Map<String,Object> threadContext) Extracts ID-string from message obtained from IPullingListener.getRawMessage(Map).
com.sap.conn.idoc.jco.JCoIDocHandler	getIDocHandler(com.sap.conn.idoc.jco.JCoIDocServerContext serverCtx)
String	getPhysicalDestinationName()
void	handleRequest(com.sap.conn.jco.server.JCoServerContext serverCtx, com.sap.conn.idoc.IDocDocumentList documentList)
void	handleRequest(com.sap.conn.jco.server.JCoServerContext jcoServerContext, com.sap.conn.jco.JCoFunction jcoFunction)
void	open() Prepares the listener for receiving messages.
void	rollback(com.sap.conn.jco.server.JCoServerContext serverCtx, String tid) SAP JCo.Server javadoc says: This function will be called if an error in one of the RFC functions belonging to a certain transaction has occurred. Derived servers can override this method to locally rollback the transaction.
void	serverErrorOccurred(com.sap.conn.jco.server.JCoServer server, String connectionID, com.sap.conn.jco.server.JCoServerContextInfo serverCtx, Error e)
void	serverExceptionOccurred(com.sap.conn.jco.server.JCoServer server, String connectionID, com.sap.conn.jco.server.JCoServerContextInfo serverCtx, Exception e)
void	setConnectionCount(String connectionCount) The number of connections that should be registered at the gateway
void	setExceptionListener(IbisExceptionListener listener) Set a (single) listener that will be notified of any exceptions.
void	setHandler(IMessageHandler<com.sap.conn.jco.JCoFunction> handler) Set the handler that will do the processing of the message.
void	setProgid(String string) Name of the RFC-destination to be registered in the SAP system
void	setSapSystemName(String string) Name of the SapSystem used by this object

Methods inherited from class nl.nn.adapterframework.extensions.sap.jco3.SapFunctionFacade

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName, setName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface nl.nn.adapterframework.extensions.sap.ISapFunctionFacade

setCorrelationIdFieldIndex, setCorrelationIdFieldName, setReplyFieldIndex, setReplyFieldName, setRequestFieldIndex, setRequestFieldName

Methods inherited from interface nl.nn.adapterframework.core.HasPhysicalDestination

getDomain

Constructor Detail

SapListenerImpl

public SapListenerImpl()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IListener

configure() is called once at startup of the framework in the configure() method of the owner of this listener. Purpose of this method is to reduce creating connections to databases etc. in the IPullingListener.getRawMessage(Map) method. As much as possible class-instantiating should take place in the configure() or open() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IListener<com.sap.conn.jco.JCoFunction>

Overrides:

configure in class SapFunctionFacade

Throws:

ConfigurationException

open

public void open()
          throws ListenerException

Description copied from interface: IListener

Prepares the listener for receiving messages. open() is called once each time the listener is started.

Specified by:

open in interface IListener<com.sap.conn.jco.JCoFunction>

Throws:

ListenerException

close

public void close()
           throws ListenerException

Description copied from interface: IListener

Close all resources used for listening. Called once once each time the listener is stopped.

Specified by:

close in interface IListener<com.sap.conn.jco.JCoFunction>

Throws:

ListenerException

getIDocHandler

public com.sap.conn.idoc.jco.JCoIDocHandler getIDocHandler(com.sap.conn.idoc.jco.JCoIDocServerContext serverCtx)

Specified by:

getIDocHandler in interface com.sap.conn.idoc.jco.JCoIDocHandlerFactory

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

Overrides:

getPhysicalDestinationName in class SapFunctionFacade

getIdFromRawMessage

public String getIdFromRawMessage(com.sap.conn.jco.JCoFunction rawMessage,
                                  Map<String,Object> threadContext)
                           throws ListenerException

Description copied from interface: IListener

Extracts ID-string from message obtained from IPullingListener.getRawMessage(Map). May also extract other parameters from the message and put those in the context.
Common entries in the session context are:

• id: messageId, identifies the current transportation of the message
• cid: correlationId, identifies the processing of the message in the global chain
• tsReceived: timestamp of reception of the message, formatted as yyyy-MM-dd HH:mm:ss.SSS
• tsSent: timestamp of sending of the message (only when available), formatted as yyyy-MM-dd HH:mm:ss.SSS

Specified by:

getIdFromRawMessage in interface IListener<com.sap.conn.jco.JCoFunction>

Returns:

Correlation ID string.

Throws:

ListenerException

extractMessage

public Message extractMessage(com.sap.conn.jco.JCoFunction rawMessage,
                              Map<String,Object> threadContext)
                       throws ListenerException

Description copied from interface: IListener

Extracts string from message obtained from IPullingListener.getRawMessage(Map). May also extract other parameters from the message and put those in the threadContext.

Specified by:

extractMessage in interface IListener<com.sap.conn.jco.JCoFunction>

Returns:

input message for adapter.

Throws:

ListenerException

afterMessageProcessed

public void afterMessageProcessed(PipeLineResult processResult,
                                  Object rawMessageOrWrapper,
                                  Map<String,Object> threadContext)
                           throws ListenerException

Description copied from interface: IListener

Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.

Specified by:

afterMessageProcessed in interface IListener<com.sap.conn.jco.JCoFunction>

Throws:

ListenerException

handleRequest

public void handleRequest(com.sap.conn.jco.server.JCoServerContext jcoServerContext,
                          com.sap.conn.jco.JCoFunction jcoFunction)
                   throws com.sap.conn.jco.AbapException,
                          com.sap.conn.jco.AbapClassException

Specified by:

handleRequest in interface com.sap.conn.jco.server.JCoServerFunctionHandler

Throws:

com.sap.conn.jco.AbapException

com.sap.conn.jco.AbapClassException

handleRequest

public void handleRequest(com.sap.conn.jco.server.JCoServerContext serverCtx,
                          com.sap.conn.idoc.IDocDocumentList documentList)

Specified by:

handleRequest in interface com.sap.conn.idoc.jco.JCoIDocHandler

setSapSystemName

@Mandatory
public void setSapSystemName(String string)

Description copied from class: SapFunctionFacade

Name of the SapSystem used by this object

Specified by:

setSapSystemName in interface ISapFunctionFacade

Overrides:

setSapSystemName in class SapFunctionFacade

setProgid

@Mandatory
public void setProgid(String string)

Name of the RFC-destination to be registered in the SAP system

Specified by:

setProgid in interface ISapListener<com.sap.conn.jco.JCoFunction>

setConnectionCount

public void setConnectionCount(String connectionCount)

The number of connections that should be registered at the gateway

Specified by:

setConnectionCount in interface ISapListener<com.sap.conn.jco.JCoFunction>

Default value

2

setHandler

public void setHandler(IMessageHandler<com.sap.conn.jco.JCoFunction> handler)

Description copied from interface: IPushingListener

Set the handler that will do the processing of the message. Each of the received messages must be pushed through handler.processMessage()

Specified by:

setHandler in interface IPushingListener<com.sap.conn.jco.JCoFunction>

setExceptionListener

public void setExceptionListener(IbisExceptionListener listener)

Description copied from interface: IPushingListener

Set a (single) listener that will be notified of any exceptions. The listener should use this listener to notify the receiver of any exception that occurs outside the processing of a message.

Specified by:

setExceptionListener in interface IPushingListener<com.sap.conn.jco.JCoFunction>

serverExceptionOccurred

public void serverExceptionOccurred(com.sap.conn.jco.server.JCoServer server,
                                    String connectionID,
                                    com.sap.conn.jco.server.JCoServerContextInfo serverCtx,
                                    Exception e)

Specified by:

serverExceptionOccurred in interface com.sap.conn.jco.server.JCoServerExceptionListener

serverErrorOccurred

public void serverErrorOccurred(com.sap.conn.jco.server.JCoServer server,
                                String connectionID,
                                com.sap.conn.jco.server.JCoServerContextInfo serverCtx,
                                Error e)

Specified by:

serverErrorOccurred in interface com.sap.conn.jco.server.JCoServerErrorListener

checkTID

public boolean checkTID(com.sap.conn.jco.server.JCoServerContext serverCtx,
                        String tid)

SAP JCo.Server javadoc says: This function will be invoked when a transactional RFC is being called from a SAP R/3 system. The function has to store the TID in permanent storage and return true. The method has to return false if the a transaction with this ID has already been process. Throw an exception if anything goes wrong. The transaction processing will be aborted thereafter. Derived servers must override this method to actually implement the transaction ID management.

Specified by:

checkTID in interface com.sap.conn.jco.server.JCoServerTIDHandler

Parameters:

tid - the transaction ID

Returns:

true if the ID is valid and not in use otherwise, false otherwise

confirmTID

public void confirmTID(com.sap.conn.jco.server.JCoServerContext serverCtx,
                       String tid)

SAP JCo.Server javadoc says: This function will be called after the local transaction has been completed. All resources assiciated with this TID can be released. Derived servers must override this method to actually implement the transaction ID management.

Specified by:

confirmTID in interface com.sap.conn.jco.server.JCoServerTIDHandler

Parameters:

tid - the transaction ID

commit

public void commit(com.sap.conn.jco.server.JCoServerContext serverCtx,
                   String tid)

SAP JCo.Server javadoc says: This function will be called after all RFC functions belonging to a certain transaction have been successfully completed. Derived servers can override this method to locally commit the transaction.

Specified by:

commit in interface com.sap.conn.jco.server.JCoServerTIDHandler

Parameters:

tid - the transaction ID

rollback

public void rollback(com.sap.conn.jco.server.JCoServerContext serverCtx,
                     String tid)

SAP JCo.Server javadoc says: This function will be called if an error in one of the RFC functions belonging to a certain transaction has occurred. Derived servers can override this method to locally rollback the transaction.

Specified by:

rollback in interface com.sap.conn.jco.server.JCoServerTIDHandler

Parameters:

tid - the transaction ID

getFunctionName

protected String getFunctionName()

We don't use functions when receiving SAP messages

Specified by:

getFunctionName in class SapFunctionFacade