com.adaptris.core.sap.jco3.rfc.services

Class RfcServiceList

java.lang.Object

java.util.AbstractCollection<com.adaptris.core.Service>

com.adaptris.core.ServiceCollectionImp

com.adaptris.core.ServiceListBase

com.adaptris.core.ServiceList

com.adaptris.core.sap.jco3.rfc.services.RfcServiceList

All Implemented Interfaces:

com.adaptris.core.AdaptrisComponent, com.adaptris.core.ComponentLifecycle, com.adaptris.core.ComponentLifecycleExtension, com.adaptris.core.ConfigComment, com.adaptris.core.ConnectedService, com.adaptris.core.EventHandlerAware, com.adaptris.core.JndiBindable, com.adaptris.core.licensing.LicensedComponent, com.adaptris.core.MessageEventGenerator, com.adaptris.core.Service, com.adaptris.core.ServiceCollection, com.adaptris.core.StateManagedComponent, java.lang.Iterable<com.adaptris.core.Service>, java.util.Collection<com.adaptris.core.Service>, java.util.List<com.adaptris.core.Service>

@ComponentProfile(summary="Wrap a RFC Connection for use by embedded services",
                  tag="service,sap,rfc",
                  recommended={ConfiguredRfcConnection.class,DynamicRfcConnection.class})
public class RfcServiceList
extends com.adaptris.core.ServiceList
implements com.adaptris.core.licensing.LicensedComponent, com.adaptris.core.ConnectedService

Implementation of ServiceCollection that creates a JCoDestination instance at the start of the execution of the service list and stores it in object metadata.

Other than the creation of the JCoDestination at the start of execution, all other behaviour is the same as ServiceList which this class extends.

The rationale behind this service collection implementation is to allow multiple producers that share the same underlying RFC configuration. Embedded StandaloneProducer and StandaloneRequestor implementations do not need to have RfcConnections associated with them as they will be able to use the JCoDestination from metadata. For a stateful RFC call sequence you can then configure the first and last services in this service list to be StatefulSessionStart and StatefulSessionEnd respectively. Between StatefulSessionStart and StatefulSessionEnd the same underlying connection will be used for all function calls.

See Also:

RfcConstants.OBJ_METADATA_DESTINATION_KEY, StatefulSessionStart, StatefulSessionEnd

In the adapter configuration file this class is aliased as sapjco3-rfc-service-list 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.ServiceCollectionImp

eventHandler, log

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
RfcServiceList()
RfcServiceList(java.util.Collection<com.adaptris.core.Service> serviceList)

Method Summary

Modifier and Type	Method and Description
protected void	applyServices(com.adaptris.core.AdaptrisMessage msg)
protected void	doClose()
protected void	doInit()
protected void	doStart()
protected void	doStop()
com.adaptris.core.AdaptrisConnection	getConnection()
com.adaptris.core.AdaptrisConnection	getRfcConnection() Deprecated. since 3.7.0 use getConnection() instead.
boolean	isEnabled(com.adaptris.core.licensing.License license)
void	prepare()
void	setConnection(com.adaptris.core.AdaptrisConnection c) Set the connection that will be used by all RfcProducer instances in this service list.
void	setRfcConnection(com.adaptris.core.AdaptrisConnection c) Deprecated. since 3.7.0 use setConnection(AdaptrisConnection) instead.

Methods inherited from class com.adaptris.core.ServiceList

getAllowForwardSearch, setAllowForwardSearch

Methods inherited from class com.adaptris.core.ServiceListBase

haltProcessing

Methods inherited from class com.adaptris.core.ServiceCollectionImp

add, add, addAll, addAll, addService, changeState, clear, close, continueOnFailure, createName, createQualifier, doService, enforceRequirements, enforceRequirements, get, getComments, getContinueOnFail, getIsTrackingEndpoint, getLookupName, getOutOfStateHandler, getRestartAffectedServiceOnException, getServices, getUniqueId, handleException, indexOf, init, isBranching, isTrackingEndpoint, iterator, lastIndexOf, listIterator, listIterator, registerEventHandler, remove, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, set, setComments, setContinueOnFail, setIsTrackingEndpoint, setLookupName, setOutOfStateHandler, setRestartAffectedServiceOnException, setServices, setUniqueId, size, start, stop, subList, withServices

Methods inherited from class java.util.AbstractCollection

contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.Service

continueOnFailure, doService, isBranching, setUniqueId

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Methods inherited from interface com.adaptris.core.StateManagedComponent

changeState, requestClose, requestInit, requestStart, requestStop, retrieveComponentState

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.ComponentLifecycle

close, init, start, stop

Methods inherited from interface com.adaptris.core.JndiBindable

getLookupName

Methods inherited from interface java.util.List

contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

RfcServiceList

public RfcServiceList()

RfcServiceList

public RfcServiceList(java.util.Collection<com.adaptris.core.Service> serviceList)

Method Detail

applyServices

protected void applyServices(com.adaptris.core.AdaptrisMessage msg)
                      throws com.adaptris.core.ServiceException

Overrides:

applyServices in class com.adaptris.core.ServiceList

Throws:

com.adaptris.core.ServiceException

doInit

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

Overrides:

doInit in class com.adaptris.core.ServiceList

Throws:

com.adaptris.core.CoreException

doStart

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

Overrides:

doStart in class com.adaptris.core.ServiceListBase

Throws:

com.adaptris.core.CoreException

doStop

protected void doStop()

Overrides:

doStop in class com.adaptris.core.ServiceListBase

doClose

protected void doClose()

Overrides:

doClose in class com.adaptris.core.ServiceListBase

prepare

public void prepare()
             throws com.adaptris.core.CoreException

Specified by:

prepare in interface com.adaptris.core.ComponentLifecycleExtension

Overrides:

prepare in class com.adaptris.core.ServiceCollectionImp

Throws:

com.adaptris.core.CoreException

isEnabled

public boolean isEnabled(com.adaptris.core.licensing.License license)

Specified by:

isEnabled in interface com.adaptris.core.licensing.LicensedComponent

getRfcConnection

public com.adaptris.core.AdaptrisConnection getRfcConnection()

Deprecated. since 3.7.0 use getConnection() instead.

Get the connection that will be used the underlying RfcProducer instances.

Returns:

the connection.

setRfcConnection

public void setRfcConnection(com.adaptris.core.AdaptrisConnection c)

Deprecated. since 3.7.0 use setConnection(AdaptrisConnection) instead.

Set the connection that will be used by all RfcProducer instances in this service list.

So that we can use SharedConnection, this is marked as a standard AdaptrisConnection, however you should only use a concrete RfcConnection instance or a SharedConnection.

Parameters:

c -

getConnection

public com.adaptris.core.AdaptrisConnection getConnection()

Specified by:

getConnection in interface com.adaptris.core.ConnectedService

setConnection

public void setConnection(com.adaptris.core.AdaptrisConnection c)

Set the connection that will be used by all RfcProducer instances in this service list.

So that we can use SharedConnection, this is marked as a standard AdaptrisConnection, however you should only use a concrete RfcConnection instance or a SharedConnection.

*

Specified by:

setConnection in interface com.adaptris.core.ConnectedService