com.sap.aii.af.service.cpa

Interface Binding

All Superinterfaces:

AttributeExtendedCPAObject, Comparable<CPAObject>, CPAObject

public interface Binding
extends AttributeExtendedCPAObject

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 Binding CPA object corresponds to the sender and receiver agreements maintained in the Integration Directory or PCK configuration UI. The adapter implementations should not need to use this class directly and can use the InboundRuntimeLookup and OutboundRuntimeLookup instead, to retrieve the required Channel configuration.

See Also:

Direction, CPAObjectType, LookupManager, InboundRuntimeLookup, OutboundRuntimeLookup, Channel, ModuleConfig, ModuleSequence, Party, PartyIdentifier, Service, ServiceIdentifier

SAP API Classification:

This interface is intended to be used only and may not be implemented by client code.

Method Summary

Modifier and Type	Method and Description
String	getActionName() Getter for ActionName (interface name in XI notation).
String	getActionNamespace() Getter for ActionNamespace (interface namespace in XI notation).
String	getChannelId() Getter for ChannelId.
String	getFromParty() Getter for FromParty.
String	getFromService() Getter for FromService.
byte[]	getHeaderMappingConfig() Getter for HeaderMappingConfig.
String	getInterfaceVersion() Getter for InterfaceVersion.
String	getMappedActionName() Getter for MappedActionName.
String	getMappedActionNamespace() Getter for MappedActionNamespace.
String	getMappingClassName() Getter for MappingClassName.
String	getMappingId() Getter for MappingId.
String	getToParty() Getter for ToParty.
String	getToService() Getter for ToService.
String	getValidationMode() Getter for ValidationMode.
String	getVirusScanMode() Getter for the VirusScanMode.

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

getAdapterNamespace, getAdapterSWCV, getAdapterType, getAttributeNames, getAttributes, getDirection

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

getFromParty

String getFromParty()

Getter for FromParty.

Returns:

The FromParty value.

getFromService

String getFromService()

Getter for FromService.

Returns:

The FromService value.

getToParty

String getToParty()

Getter for ToParty.

Returns:

The ToParty value.

getToService

String getToService()

Getter for ToService.

Returns:

The ToService value.

getActionNamespace

String getActionNamespace()

Getter for ActionNamespace (interface namespace in XI notation).

Returns:

The ActionNamespace value.

getActionName

String getActionName()

Getter for ActionName (interface name in XI notation).

Returns:

The ActionName value.

getChannelId

String getChannelId()

Getter for ChannelId. Returns the unique object Id of the Channel CPA object assigned to this Binding (Sender/Receiver Agreement in XI notation).

Returns:

The ChannelId value.

getHeaderMappingConfig

byte[] getHeaderMappingConfig()

Getter for HeaderMappingConfig.

Returns:

The HeaderMappingConfig value.

getMappingId

String getMappingId()

Getter for MappingId.

Returns:

The MappingId value.

getMappedActionName

String getMappedActionName()

Getter for MappedActionName.

Returns:

The MappedActionName value.

getMappedActionNamespace

String getMappedActionNamespace()

Getter for MappedActionNamespace.

Returns:

The MappedActionNamespace value.

getMappingClassName

String getMappingClassName()

Getter for MappingClassName.

Returns:

The MappingClassName value.

getValidationMode

String getValidationMode()

Getter for ValidationMode. This should be: 0 for VALIDATION_NONE 1 for VALIDATION_BACKWARD_AT_ADAPTER 2 for VALIDATION_FORWARD_AT_INTEGRATION_ENGINE

Returns:

The ValidationMode value.

getVirusScanMode

String getVirusScanMode()

Getter for the VirusScanMode. This is: 0 for USE_GLOBAL, 1 for NO_SCAN, 2 for SCAN_BY_ADAPTER

Returns:

The VirusScanMode value

getInterfaceVersion

String getInterfaceVersion()

Getter for InterfaceVersion. This can be a GUID or if send empty from the XI Directory null or ""

Returns:

The InterfaceVersion value.