StreamTransformationConstants

Class

Use

Tree

Index

Help

If not dev, correct this wrong version label in perforce3227:3227\buildenvBE.Japro<CODELINE>src_macrospackjavadoc.properties

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sap.aii.mapping.api

Interface StreamTransformationConstants

public interface StreamTransformationConstants

This interface contains constants that can be used in a java mapping to access runtime parameters. Most of these parameters are attributes of the message header, e.g., sender party, sender service, etc.

Note that some constants from XI 2.0 are deprecated. Nevertheless they are still supported. So it is not necessary to change existing mappings that use these deprecated constants.

Field Summary
`static String`	`CONTENT_TYPE` The content-type of the result message.
`static String`	`CONVERSATION_ID` The conversation id.
`static String`	`DIRECTION` Deprecated. As of SAP NetWeaver '04, replaced by `MESSAGE_CLASS`.
`static String`	`DIRECTION_FAULT` Deprecated.
`static String`	`DIRECTION_REQUEST` Deprecated.
`static String`	`DIRECTION_RESPONSE` Deprecated.
`static String`	`DYNAMIC_CONFIGURATION` Dynamic configuration.
`static String`	`INPUT_ATTACHMENTS` Use this constant to get access to the input attachment handler.
`static String`	`INTERFACE` Sender interface name.
`static String`	`INTERFACE_NAMESPACE` Sender interface namespace.
`static String`	`MAPPING_TRACE` The trace object `MappingTrace`.
`static String`	`MESSAGE_CLASS` Classification of message (direction of the message).
`static String`	`MESSAGE_ID` The message ID.
`static String`	`OUTPUT_ATTACHMENTS` Use this constant to get access to the output attachment handler.
`static String`	`PROCESSING_MODE` The processing mode of the message: synchronous or asynchronous.
`static String`	`RECEIVER_NAME` The name of the receiver interface.
`static String`	`RECEIVER_NAMESPACE` The namespace of the receiver interface.
`static String`	`RECEIVER_PARTY` The name of the receiver party.
`static String`	`RECEIVER_PARTY_AGENCY` The agency of the receiver party.
`static String`	`RECEIVER_PARTY_SCHEME` The scheme of the receiver party.
`static String`	`RECEIVER_SERVICE` The receiver service.
`static String`	`RECEIVER_SYSTEM` Deprecated. As of SAP NetWeaver '04, replaced by `RECEIVER_SERVICE`.
`static String`	`REF_TO_MESSAGE_ID` The ID of a referenced message that belongs semantically to this message.
`static String`	`SENDER_NAME` Deprecated. As of SAP NetWeaver '04, replaced by `INTERFACE`.
`static String`	`SENDER_NAMESPACE` Deprecated. As of SAP NetWeaver '04, replaced by `INTERFACE_NAMESPACE`.
`static String`	`SENDER_PARTY` The sender party.
`static String`	`SENDER_PARTY_AGENCY` The agency of the sender party.
`static String`	`SENDER_PARTY_SCHEME` The scheme of the sender party.
`static String`	`SENDER_SERVICE` The sender service.
`static String`	`SENDER_SYSTEM` Deprecated. As of SAP NetWeaver '04, replaced by `SENDER_SERVICE`.
`static String`	`TIME_SENT` Time stamp specifying when the message was sent by the sender.
`static String`	`VERSION_MAJOR` XI message protocol version.
`static String`	`VERSION_MINOR` XI message protocol version.

Field Detail

MESSAGE_CLASS

static final String MESSAGE_CLASS

Classification of message (direction of the message). Possible values

ApplicationMessage: Asynchronous or synchronous request message
ApplicationResponse: Response to a request message
SystemAck, ApplicationAck, SystemError, ApplicationError:
Acknowledgment Messages

See Also:: Constant Field Values

VERSION_MAJOR

static final String VERSION_MAJOR

XI message protocol version. Example: For the XI 3.0 message protocol VERSION_MAJOR = 3 and VERSION_MINOR = 0.

See Also:: Constant Field Values

VERSION_MINOR

static final String VERSION_MINOR

XI message protocol version. Example: For the XI 3.0 message protocol VERSION_MAJOR = 3 and VERSION_MINOR = 0.

See Also:: Constant Field Values

PROCESSING_MODE

static final String PROCESSING_MODE

The processing mode of the message: synchronous or asynchronous.

See Also:: Constant Field Values

MESSAGE_ID

static final String MESSAGE_ID

The message ID. It can change during communication:

Response messages get a new message ID.
If new messages result from a message (the message is copied at multiple receivers), the new messages get new message IDs.

See Also:: Constant Field Values

REF_TO_MESSAGE_ID

static final String REF_TO_MESSAGE_ID

The ID of a referenced message that belongs semantically to this message. For example, a response message uses this field to note which request message it belongs to.

See Also:: Constant Field Values

CONVERSATION_ID

static final String CONVERSATION_ID

The conversation id. This field is not mandatory in the message. It enables an ID to be used to group messages that belong together. This field is not intended to be used for message serialization and has nothing to do with the serialization context (ABAP proxy runtime, Java proxy runtime).

See Also:: Constant Field Values

TIME_SENT

static final String TIME_SENT

Time stamp specifying when the message was sent by the sender. The format of the time stamp is as follows: YYYY-MM-DDTHH:MM:SSZ The letter 'T' separates the date from the time, which is generally specified in UTC. If it is a local time, the closing 'Z' is omitted.

See Also:: Constant Field Values

SENDER_PARTY

static final String SENDER_PARTY

The sender party. Communication party that sent the message.

See Also:: Constant Field Values

SENDER_PARTY_AGENCY

static final String SENDER_PARTY_AGENCY

The agency of the sender party. Issuing agency for the message sender.

See Also:: Constant Field Values

SENDER_PARTY_SCHEME

static final String SENDER_PARTY_SCHEME

The scheme of the sender party. Identification scheme used by the sender.

See Also:: Constant Field Values

SENDER_SERVICE

static final String SENDER_SERVICE

The sender service. Service on the sender side that sent the message. For example, the name of a business system. As of SAP XI 3.0, use this constant instead of the constant SENDER_SYSTEM used previously.

See Also:: Constant Field Values

RECEIVER_PARTY

static final String RECEIVER_PARTY

The name of the receiver party. Communication party to receive the message.

See Also:: Constant Field Values

RECEIVER_PARTY_AGENCY

static final String RECEIVER_PARTY_AGENCY

The agency of the receiver party. Issuing agency for the message receiver.

See Also:: Constant Field Values

RECEIVER_PARTY_SCHEME

static final String RECEIVER_PARTY_SCHEME

The scheme of the receiver party. Identification scheme used by the receiver.

See Also:: Constant Field Values

RECEIVER_SERVICE

static final String RECEIVER_SERVICE

The receiver service. Service on the receiver side that receives the message. For example, the name of a business system. As of SAP XI 3.0, use this constant instead of the constant RECEIVER_SYSTEM used previously.

See Also:: Constant Field Values

INTERFACE

static final String INTERFACE

Sender interface name. As of SAP XI 3.0, use this constant instead of the constant SENDER_NAME used previously

See Also:: Constant Field Values

INTERFACE_NAMESPACE

static final String INTERFACE_NAMESPACE

Sender interface namespace. As of SAP XI 3.0, use this constant instead of the constant SENDER_NAMESPACE used previously.

See Also:: Constant Field Values

MAPPING_TRACE

static final String MAPPING_TRACE

The trace object MappingTrace. Returns a MappingTrace object that you can use to write messages in the monitoring. Since SAP NetWeaver '04 an AbstractTrace is returned.

Since:: XI 2.0 Support Package 2 Patch-Level 3.
See Also:: Constant Field Values

CONTENT_TYPE

static final String CONTENT_TYPE

The content-type of the result message. Example: text/html; charset=utf-8.

Since:: SAP NetWeaver '04 SPS10
See Also:: Constant Field Values

DYNAMIC_CONFIGURATION

static final String DYNAMIC_CONFIGURATION

Dynamic configuration.

Since:: SAP NetWeaver '04 SPS14
See Also:: Constant Field Values

INPUT_ATTACHMENTS

static final String INPUT_ATTACHMENTS

Use this constant to get access to the input attachment handler. This class will allow to get the content IDs of the source attachments and to get the attachment data.

See Also:: InputAttachments, Constant Field Values

OUTPUT_ATTACHMENTS

static final String OUTPUT_ATTACHMENTS

Use this constant to get access to the output attachment handler. This class will allow you to modify attachments of the source message, to remove or add attachment data.