com.adaptris.core.sap.jco3.rfc.dynamic

Class RfcXmlGenerator

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.licensing.LicensedService

com.adaptris.core.sap.jco3.rfc.dynamic.RfcXmlGenerator

All Implemented Interfaces:

com.adaptris.core.AdaptrisComponent, com.adaptris.core.ComponentLifecycle, com.adaptris.core.ComponentLifecycleExtension, com.adaptris.core.ConnectedService, com.adaptris.core.JndiBindable, com.adaptris.core.licensing.LicensedComponent, com.adaptris.core.MessageEventGenerator, com.adaptris.core.Service, com.adaptris.core.StateManagedComponent

Direct Known Subclasses:

BapiXmlGenerator

@ComponentProfile(summary="Helper that generates an XML input file for a SAP RFC",
                  tag="service,sap,rfc",
                  recommended={ConfiguredRfcConnection.class,DynamicRfcConnection.class})
public class RfcXmlGenerator
extends com.adaptris.core.licensing.LicensedService
implements com.adaptris.core.ConnectedService

Service implementation that generates an XML input file sample for a RFC.

This service determines the RFC to invoke based on the the xpath local-name(/*). After querying the configured repository, it generates a sample document that contains all the elements required to execute a RFC. If you map your input file to the generated example, then it will be possible to use DynamicBapiProducer or DynamicRfcProducer as your producer without explicitly configuring any ExportParameter or ImportParameter instances.

• Input parameters will always be a child of the [RFC_NAME]/INPUT element
• Output parameters will always be a child of the [RFC_NAME]/OUTPUT element
• Table parameters will be a child of the [RFC_NAME]/INPUT/TABLES element and also the [RFC_NAME]/OUTPUT/TABLES element as tables could form both a an input and output parameter; how you can have multiple rows for a table parameter should be obvious from the resulting XML.
• CHANGING parameters are not currently supported.
• Every element has attribute information for mapping and informational purposes; it is redundant at runtime

In the adapter configuration file this class is aliased as sapjco3-rfc-xml-generator 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.ServiceImp

log

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
RfcXmlGenerator()

Method Summary

Modifier and Type	Method and Description
protected void	closeService()
void	doService(com.adaptris.core.AdaptrisMessage msg)
com.adaptris.core.AdaptrisConnection	getConnection()
protected void	initService()
boolean	isEnabled(com.adaptris.core.licensing.License license)
protected void	prepareService()
void	setConnection(com.adaptris.core.AdaptrisConnection connection) Set the connection used to connect to SAP.
void	start()
void	stop()

Methods inherited from class com.adaptris.core.licensing.LicensedService

prepare

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getLookupName, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, setLookupName, setUniqueId

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.Service

continueOnFailure, 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

Methods inherited from interface com.adaptris.core.ComponentLifecycleExtension

prepare

Methods inherited from interface com.adaptris.core.JndiBindable

getLookupName

Constructor Detail

RfcXmlGenerator

public RfcXmlGenerator()

Method Detail

prepareService

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

Specified by:

prepareService in class com.adaptris.core.licensing.LicensedService

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

initService

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

Specified by:

initService in class com.adaptris.core.ServiceImp

Throws:

com.adaptris.core.CoreException

start

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

Specified by:

start in interface com.adaptris.core.ComponentLifecycle

Overrides:

start in class com.adaptris.core.ServiceImp

Throws:

com.adaptris.core.CoreException

stop

public void stop()

Specified by:

stop in interface com.adaptris.core.ComponentLifecycle

Overrides:

stop in class com.adaptris.core.ServiceImp

closeService

protected void closeService()

Specified by:

closeService in class com.adaptris.core.ServiceImp

doService

public void doService(com.adaptris.core.AdaptrisMessage msg)
               throws com.adaptris.core.ServiceException

Specified by:

doService in interface com.adaptris.core.Service

Throws:

com.adaptris.core.ServiceException

getConnection

public com.adaptris.core.AdaptrisConnection getConnection()

Specified by:

getConnection in interface com.adaptris.core.ConnectedService

setConnection

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

Set the connection used to connect to SAP.

Specified by:

setConnection in interface com.adaptris.core.ConnectedService

Parameters:

connection - the connection, either a SharedConnection or a ConfiguredRfcConnection