oracle.sdp.messaging

Interface MessagingObject

All Superinterfaces:

Serializable

All Known Subinterfaces:

AccessPoint, Address, Message, Status

public interface MessagingObject
extends Serializable

This is the base type for all primary messaging related object types, namely Message, Status and Address. It defines methods to set and get meta data name-value pairs that can be associated with a concrete messaging object. The meta data is used in varying contexts depending on the type. For instance, rule-based preference facts set by applications as meta data in the Message object are used by the Messaging engine and Notification Preferences server for rule-based message delivery. Meta data are stored in one or multiple namespaces. A namespace hosts meta data name-value pairs. The namespace is NOT case sensitive. Meta data name IS case sensitive.

Namespaces starting with 'UMS' and 'SDPM' are reserved by the User Messaging Service.
Namespaces starting with 'NP' are reserved by the Notification Preferences.
The pre-defined constants NAMESPACE_UMS, NAMESPACE_SDPM and NAMESPACE_NOTIFICATION_PREFERENCES are available for convenience to avoid hard dependency on the actual value.

Since:

11.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	METADATA_APPLICATION_NAME The pre-defined metadata name for Application Name.
static String	NAMESPACE_NOTIFICATION_PREFERENCES The pre-defined namespace for Rule-driven Notification Preferences.
static String	NAMESPACE_SDPM A pre-defined namespace for UMS.
static String	NAMESPACE_UMS A pre-defined namespace for UMS.
static String	NAMESPACE_UMS_JMP_PROPS A pre-defined namespace for UMS JMS properties.

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getAllNamespaces() Get all namespaces.
String	getMetaData(String namespace, String name) Get meta data value by name.
Set<String>	getMetaDataNames(String namespace) Get all meta data names.
String	logShort() Generate a short summary String of the MessagingObject that can be used for logging.
String	removeMetaData(String namespace, String name) Remove meta data value by name and return the removed value or null.
void	setMetaData(String namespace, String name, String value) Set meta data value by name.

Field Detail

NAMESPACE_UMS

static final String NAMESPACE_UMS

A pre-defined namespace for UMS.

See Also:

Constant Field Values

NAMESPACE_SDPM

static final String NAMESPACE_SDPM

A pre-defined namespace for UMS.

See Also:

Constant Field Values

NAMESPACE_UMS_JMP_PROPS

static final String NAMESPACE_UMS_JMP_PROPS

A pre-defined namespace for UMS JMS properties.

See Also:

Constant Field Values

NAMESPACE_NOTIFICATION_PREFERENCES

static final String NAMESPACE_NOTIFICATION_PREFERENCES

The pre-defined namespace for Rule-driven Notification Preferences.

See Also:

Constant Field Values

METADATA_APPLICATION_NAME

static final String METADATA_APPLICATION_NAME

The pre-defined metadata name for Application Name.

See Also:

Constant Field Values

Method Detail

setMetaData

void setMetaData(String namespace,
               String name,
               String value)

Set meta data value by name.

Parameters:

namespace - namespace is NOT case sensitive and cannot be null. 'foo', 'Foo' and 'FOO' are refering to the namespace.

name - name IS case sensitive and cannot be null. 'foo', 'Foo' and 'FOO' are refering to different meta data names.

value - the value of the meta data.

getMetaData

String getMetaData(String namespace,
                 String name)

Get meta data value by name.

Parameters:

namespace - namespace is NOT case sensitive and cannot be null. 'foo', 'Foo' and 'FOO' are refering to the namespace.

name - name IS case sensitive and cannot be null. 'foo', 'Foo' and 'FOO' are refering to different meta data names.

Returns:

value of the meta data name.

removeMetaData

String removeMetaData(String namespace,
                    String name)

Remove meta data value by name and return the removed value or null.

Parameters:

namespace - namespace is NOT case sensitive and cannot be null. 'foo', 'Foo' and 'FOO' are refering to the namespace.

name - name IS case sensitive and cannot be null. 'foo', 'Foo' and 'FOO' are refering to different meta data names.

Returns:

value of the removed meta data name, or null.

getMetaDataNames

Set<String> getMetaDataNames(String namespace)

Get all meta data names.

Parameters:

namespace - namespace is NOT case sensitive and cannot be null. 'foo', 'Foo' and 'FOO' are refering to the namespace.

Returns:

all names of meta data of the current object.

getAllNamespaces

Set<String> getAllNamespaces()

Get all namespaces.

Returns:

all namespaces (in upper case) of meta data of the current object

logShort

String logShort()

Generate a short summary String of the MessagingObject that can be used for logging.

Returns:

a short summary String that can be used for logging.