nl.nn.adapterframework.extensions.sap.jco3

Class SapFunctionFacade

java.lang.Object

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

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISapFunctionFacade, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

SapListenerImpl, SapSenderBase

public abstract class SapFunctionFacade
extends Object
implements ISapFunctionFacade

Wrapper round SAP-functions, either SAP calling Ibis, or Ibis calling SAP. N.B. If no requestFieldIndex or requestFieldName is specified, input is converted from/to xml; If no replyFieldIndex or replyFieldName is specified, output is converted from/to xml.

Since:

5.0

Author:

Gerrit van Brakel, Jaco de Groot

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.logging.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
SapFunctionFacade()

Method Summary

Modifier and Type	Method and Description
protected void	calculateStaticFieldIndices(com.sap.conn.jco.JCoFunctionTemplate ft) This method must be called from configure().
void	closeFacade()
void	configure()
protected int	findFieldIndex(com.sap.conn.jco.JCoParameterList params, int index, String name) Calculate the index of the field that corresponds with the message as a whole.
Message	functionCall2message(com.sap.conn.jco.JCoFunction function)
Message	functionResult2message(com.sap.conn.jco.JCoFunction function)
String	getCorrelationIdFromField(com.sap.conn.jco.JCoFunction function)
protected abstract String	getFunctionName() Listeners and IdocSenders don't use a functionName
protected com.sap.conn.jco.JCoFunctionTemplate	getFunctionTemplate()
protected com.sap.conn.jco.JCoFunctionTemplate	getFunctionTemplate(SapSystemImpl sapSystem, String functionName)
protected String	getLogPrefix()
String	getPhysicalDestinationName()
SapSystemImpl	getSapSystem()
SapSystemImpl	getSapSystem(String systemName)
void	message2FunctionCall(com.sap.conn.jco.JCoFunction function, String request, String correlationId, ParameterValueList pvl)
void	message2FunctionResult(com.sap.conn.jco.JCoFunction function, String result)
void	openFacade()
void	setCorrelationIdFieldIndex(int i) Index of the field in the ImportParameterList of the RFC function that contains the correlationId
void	setCorrelationIdFieldName(String string) Name of the field in the ImportParameterList of the RFC function that contains the correlationId
void	setName(String string) Name of the Ibis-object
protected static void	setParameters(com.sap.conn.jco.JCoParameterList inputOrOutputParameterList, com.sap.conn.jco.JCoParameterList tableParameterList, String message, int fieldIndex)
void	setReplyFieldIndex(int i) Index of the field in the ExportParameterList of the RFC function that contains the whole reply message contents
void	setReplyFieldName(String string) Name of the field in the ExportParameterList of the RFC function that contains the whole reply message contents
void	setRequestFieldIndex(int i) Index of the field in the ImportParameterList of the RFC function that contains the whole request message contents
void	setRequestFieldName(String string) Name of the field in the ImportParameterList of the RFC function that contains the whole request message contents
void	setSapSystemName(String string) Name of the SapSystem used by this object

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

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.core.HasPhysicalDestination

getDomain

Field Detail

log

protected static org.apache.logging.log4j.Logger log

Constructor Detail

SapFunctionFacade

public SapFunctionFacade()

Method Detail

getLogPrefix

protected String getLogPrefix()

configure

public void configure()
               throws ConfigurationException

Specified by:

configure in interface IConfigurable

Throws:

ConfigurationException

openFacade

public void openFacade()
                throws SapException

Throws:

SapException

closeFacade

public void closeFacade()

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

setParameters

protected static void setParameters(com.sap.conn.jco.JCoParameterList inputOrOutputParameterList,
                                    com.sap.conn.jco.JCoParameterList tableParameterList,
                                    String message,
                                    int fieldIndex)
                             throws SapException

Throws:

SapException

calculateStaticFieldIndices

protected void calculateStaticFieldIndices(com.sap.conn.jco.JCoFunctionTemplate ft)

This method must be called from configure().

Parameters:

ft -

findFieldIndex

protected int findFieldIndex(com.sap.conn.jco.JCoParameterList params,
                             int index,
                             String name)

Calculate the index of the field that corresponds with the message as a whole. return values >0 : the required index 0 : no index found, convert all fields to/from xml.

getCorrelationIdFromField

public String getCorrelationIdFromField(com.sap.conn.jco.JCoFunction function)

functionCall2message

public Message functionCall2message(com.sap.conn.jco.JCoFunction function)

functionResult2message

public Message functionResult2message(com.sap.conn.jco.JCoFunction function)

message2FunctionCall

public void message2FunctionCall(com.sap.conn.jco.JCoFunction function,
                                 String request,
                                 String correlationId,
                                 ParameterValueList pvl)
                          throws SapException

Throws:

SapException

message2FunctionResult

public void message2FunctionResult(com.sap.conn.jco.JCoFunction function,
                                   String result)
                            throws SapException

Throws:

SapException

getSapSystem

public SapSystemImpl getSapSystem()
                           throws SapException

Throws:

SapException

getSapSystem

public SapSystemImpl getSapSystem(String systemName)
                           throws SapException

Throws:

SapException

getFunctionTemplate

protected com.sap.conn.jco.JCoFunctionTemplate getFunctionTemplate()
                                                            throws SapException

Throws:

SapException

getFunctionTemplate

protected com.sap.conn.jco.JCoFunctionTemplate getFunctionTemplate(SapSystemImpl sapSystem,
                                                                   String functionName)
                                                            throws SapException

Throws:

SapException

setName

public void setName(String string)

Name of the Ibis-object

Specified by:

setName in interface INamedObject

setSapSystemName

public void setSapSystemName(String string)

Name of the SapSystem used by this object

Specified by:

setSapSystemName in interface ISapFunctionFacade

setCorrelationIdFieldIndex

public void setCorrelationIdFieldIndex(int i)

Index of the field in the ImportParameterList of the RFC function that contains the correlationId

Specified by:

setCorrelationIdFieldIndex in interface ISapFunctionFacade

Default value

0

setCorrelationIdFieldName

public void setCorrelationIdFieldName(String string)

Name of the field in the ImportParameterList of the RFC function that contains the correlationId

Specified by:

setCorrelationIdFieldName in interface ISapFunctionFacade

setRequestFieldIndex

public void setRequestFieldIndex(int i)

Index of the field in the ImportParameterList of the RFC function that contains the whole request message contents

Specified by:

setRequestFieldIndex in interface ISapFunctionFacade

Default value

0

setRequestFieldName

public void setRequestFieldName(String string)

Name of the field in the ImportParameterList of the RFC function that contains the whole request message contents

Specified by:

setRequestFieldName in interface ISapFunctionFacade

setReplyFieldIndex

public void setReplyFieldIndex(int i)

Index of the field in the ExportParameterList of the RFC function that contains the whole reply message contents

Specified by:

setReplyFieldIndex in interface ISapFunctionFacade

Default value

0

setReplyFieldName

public void setReplyFieldName(String string)

Name of the field in the ExportParameterList of the RFC function that contains the whole reply message contents

Specified by:

setReplyFieldName in interface ISapFunctionFacade

getFunctionName

protected abstract String getFunctionName()

Listeners and IdocSenders don't use a functionName