ComponentMessage

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> aendvari >> cerberus >> component >> [ descriptor overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.aendvari.cerberus.component.descriptor.ComponentMessage

SOURCE |

Download com.aendvari.cerberus.component.descriptor.ComponentMessage

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.aendvari.cerberus.component.descriptor
Class ComponentMessage

java.lang.Object
  com.aendvari.cerberus.component.descriptor.ComponentProperty
      com.aendvari.cerberus.component.descriptor.ComponentMessage

public class ComponentMessage
extends ComponentProperty

Describes a com.aendvari.hermes.broker.Message that a component either sends or receives.

A message is referenced by a simple name. The simple name is mapped to a message topic. Typically, the implementation of the component will refer to the message by the simple name.

The topic is built from a series of literals and attributes. Attributes allow portions of the topic to be specified during component instantiation.

Messages may also be mapped to a message of a parent component. This copies the topic assigned to the parent message to the child message.

A message may also describe it's signature, the set of properties describing the payload of the message. This provides an explict description of the component's message interface.

Nested Class Summary

static interface ComponentMessage.Type
          Constants for the type of the message.

Nested classes inherited from class com.aendvari.cerberus.component.descriptor.ComponentProperty

ComponentProperty.Access

Field Summary

protected boolean mapped
          Specifies whether the topic contains a mapping to another message.

protected boolean required
          Specifies whether the message is required.

protected MessageSignature signature
          The signature of the message.

protected MultiPartValue topic
          The topic of this message.

protected int type
          The type of this message.

Fields inherited from class com.aendvari.cerberus.component.descriptor.ComponentProperty

access, description, name

Constructor Summary

ComponentMessage()
          Constructs a ComponentMessage instance.

ComponentMessage(ComponentMessage message)
          Constructs a ComponentMessage instance as a copy of the one supplied.

Method Summary

boolean getRequired()
          Returns the required state of this message.

MessageSignature getSignature()
          Returns the signature of this message.

MultiPartValue getTopic()
          Returns the topic of this message.

int getType()
          Returns the type of this message.

boolean isMapped()
          Returns the mapped status of this message.

void setMapped(boolean setMapped)
          Sets the mapped status of this message.

void setRequired(boolean setRequired)
          Sets the required state of this message.

void setType(int setType)
          Sets the type of this message.

Methods inherited from class com.aendvari.cerberus.component.descriptor.ComponentProperty

getAccess, getDescription, getName, setAccess, setDescription, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

type

protected int type

The type of this message. See Type for possible values.

required

protected boolean required

Specifies whether the message is required.

topic

protected MultiPartValue topic

The topic of this message.

mapped

protected boolean mapped

Specifies whether the topic contains a mapping to another message.

signature

protected MessageSignature signature

The signature of the message.

Constructor Detail