com.sap.aii.af.service.cpa

Interface Channel

All Superinterfaces:

AttributeExtendedCPAObject, Comparable<CPAObject>, CPAObject

public interface Channel
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 Channel CPA object corresponds to the adapter specific Channel configuration maintained in the Integration Directory or PCK configuration UI. The configuration values of the adapter specific Channel definitions are defined through the adapter type meta data (schema). The configuration values can be retrieved from the Channel object by name with the getValueAsXXX methods. The Channel is either retrieved through the LookupManager or the InboundRuntimeLookup and OutboundRuntimeLookup classes, dependent on the adapter type. Refer to the JavaDoc of LookupManager, InboundRuntimeLookup and OutboundRuntimeLookup for detailed documentation about the lookup mechanisms.

See Also:

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

Method Summary

String	getChannelName() Getter for ChannelName.
String	getEngineName() Getter for EngineName.
String	getEngineType() Getter for EngineType.
String	getFromPartyAgency() Getter for FromPartyAgency.
String	getFromPartySchema() Getter for FromPartySchema.
String	getMsgProt() Getter for MsgProt.
String	getMsgProtVers() Getter for MsgProtVers.
String	getParty() Getter for Party.
String	getService() Getter for Service.
String	getToPartyAgency() Getter for ToPartyAgency.
String	getToPartySchema() Getter for ToPartySchema.
String	getTransProt() Getter for TransProt.
String	getTransProtVers() Getter for TransProtVers.

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

getParty

String getParty()

Getter for Party.

Returns:

The Party value.

getService

String getService()

Getter for Service.

Returns:

The Service value.

getChannelName

String getChannelName()

Getter for ChannelName.

Returns:

The ChannelName value.

getEngineType

String getEngineType()

Getter for EngineType.

Returns:

The EngineType value.

getEngineName

String getEngineName()

Getter for EngineName.

Returns:

The EngineName value.

getMsgProt

String getMsgProt()

Getter for MsgProt.

Returns:

The MsgProt value.

getMsgProtVers

String getMsgProtVers()

Getter for MsgProtVers.

Returns:

The MsgProtVers value.

getTransProt

String getTransProt()

Getter for TransProt.

Returns:

The TransProt value.

getTransProtVers

String getTransProtVers()

Getter for TransProtVers.

Returns:

The TransProtVers value.

getFromPartyAgency

String getFromPartyAgency()

Getter for FromPartyAgency.

Returns:

The FromPartyAgency value.

getFromPartySchema

String getFromPartySchema()

Getter for FromPartySchema.

Returns:

The FromPartySchema value.

getToPartyAgency

String getToPartyAgency()

Getter for ToPartyAgency.

Returns:

The ToPartyAgency value.

getToPartySchema

String getToPartySchema()

Getter for ToPartySchema.

Returns:

The ToPartySchema 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