com.sap.aii.af.service.cpa

Interface ServiceIdentifier

All Superinterfaces:

Comparable<CPAObject>, CPAObject

public interface ServiceIdentifier
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 ServiceIdentifier represents an alternative identifier for an XI internal Party notation, as maintained in the Integration Directory (or the PCK configuration UI). 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).

See Also:

NormalizationManager, Party, Service, ServiceIdentifier

Method Summary

String	getParty() Returns the XI internal party name.
String	getService() Returns the XI internal service name.
String	getServiceIdentifier() Returns the alternative external service identifier for the external schema, which can be get with the getServiceSchema method.
String	getServiceSchema() Returns the schema for the alternative external service identifier (e.g.

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()

Returns the XI internal party name.
The ServiceIdentifier contains four relevant fields: 1/2) The XI internal party and service name 3/4) the external service name and for which schema the alternative XI external service identifier is expressed (e.g. XI Party: BMW, XIService: Purchasing, ServiceSchema: DDID, ServiceIdentifier: DDID1234).
The ServiceIdentifier object is to be retrieved using the NormalizationManager.

Returns:

The Party value.

See Also:

getService(), getServiceSchema(), getServiceIdentifier()

getService

String getService()

Returns the XI internal service name.

Returns:

The Service value.

See Also:

getParty()

getServiceSchema

String getServiceSchema()

Returns the schema for the alternative external service identifier (e.g. DDID), which can be get with the getServiceIdentifier method.

Returns:

The ServiceSchema value.

See Also:

getParty()

getServiceIdentifier

String getServiceIdentifier()

Returns the alternative external service identifier for the external schema, which can be get with the getServiceSchema method.

Returns:

The ServiceIdentifier value.

See Also:

getParty()

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