com.sap.aii.af.service.cpa

Interface ModuleConfig

All Superinterfaces:

Comparable<CPAObject>, CPAObject

public interface ModuleConfig
extends CPAObject

The CPA Cache service API allows adapter implementations to retrieve their adapter specific configuration (CPA objects) from the local persistent and in-memory cache. The adapter specific configuration data is maintained either using the Integration Directory, or the PCK configuration UI. Independent from the scenario (central/decental AdapterFramework or PCK), the configuration objects can be retrieved with the LookupManager singleton class. For detailed documentation read the JavaDoc of that class. A list of all known configuration objects is available through the typed CPAObjectType enumeration class, which can be used in combination with the LookupManager.

The ModuleConfig object corresponds to the configuration of one module for the module processor, as maintained in the Integration Directory (or the PCK configuration UI) for a specific Channel. The adapter implementations should never need to lookup such module specific configuration data, since the module processor reads this config data and passes it into the Module, when invoking its process method. If necessary the module sequence and module configuration can be read from the cache, using methods of the LookupManager singleton class.

See Also:

CPAObjectType, LookupManager, Binding, Channel, ModuleSequence, Party, PartyIdentifier, Service, ServiceIdentifier

Method Summary

String	getChannelId() Getter for ChannelId.
String	getModuleNamespace() Getter for ModuleNamespace.
String	getParameterName() Getter for ParameterName.
String	getParameterValue() Getter for ParameterValue.

Methods inherited from interface com.sap.aii.af.service.cpa.CPAObject

getObjectId, getObjectName, getObjectType, getStringRepresentation, getValue, getValueAsBinary, getValueAsBoolean, getValueAsDate, getValueAsInt, getValueAsIntObject, getValueAsLong, getValueAsLongObject, getValueAsString, getValueAsTable, getValueAsTimestamp, isPassword

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getChannelId

String getChannelId()

Getter for ChannelId.

Returns:

The ChannelId value.

getModuleNamespace

String getModuleNamespace()

Getter for ModuleNamespace.

Returns:

The ModuleNamespace value.

getParameterName

String getParameterName()

Getter for ParameterName.

Returns:

The ParameterName value.

getParameterValue

String getParameterValue()

Getter for ParameterValue.

Returns:

The ParameterValue value.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] SAP_XIAF	[sap.com] com.sap.aii.af.svc.facade	api	BC-XI