|
Oracle Fusion Middleware User Messaging Service 11.1.1.3.0 Java API Reference E14011-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MessagingObject
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 'SDPM' are reserved by the SDP Messaging.
Namespaces starting with 'NP' are reserved by the Notification Preferences.
The pre-defined constants NAMESPACE_SDPM, and
NAMESPACE_NOTIFICATION_PREFERENCES are available for convenience to avoid
hard dependency on the actual value.
Field Summary | |
---|---|
static java.lang.String |
NAMESPACE_NOTIFICATION_PREFERENCES
The pre-defined namespace for Rule-driven Notification Preferences. |
static java.lang.String |
NAMESPACE_SDPM
The pre-defined namespace for SDP Messaging. |
Method Summary | |
---|---|
Set<java.lang.String> |
getAllNamespaces()
Get all namespaces. |
java.lang.String |
getMetaData(java.lang.String namespace,
java.lang.String name)
Get meta data value by name. |
Set<java.lang.String> |
getMetaDataNames(java.lang.String namespace)
Get all meta data names. |
void |
setMetaData(java.lang.String namespace,
java.lang.String name,
java.lang.String value)
Set meta data value by name. |
Field Detail |
---|
static final java.lang.String NAMESPACE_NOTIFICATION_PREFERENCES
static final java.lang.String NAMESPACE_SDPM
Method Detail |
---|
Set<java.lang.String> getAllNamespaces()
java.lang.String getMetaData(java.lang.String namespace, java.lang.String name)
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.
Set<java.lang.String> getMetaDataNames(java.lang.String namespace)
namespace
- namespace is NOT case sensitive and cannot be null. 'foo', 'Foo'
and 'FOO' are refering to the namespace.
void setMetaData(java.lang.String namespace, java.lang.String name, java.lang.String value)
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.
|
Oracle Fusion Middleware User Messaging Service 11.1.1.3.0 Java API Reference E14011-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |