com.sap.aii.proxy.xiruntime.core

Interface MessageSpecifier

All Superinterfaces:

Serializable

public interface MessageSpecifier
extends Serializable

Interface representing a message specifier, which allows to specify various characteristics of a message and its transport thus overriding system defaults or automatic behaviour.

This interface is implemented by class MessageSpecifierImpl.

Copyright (c) 2001 SAP AG

See Also:

MessageSpecifierImpl

Method Summary

void	addAttachment(MessageAttachment attachment) adds the given attachment to the current set of attachments
MessageAttachment	addAttachment(String name, String type, Object data) adds and returns a new attachment of the given name, type, and data
void	addReceiver(String businessSystemName) Deprecated. As of XI3.0, replaced by addReceiverService(String service).
void	addReceiver(String businessSystemName, String interfaceNSURI, String interfaceLCNAME) Deprecated. As of version 2.0 SP2, replaced by addReceiver(String businessSystemName)
void	addReceiver(String partyName, String partyAgency, String partyScheme, String service) adds the given receiver to the current set of receiver services.
void	addReceiver(String partyName, String service, String interfaceLocalname, String interfaceNamespace, boolean test) Deprecated. Do not use (Interim method for internal test purposes only)
void	addReceiverService(String service) adds the given receiver service to the current set of receiver services
void	clear() clears all specifier data
void	clearAttachments() removes all attachments
void	clearReceivers() Deprecated. As of XI3.0, replaced by clearReceiverServices().
void	clearReceiverServices() removes all receiver services
MessageAttachment	createAttachment(String name, String type, Object data) returns the interface of a new message attachment.
MessageAttachment	getAttachment(String name) returns the attachment of the given name
Enumeration	getAttachments() returns an enumeration of all attachments of this message
String	getDestination() Deprecated. As of XI3.0, the destination is determined by the Messaging System service and can, therefore, no longer be set and get.
String	getInputPayload() returns a string containing the payload of the incoming message
XmlLogonData	getLogonData() returns the logon data of the incoming message
com.sap.guid.IGUID	getMessageID() returns the MessageID of the received message
com.sap.guid.IGUID	getMessageIDLastSent() returns the GUID used by the message last sent
String	getOutputPayload() returns a string containing the payload of the outgoing message
String	getQueueId() returns the queue id representing the Serialization Context of the received message
R3RFCDestination	getR3RFCDestinationForBusinessSystem(String businessSystemName) Deprecated. As of XI2.0 SP1, replaced by AbstractProxyBean.$runtime(int selector, Object[] args) or AbstractProxy.$runtime(int selector, Object[] args). Use with selector = GET_R3_RFC_DESTINATION_FOR_BS, args = new Object[]{businessSystemName}
Enumeration	getReceiverServices() returns the receiver services of the message as an Enumeration of XIAddress objects
com.sap.guid.IGUID	getRefToMessageID() returns the RefToMessageID of the received message
String	getSenderName() Deprecated. As of XI3.0, replaced by getSenderService().
String	getSenderPartyAgency() returns the party agency of the sender of the received message.
String	getSenderPartyName() returns the party name of the sender of the received message.
String	getSenderPartyScheme() returns the party scheme of the sender of the received message.
String	getSenderService() returns the service name of the sender of the received message.
String	getSerializationContext() Deprecated. As of XI3.0, replaced by getQueueId().
boolean	removeAttachment(MessageAttachment attachment) removes the given attachment from the current set of attachments
boolean	removeReceiver(String businessSystemName) Deprecated. As of XI3.0, replaced by removeReceiverService(String service).
boolean	removeReceiverService(String service) removes the given receiver service from the current set of receiver services
void	setAAEDestination(String httpDestination, String username, String password) sets the target http destination for the consumer side.
void	setApplicationAckRequested(String ackListenerName) turns the request for Application acknowledement on by registering an AckListenerName, or off by registering null.
void	setApplicationErrorAckRequested(String ackListenerName) turns the request for Application Error acknowledement on by registering an AckListenerName, or off by registering null.
void	setDestination(String destination) Deprecated. As of XI3.0, the destination is determined by the Messaging System service and can, therefore, no longer be set and get.
void	setMessagingTimeoutInMSec(long timeout) sets the timeout before a message expires (used by the Messaging System)
void	setPayload(String payload) sets the payload (i.e., the XML document) of the outgoing message
void	setQueueId(String id) sets the queue id representing the Serialization Context (max. 16 chars, upper case only); may be null of the message to be sent
void	setSenderName(String businessSystemName) Deprecated. As of XI3.0, setting the sender name is no longer possible.
void	setSenderPartyName(String name) sets the party name of the sender for the next message to be sent.
void	setSenderService(String service) sets the service name (e.g., Business System name) of the sender for the next message to be sent.
void	setSerializationContext(String name) Deprecated. As of XI3.0, replaced by setQueueId(String id).
void	setSystemAckRequested(String ackListenerName) turns the request for System acknowledement on by registering an AckListenerName, or off by registering null.
void	setSystemErrorAckRequested(String ackListenerName) turns the request for System Error acknowledement on by registering an AckListenerName, or off by registering null.

Method Detail

getR3RFCDestinationForBusinessSystem

R3RFCDestination getR3RFCDestinationForBusinessSystem(String businessSystemName)

Deprecated. As of XI2.0 SP1, replaced by AbstractProxyBean.$runtime(int selector, Object[] args) or AbstractProxy.$runtime(int selector, Object[] args). Use with selector = GET_R3_RFC_DESTINATION_FOR_BS, args = new Object[]{businessSystemName}

returns an interface describing the R/3 RFC destination of the Business System specified by the given name

getMessageID

com.sap.guid.IGUID getMessageID()

returns the MessageID of the received message

getRefToMessageID

com.sap.guid.IGUID getRefToMessageID()

returns the RefToMessageID of the received message

getMessageIDLastSent

com.sap.guid.IGUID getMessageIDLastSent()

returns the GUID used by the message last sent

getSenderName

String getSenderName()

Deprecated. As of XI3.0, replaced by getSenderService().

returns the name (Business System name) of the sender of the received message.

setSenderName

void setSenderName(String businessSystemName)

Deprecated. As of XI3.0, setting the sender name is no longer possible.

used to set the name (Business System name) of the sender for the next message to be sent.

getSenderPartyName

String getSenderPartyName()

returns the party name of the sender of the received message.

getSenderPartyAgency

String getSenderPartyAgency()

returns the party agency of the sender of the received message.

getSenderPartyScheme

String getSenderPartyScheme()

returns the party scheme of the sender of the received message.

getSenderService

String getSenderService()

returns the service name of the sender of the received message.

setSenderService

void setSenderService(String service)

sets the service name (e.g., Business System name) of the sender for the next message to be sent.

setSenderPartyName

void setSenderPartyName(String name)

sets the party name of the sender for the next message to be sent.

getReceiverServices

Enumeration getReceiverServices()

returns the receiver services of the message as an Enumeration of XIAddress objects

addReceiver

void addReceiver(String businessSystemName,
                 String interfaceNSURI,
                 String interfaceLCNAME)

Deprecated. As of version 2.0 SP2, replaced by addReceiver(String businessSystemName)

adds the given receiver business system and interface to the current set of receivers

addReceiver

void addReceiver(String businessSystemName)

Deprecated. As of XI3.0, replaced by addReceiverService(String service).

adds the given receiver business system to the current set of receivers.

addReceiverService

void addReceiverService(String service)

adds the given receiver service to the current set of receiver services

addReceiver

void addReceiver(String partyName,
                 String partyAgency,
                 String partyScheme,
                 String service)

adds the given receiver to the current set of receiver services. Parameters partyName, partyAgency and partyScheme may be null. However, if partyAgency or partyScheme are not null, partyName must also be not null. Otherwise, an IllegalArgumentException will be thrown.

addReceiver

void addReceiver(String partyName,
                 String service,
                 String interfaceLocalname,
                 String interfaceNamespace,
                 boolean test)

Deprecated. Do not use (Interim method for internal test purposes only)

adds the given receiver to the current set of receivers.

removeReceiver

boolean removeReceiver(String businessSystemName)

Deprecated. As of XI3.0, replaced by removeReceiverService(String service).

removes the given receiver business system from the current set of receivers.

removeReceiverService

boolean removeReceiverService(String service)

removes the given receiver service from the current set of receiver services

clearReceivers

void clearReceivers()

Deprecated. As of XI3.0, replaced by clearReceiverServices().

removes all receivers

clearReceiverServices

void clearReceiverServices()

removes all receiver services

getSerializationContext

String getSerializationContext()

Deprecated. As of XI3.0, replaced by getQueueId().

returns the queue name representing the Serialization Context of the received message.

getQueueId

String getQueueId()

returns the queue id representing the Serialization Context of the received message

setSerializationContext

void setSerializationContext(String name)
                             throws IllegalArgumentException

Deprecated. As of XI3.0, replaced by setQueueId(String id).

sets the queue name representing the Serialization Context (max. 16 chars, upper case only); may be null of the message to be sent.

Throws:

IllegalArgumentException

setQueueId

void setQueueId(String id)
                throws IllegalArgumentException

sets the queue id representing the Serialization Context (max. 16 chars, upper case only); may be null of the message to be sent

Throws:

IllegalArgumentException

setApplicationAckRequested

void setApplicationAckRequested(String ackListenerName)

turns the request for Application acknowledement on by registering an AckListenerName, or off by registering null.

setApplicationErrorAckRequested

void setApplicationErrorAckRequested(String ackListenerName)

turns the request for Application Error acknowledement on by registering an AckListenerName, or off by registering null.

setSystemAckRequested

void setSystemAckRequested(String ackListenerName)

turns the request for System acknowledement on by registering an AckListenerName, or off by registering null.

setSystemErrorAckRequested

void setSystemErrorAckRequested(String ackListenerName)

turns the request for System Error acknowledement on by registering an AckListenerName, or off by registering null.

setDestination

void setDestination(String destination)

Deprecated. As of XI3.0, the destination is determined by the Messaging System service and can, therefore, no longer be set and get.

sets the destination for the next message to be sent.

getDestination

String getDestination()

Deprecated. As of XI3.0, the destination is determined by the Messaging System service and can, therefore, no longer be set and get.

returns the current destination.

setMessagingTimeoutInMSec

void setMessagingTimeoutInMSec(long timeout)

sets the timeout before a message expires (used by the Messaging System)

createAttachment

MessageAttachment createAttachment(String name,
                                   String type,
                                   Object data)

returns the interface of a new message attachment.

Parameters:

name - Name of the attachment

type - MIME type of the attachment, e.g., "text/xml"

data - Data object of the attachment

addAttachment

MessageAttachment addAttachment(String name,
                                String type,
                                Object data)

adds and returns a new attachment of the given name, type, and data

addAttachment

void addAttachment(MessageAttachment attachment)

adds the given attachment to the current set of attachments

removeAttachment

boolean removeAttachment(MessageAttachment attachment)

removes the given attachment from the current set of attachments

clearAttachments

void clearAttachments()

removes all attachments

getAttachment

MessageAttachment getAttachment(String name)

returns the attachment of the given name

getAttachments

Enumeration getAttachments()

returns an enumeration of all attachments of this message

getInputPayload

String getInputPayload()

returns a string containing the payload of the incoming message

getOutputPayload

String getOutputPayload()

returns a string containing the payload of the outgoing message

setPayload

void setPayload(String payload)

sets the payload (i.e., the XML document) of the outgoing message

getLogonData

XmlLogonData getLogonData()

returns the logon data of the incoming message

clear

void clear()

clears all specifier data

setAAEDestination

void setAAEDestination(String httpDestination,
                       String username,
                       String password)

sets the target http destination for the consumer side.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] SAP_XIAF	[sap.com] com.sap.aii.proxy.svc.facade	api	BC-XI