com.sap.engine.interfaces.messaging.api

Interface PublicAPIAccess

public interface PublicAPIAccess

The PublicAPIAccess interface defines the public (SAP external) access to the Messaging System.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JNDI_NAME

Method Summary

Modifier and Type	Method and Description
AckFactory	createAckFactory()
MessageFactory	createMessageFactory(String protocol) Creates a MessageFactory instance for the given protocol.
AuditAccess	getAuditAccess()
PMIAccess	getPMIAccess() Deprecated. PMI functionality was removed. Method invocations of the returned PMIAccess do not have any effect. Users of this method should remove the code.

Field Detail

JNDI_NAME

static final String JNDI_NAME

See Also:

Constant Field Values

Method Detail

getPMIAccess

PMIAccess getPMIAccess()

Deprecated. PMI functionality was removed. Method invocations of the returned PMIAccess do not have any effect. Users of this method should remove the code.

Returns:

Returns the PMIAccess interface, which can be used to call the PMI agents.

getAuditAccess

AuditAccess getAuditAccess()

Returns:

Returns the AuditAccess interface, which can be used to write message based audit log entries.

createMessageFactory

MessageFactory createMessageFactory(String protocol)
                             throws InvalidParamException,
                                    MessagingException

Creates a MessageFactory instance for the given protocol. This MessageFactory will always create messages for the given protocol.

Parameters:

protocol - the protocol of all the messages that will be created by this factory

Returns:

MessageFactory

Throws:

MessagingException - if the MessageFactory could not be created.

InvalidParamException - if the protocol is not supported

createAckFactory

AckFactory createAckFactory()

Returns:

Messaging System AckFactory Creates a Messaging System AckFactory, that can be used to initiate sending end to end acknowledgement messages.