atg.dms.registry
Interface MessageRegistry

public interface MessageRegistry

The MessageRegistry describes all of the Dynamo Messages that are recognized by the Dynamo Messaging System. Message types do not necessarily have to be registered here in order to be carried by the various JMS implementations and the Patch Bay. However, the registry allows UI builders and administrative tools to know about various message types.

The Registry describes Dynamo Messages. A Dynamo Message is a JMS ObjectMessage, whose type is identified by the Message's JMSType (a String property of all JMS Messages). Each type maps to a single Object bean type, and the ObjectMessage must carry an Object of that type. For example, a Dynamo Message of type "atg.dps.Logout" might map to a bean of type "atg.dps.LogoutMessage". By convention, message types do not end with "Message" or "Event", but message bean types do end with "Message".

The registry maintains the mapping of message type to message bean type. Message types must be unique across the entire registry (but multiple message types may map to the same message bean type).

The registry also allows messages to be grouped into message families. These message families may themselves be contained by other message families, thereby allowing messages to be organized in a hierarchical fashion. A message family has a name that must be unique within its containing message family. However, message types must be unique across all message families. Message families have no runtime function - they only exist to provide a grouping of message types that may be useful to builder tools.

At its top level, a MessageRegistry contains only a set of MessageFamilies.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

MessageFamily[]	getMessageFamilies() Returns the set of "top-level" message families known to the registry.
MessageType	getMessageType(java.lang.String pMessageType) Returns the MessageType corrsponding to the specified message type name, or null if there is no such message type.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getMessageFamilies

MessageFamily[] getMessageFamilies()

Returns the set of "top-level" message families known to the registry.

getMessageType

MessageType getMessageType(java.lang.String pMessageType)

Returns the MessageType corrsponding to the specified message type name, or null if there is no such message type.