Accessing Configuration Data at Runtime
The Adapter Framework configuration API is part of the Adapter Framework services.
A service manages changes to the configuration data in the Integration Directory or PCK. It provides caching and distribution functions for the cluster. This service is called the CPA (Collaboration Profile Agreement) service. The API itself is implemented in the services XPI Service: CPA Cache and XPI Service: AF Core, which are deployed together with the Adapter Framework.
Interface Overview
| Characteristic | Value |
|---|---|
|
Name |
Adapter Framework Configuration Service (CPA Service) |
|
Purpose |
Reads the configured data and subscribes to events to receive changed configuration data. |
|
Type |
Service in the facade com.sap.aii.af.svc.facade |
|
Technical Name |
com.sap.aii.af.service.cpa and com.sap.aii.af.service.administration.api.cpa |
|
Certification |
Mandatory |
|
Syntax |
JavaDoc package com.sap.aii.af.service.cpa |
The following classes and interfaces are available in package com.sap.aii.af.service.cpa:
com.sap.aii.af.service.cpa
| Name | Use |
|---|---|
|
Party, PartyIdentifier |
Access to party data |
|
Service, ServiceIdentifier, ServiceUser |
Access to information on the communication component |
|
Binding, BindingUser |
Access to information on sender or receiver agreements |
|
Channel |
Access to channel data |
|
ModuleConfig |
Access to the module configuration of a channel |
|
CPAObject, CPAObjectType, AttributeExtendedCPAObject |
Generic CPA object. The party, communication component and so on are derived from CPAObject, so that CPAObject methods can be called there. CPAObjectType determines the child class. AttributeExtendedCPAObject is located in the inheritance hierarchy between CPAObject and Channel, for example, as an additional abstraction layer. |
|
BinaryData, TableData, Direction |
Special data types of the CPAObject instances |
|
NormalizationManager |
Mapping external address information to address information in the XI message header |
|
CPAException |
Exception |
|
PartyCallBackController |
For registering and deregistering partner event handlers. If a partner object changes, for example, the alternative identifiers in the Integration Directory or PCK, then a change event is sent to all registered partner event handlers. Method partyrefreshEvent() is always called when a partner object is updated in the cache. An update is not always caused by changes to the partner object. The method can also, for example, be called by activating the object. If you want to know what calls the method partyrefreshEvent(), implement change management in your adapter. |
|
AbstractPartyCallBackHandler |
Extend this class and add your own event handler. For this, oerwrite the method void partyrefreshEvent(Party party) |
|
CPAObjectCallbackInterface |
This class is a generalization of the AbstractPartyCallBackHandler. You do not have to use it. |
com.sap.aii.af.service.administration.api.cpa
| Name | Description |
|---|---|
|
CPAInboundRuntimeLookupManager, CPALookupManager, CPAOutboundRuntimeLookupManager |
Managers that use particular input parameters and defined search algorithms to search for and return CPAObjectinstances. You can use different access strategies, depending on the adapter variant. For example, specify the communication agreement using the address data in the external message (B2B scenario), or the agreement can be statically assign such as with the file adapter. AdapterTypeMetaData/@senderAgreementUnique in the adapter metadata |
|
CPAFactory |
Access to the LookupManager |
|
ChannelLifecycleCallback |
CPA event handling Can be implemented to generate a notification in the event of changes to the configuration. |
|
CPAChannelStoppedException |
Exception should an attempt be made to access the configuration data of a stopped channel. |