com.mulesoft.mule.transport.sap.jco3

Class SapJcoClient

java.lang.Object

com.mulesoft.mule.transport.sap.jco3.SapJcoClient

Direct Known Subclasses:

SapJcoDefaultConnectionClient

public abstract class SapJcoClient
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Constructor and Description
SapJcoClient()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	beginTransaction(SapJcoSession session)
abstract void	commit(SapJcoSession session)
SapJcoSession	createSession(SapType type, String queueName, boolean evaluateFunctionResponse, String jcoUser, boolean bapiTransaction)
abstract SapObject	dispatch(SapObject object, SapJcoSession session)
abstract void	doDispose() Disposes the JCO Adapter connection
abstract void	doInitialise(String name, Properties properties) Initialises the JCO Adapter connection
abstract void	doReInitialise(String newPassword) Changes the password used in the connection.
abstract Properties	getDestinationProperties()
abstract com.sap.conn.jco.JCoFunction	getFunction(String functionName)
abstract com.sap.conn.idoc.IDocDocument	getIDocDocument(IDocId iDocId)
abstract com.sap.conn.idoc.IDocDocumentList	getIDocDocumentList(InputStream xmlIDocDocumentList)
abstract IDocMetadata	getIDocMetadata(IDocId iDocId)
String	getKey()
abstract String	getName()
boolean	isDisableFunctionTemplateCache()
boolean	isSamePassword(String password)
abstract void	rollback(SapJcoSession session)
abstract List<SapObjectDescriptor>	searchFunctions(String filter)
abstract List<SapObjectDescriptor>	searchIDocTypes(String filter)
void	setDisableFunctionTemplateCache(boolean disableFunctionTemplateCache)
void	setKey(String key)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

SapJcoClient

public SapJcoClient()

Method Detail

doInitialise

public abstract void doInitialise(String name,
                Properties properties)
                           throws Exception

Initialises the JCO Adapter connection

Parameters:

name - Name or id of the connection. Used as JCO destination name.

properties - Connection properties

Throws:

Exception

doReInitialise

public abstract void doReInitialise(String newPassword)
                             throws Exception

Changes the password used in the connection. Calling this method will re-initialise the client.

Parameters:

newPassword -

Throws:

Exception

doDispose

public abstract void doDispose()
                        throws Exception

Disposes the JCO Adapter connection

Throws:

Exception

dispatch

public abstract SapObject dispatch(SapObject object,
                 SapJcoSession session)
                            throws Exception

Throws:

Exception

getFunction

public abstract com.sap.conn.jco.JCoFunction getFunction(String functionName)
                                                  throws Exception

Throws:

Exception

getIDocDocumentList

public abstract com.sap.conn.idoc.IDocDocumentList getIDocDocumentList(InputStream xmlIDocDocumentList)
                                                                throws Exception

Throws:

Exception

getIDocDocument

public abstract com.sap.conn.idoc.IDocDocument getIDocDocument(IDocId iDocId)
                                                        throws Exception

Throws:

Exception

getIDocMetadata

public abstract IDocMetadata getIDocMetadata(IDocId iDocId)
                                      throws Exception

Throws:

Exception

getName

public abstract String getName()

isSamePassword

public boolean isSamePassword(String password)
                       throws Exception

Throws:

Exception

createSession

public SapJcoSession createSession(SapType type,
                          String queueName,
                          boolean evaluateFunctionResponse,
                          String jcoUser,
                          boolean bapiTransaction)

beginTransaction

public abstract void beginTransaction(SapJcoSession session)
                               throws Exception

Parameters:

transactional - Whether is just a stateful transaction or a transactional one (tRFC).

Throws:

Exception

commit

public abstract void commit(SapJcoSession session)
                     throws Exception

Throws:

Exception

rollback

public abstract void rollback(SapJcoSession session)
                       throws Exception

Throws:

Exception

getDestinationProperties

public abstract Properties getDestinationProperties()
                                             throws Exception

Throws:

Exception

isDisableFunctionTemplateCache

public boolean isDisableFunctionTemplateCache()

setDisableFunctionTemplateCache

public void setDisableFunctionTemplateCache(boolean disableFunctionTemplateCache)

getKey

public String getKey()

setKey

public void setKey(String key)

searchFunctions

public abstract List<SapObjectDescriptor> searchFunctions(String filter)
                                                   throws Exception

Throws:

Exception

searchIDocTypes

public abstract List<SapObjectDescriptor> searchIDocTypes(String filter)
                                                   throws Exception

Throws:

Exception