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)
org.springframework.context.ApplicationContext	getApplicationContext()
ClassLoader	getConfigurationClassLoader()
int	getCorrelationIdFieldIndex()
String	getCorrelationIdFieldName()
String	getCorrelationIdFromField(com.sap.conn.jco.JCoFunction function)
String	getDomain()
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	getName()
String	getPhysicalDestinationName()
int	getReplyFieldIndex()
String	getReplyFieldName()
int	getRequestFieldIndex()
String	getRequestFieldName()
SapSystemImpl	getSapSystem()
SapSystemImpl	getSapSystem(String systemName)
String	getSapSystemName()
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	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setCorrelationIdFieldIndex(int i)
void	setCorrelationIdFieldName(String string)
void	setName(String string)
protected static void	setParameters(com.sap.conn.jco.JCoParameterList inputOrOutputParameterList, com.sap.conn.jco.JCoParameterList tableParameterList, String message, int fieldIndex)
void	setReplyFieldIndex(int i)
void	setReplyFieldName(String string)
void	setRequestFieldIndex(int i)
void	setRequestFieldName(String string)
void	setSapSystemName(String string)

Methods inherited from class java.lang.Object

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

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

@IbisDoc(value={"1","Name of the Ibis-object",""})
public void setName(String string)

Specified by:

setName in interface INamedObject

setSapSystemName

@IbisDoc(value={"2","name of the {@link SapSystem} used by this object",""})
public void setSapSystemName(String string)

Specified by:

setSapSystemName in interface ISapFunctionFacade

setCorrelationIdFieldIndex

@IbisDoc(value={"3","Index of the field in the ImportParameterList of the RFC function that contains the correlationId","0"})
public void setCorrelationIdFieldIndex(int i)

Specified by:

setCorrelationIdFieldIndex in interface ISapFunctionFacade

setCorrelationIdFieldName

@IbisDoc(value={"4","Name of the field in the ImportParameterList of the RFC function that contains the correlationId",""})
public void setCorrelationIdFieldName(String string)

Specified by:

setCorrelationIdFieldName in interface ISapFunctionFacade

setRequestFieldIndex

@IbisDoc(value={"5","Index of the field in the ImportParameterList of the RFC function that contains the whole request message contents","0"})
public void setRequestFieldIndex(int i)

Specified by:

setRequestFieldIndex in interface ISapFunctionFacade

setRequestFieldName

@IbisDoc(value={"6","Name of the field in the ImportParameterList of the RFC function that contains the whole request message contents",""})
public void setRequestFieldName(String string)

Specified by:

setRequestFieldName in interface ISapFunctionFacade

setReplyFieldIndex

@IbisDoc(value={"7","Index of the field in the ExportParameterList of the RFC function that contains the whole reply message contents","0"})
public void setReplyFieldIndex(int i)

Specified by:

setReplyFieldIndex in interface ISapFunctionFacade

setReplyFieldName

@IbisDoc(value={"8","Name of the field in the ExportParameterList of the RFC function that contains the whole reply message contents",""})
public void setReplyFieldName(String string)

Specified by:

setReplyFieldName in interface ISapFunctionFacade

getFunctionName

protected abstract String getFunctionName()

Listeners and IdocSenders don't use a functionName

getDomain

public String getDomain()

Specified by:

getDomain in interface HasPhysicalDestination

getConfigurationClassLoader

public ClassLoader getConfigurationClassLoader()

Specified by:

getConfigurationClassLoader in interface IScopeProvider

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

Specified by:

getApplicationContext in interface IConfigurationAware

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

getName

public String getName()

Specified by:

getName in interface IConfigurationAware

Specified by:

getName in interface INamedObject

getSapSystemName

public String getSapSystemName()

getCorrelationIdFieldIndex

public int getCorrelationIdFieldIndex()

getCorrelationIdFieldName

public String getCorrelationIdFieldName()

getRequestFieldIndex

public int getRequestFieldIndex()

getRequestFieldName

public String getRequestFieldName()

getReplyFieldIndex

public int getReplyFieldIndex()

getReplyFieldName

public String getReplyFieldName()