com.sap.aii.af.service.administration.api.cpa

Interface CPAOutboundRuntimeLookupManager

All Superinterfaces:

CPAInboundRuntimeLookupManager

public interface CPAOutboundRuntimeLookupManager
extends CPAInboundRuntimeLookupManager

The CPA cache service offers two kinds of lookup mechanisms. One is offered for such adapters, which need to start an own instance, for each Channel configuration. Such adapters use the LookupManager singleton class to read all known Channel configurations for their own adapter type from the cache at startup, to start an instance of the adapter for each Channel. These adapter types should also register themselves to the CallbackController, in order to be informed about new and deleted Channel configurations.

The other type of adapters has only one running instance, which can handle all messages, Channel-independent. These adapters need to retrieve the Channel configuration per Message at runtime, based on the addressing information in the header of the currently processed message. The InboundRuntimeLookup and InboundRuntimeLookup objects allow to retrieve Channel attribute values by checking internally, if a matching Binding (sender or receiver agreement) exists. The adapter type/namespace and the given addressing data of the message (from/to Party/Service and Interface[Namespace]) need to be passed into the constructor. After constuction the Inbound/OutboundRuntimeLookup either the Channel object can be retrieved for further processing, or the configuration values can be retrieved directly by name, as defined in the adapter type meta data (schema).

Example of usage:

 OutboundRuntimeLookup lookup = new OutboundRuntimeLookup("MyAdapterName",
                "http://mycompany.com/myadapter/namespace", "fromParty", "toParty",
                "fromService", "toService", "interface", "interfaceNamespace");
 
 int value = lookup.getChannelValueAsInt("IntValueName");
 

Version:

$Id: //tc/xpi.af/NW711_03_COR/src/_af_service/psrv/api/com/sap/aii/af/service/administration/api/cpa/CPAOutboundRuntimeLookupManager.java#1 $

See Also:

InboundRuntimeLookup, LookupManager

Method Summary

byte[]

getHeaderMappingConfig() Retrieves the HeaderMapping configuration from the Binding object.

Methods inherited from interface com.sap.aii.af.service.administration.api.cpa.CPAInboundRuntimeLookupManager

getBinding, getBindingValue, getBindingValueAsBinary, getBindingValueAsBoolean, getBindingValueAsInt, getBindingValueAsLong, getBindingValueAsString, getBindingValueAsTable, getChannel, getChannelObject, getChannelValue, getChannelValueAsBinary, getChannelValueAsBoolean, getChannelValueAsInt, getChannelValueAsLong, getChannelValueAsString, getChannelValueAsTable, getInboundBinding, getInboundBinding, getOutboundBinding, getOutboundBinding, isBindingValuePassword, isChannelValuePassword

Method Detail

getHeaderMappingConfig

byte[] getHeaderMappingConfig()
                              throws CPAException

Retrieves the HeaderMapping configuration from the Binding object.

Returns:

The HeaderMapping configuration as byte array.

Throws:

CPAException - in case that the Binding can not be retrieved.

CPAException