com.adaptris.core.sap.jco3.idoc

Class IdocConsumeConnection

java.lang.Object

com.adaptris.core.AdaptrisConnectionImp

com.adaptris.core.sap.jco3.JcoConnectionBase

com.adaptris.core.sap.jco3.JcoConnection

com.adaptris.core.sap.jco3.idoc.IdocConnection

com.adaptris.core.sap.jco3.idoc.IdocConsumeConnection

All Implemented Interfaces:

com.adaptris.core.AdaptrisComponent, com.adaptris.core.AdaptrisConnection, com.adaptris.core.ComponentLifecycle, com.adaptris.core.ComponentLifecycleExtension, com.adaptris.core.JndiBindable, com.adaptris.core.licensing.LicensedComponent, com.adaptris.core.StateManagedComponent

@ComponentProfile(summary="Connection type for supporting SAP JCO3 IDOC consumers",
                  tag="connections,sap,idoc")
public class IdocConsumeConnection
extends IdocConnection

Class for managing connections when receiving IDocs from SAP via ALE.

This class indirectly provides a com.sap.conn.jco.ext.ServerDataProvider for the underlying connection. Due to the nature of the SAP JCO libraries, for each Channel containing an IdocConsumeConnection should only have a single Workflow within that channel. This avoids having multiple listeners registered with the same programid.

In addition to the standard connection properties which are documented in IdocProduceConnection there are additional server properties which determine how the adapter registers itself as a program against SAP.

In the adapter configuration file this class is aliased as sapjco3-idoc-consume-connection which is the preferred alternative to the fully qualified classname when building your configuration.

License Required: ENTERPRISE

Field Summary

Fields inherited from class com.adaptris.core.sap.jco3.JcoConnection

guid

Fields inherited from class com.adaptris.core.AdaptrisConnectionImp

log

Constructor Summary

Constructors

Constructor and Description
IdocConsumeConnection()

Method Summary

Modifier and Type	Method and Description
protected void	closeConnection()
void	doHouseKeeping() Do any trace file housekeeping.
ProviderInfo	getServerProviderInfo()
protected void	initConnection()
void	setServerProviderInfo(ProviderInfo info) Set the server properties.

Methods inherited from class com.adaptris.core.sap.jco3.idoc.IdocConnection

getTransactionIdRepository, setTransactionIdRepository

Methods inherited from class com.adaptris.core.sap.jco3.JcoConnection

getDestinationProviderInfo, setDestinationProviderInfo, startConnection, stopConnection

Methods inherited from class com.adaptris.core.sap.jco3.JcoConnectionBase

getTraceFileHandler, isEnabled, prepareConnection, safeName, setTraceFileHandler

Methods inherited from class com.adaptris.core.AdaptrisConnectionImp

addExceptionListener, addMessageConsumer, addMessageProducer, changeState, cloneForTesting, close, connectionErrorHandler, getConnectionErrorHandler, getLookupName, getUniqueId, getWorkersFirstOnShutdown, init, prepare, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, retrieveConnection, retrieveExceptionListeners, retrieveMessageConsumers, retrieveMessageProducers, setConnectionErrorHandler, setLookupName, setUniqueId, setWorkersFirstOnShutdown, start, stop, workersFirstOnShutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

IdocConsumeConnection

public IdocConsumeConnection()

Method Detail

initConnection

protected void initConnection()
                       throws com.adaptris.core.CoreException

Overrides:

initConnection in class JcoConnection

Throws:

com.adaptris.core.CoreException

closeConnection

protected void closeConnection()

Overrides:

closeConnection in class JcoConnection

setServerProviderInfo

public void setServerProviderInfo(ProviderInfo info)

Set the server properties.

The following table is copied directly from the SAP Java Connector API documentation. Please use the appropriate settings for your SAP application landscape; no verification is performed on the properties.

The following properties are supported:

Key value	Description
jco.server.gwhost	Gateway host on which the server should be registered
jco.server.gwserv	Gateway service, i.e. the port on which a registration can be done
jco.server.progid	The program ID with which the registration is done
jco.server.trace	Enable/disable RFC trace (0 or 1)
jco.server.saprouter	SAP router string to use for a system protected by a firewall
jco.server.max_startup_delay	The maximum time (in seconds) between two startup attempts in case of failures
jco.server.repository_destination	Client destination from which to obtain the repository
jco.server.connection_count	The number of connections that should be registered at the gateway
jco.server.snc_mode	Secure network connection (SNC) mode, 0 (off) or 1 (on)
jco.server.snc_qop	SNC level of security, 1 to 9
jco.server.snc_myname	SNC name of your server. Overrides the default SNC name. Typically something like p:CN=JCoServer, O=ACompany, C=EN
jco.server.snc_lib	Path to library which provides SNC service.

Parameters:

info - the server properties.

getServerProviderInfo

public ProviderInfo getServerProviderInfo()

doHouseKeeping

public void doHouseKeeping()

Description copied from class: JcoConnectionBase

Do any trace file housekeeping.

Overrides:

doHouseKeeping in class JcoConnection