com.sap.aii.af.service.cpa

Interface Service

All Superinterfaces:
Comparable<CPAObject>, CPAObject

public interface Service
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 Service object corresponds to the configuration of a Service, as maintained in the Integration Directory (or PCK configuration UI). The Party and Service objects represent the XI internal notation, for which the Channel and Binding (sender and receiver agreements) configuration is maintained. If an adapter handles messages where the B2B Party identifiers or Service names (in the external messaging format/protocol) are different from the XI internal notation, the adapter must use the NormalizationManager singleton class to normalize and denormalize the external Party and Service formats (e.g. DUNS, DDID) to and from the XI internal notation. This step is required, since the Inbound/Outbound runtime lookup can only be performed using the XI internal notation of Partys and Services, as configured in the Integration Directory (or PCK UI). The alternative Party and Service identifiers also need to be maintained in the configuration GUIs.

See Also:
NormalizationManager, Party, PartyIdentifier, ServiceIdentifier

Method Summary
 String getParty()
          Getter for Party.
 String getService()
          Getter for Service.
 String getServiceType()
          Getter for ServiceType.
 boolean isThirdParty()
          Getter for the 3rd Party flag.
 
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.

getServiceType

String getServiceType()
Getter for ServiceType.

Returns:
The ServiceType value.

isThirdParty

boolean isThirdParty()
Getter for the 3rd Party flag.

Returns:
The 3rd Party flag 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


Copyright 2014 SAP AG Complete Copyright Notice