jadex.bridge.service.types.message

Class MessageType

java.lang.Object

jadex.bridge.service.types.message.MessageType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FIPAMessageType

public abstract class MessageType
extends Object
implements Serializable

Representation of characteristics of a certain type of messages (e.g. fipa messages).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageType.ParameterSpecification A class representing a parameter or parameter set specification.

Constructor Summary

Constructors

Constructor and Description
MessageType(String name, MessageType.ParameterSpecification[] params, MessageType.ParameterSpecification[] paramsets) Create a new message type.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	createReply(Map<String,Object> msg) Create a reply to a message.
boolean	equals(Object o) Test if two message types are equal (based on the name).
IContentCodec	findContentCodec(IContentCodec[] codecs, IMessageAdapter message, String param) Find a matching content codec for a given message parameter.
IContentCodec	findContentCodec(IContentCodec[] codecs, Map message, String param) Find a matching content codec for a given message parameter.
abstract String[]	getCodecInfos(String name) Get the en/decode info (important) for a parameter/set.
MessageType.ParameterSpecification[]	getConversationIdentifiers() Get the conversation identifiers.
abstract String	getIdIdentifier() Get the identifier for fetching the message id.
String	getName() The name of the message type.
abstract String	getNonFunctionalPropertiesIdentifier() Get the identifier for fetching the non-functional properties.
MessageType.ParameterSpecification	getParameter(String name) Get a parameter specification by name (including parameter sets).
String[]	getParameterNames() Get all parameter names.
MessageType.ParameterSpecification[]	getParameters() Get the default parameters.
MessageType.ParameterSpecification	getParameterSet(String name) Get a parameter specification by name (including parameter sets).
String[]	getParameterSetNames() Get all parameter set names.
MessageType.ParameterSpecification[]	getParameterSets() Get the default parameter sets.
abstract String	getRealReceiverIdentifier() Get the identifier for fetching the resource identifier id.
abstract String	getReceiverIdentifier() Get the identifier for fetching the receivers.
abstract String	getResourceIdIdentifier() Get the identifier for fetching the resource identifier id.
abstract String	getSenderIdentifier() Get the identifier for fetching the sender.
abstract String	getSimplifiedRepresentation(Map<String,Object> msg) Get a simplified human readable representation of the message content.
abstract String	getTimestampIdentifier() Get the identifier for fetching the send date.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageType

public MessageType(String name,
           MessageType.ParameterSpecification[] params,
           MessageType.ParameterSpecification[] paramsets)

Create a new message type.

Parameters:

name - The name of the message type.

Method Detail

getName

public String getName()

The name of the message type.

getParameters

public MessageType.ParameterSpecification[] getParameters()

Get the default parameters.

getParameterSets

public MessageType.ParameterSpecification[] getParameterSets()

Get the default parameter sets.

getParameterNames

public String[] getParameterNames()

Get all parameter names.

Returns:

The parameter names.

getParameterSetNames

public String[] getParameterSetNames()

Get all parameter set names.

Returns:

The parameter set names.

getParameter

public MessageType.ParameterSpecification getParameter(String name)

Get a parameter specification by name (including parameter sets).

Returns:

The parameter specification.

getParameterSet

public MessageType.ParameterSpecification getParameterSet(String name)

Get a parameter specification by name (including parameter sets).

Returns:

The parameter specification.

getConversationIdentifiers

public MessageType.ParameterSpecification[] getConversationIdentifiers()

Get the conversation identifiers.

Returns:

The conversation identifiers.

getReceiverIdentifier

public abstract String getReceiverIdentifier()

Get the identifier for fetching the receivers.

Returns:

The receiver identifier.

getSenderIdentifier

public abstract String getSenderIdentifier()

Get the identifier for fetching the sender.

Returns:

The sender identifier.

getIdIdentifier

public abstract String getIdIdentifier()

Get the identifier for fetching the message id. Support for message identifiers is optional.

Returns:

The id identifier.

getTimestampIdentifier

public abstract String getTimestampIdentifier()

Get the identifier for fetching the send date. Support for date is optional.

Returns:

The send date identifier.

getResourceIdIdentifier

public abstract String getResourceIdIdentifier()

Get the identifier for fetching the resource identifier id.

Returns:

The resource identifier id.

getNonFunctionalPropertiesIdentifier

public abstract String getNonFunctionalPropertiesIdentifier()

Get the identifier for fetching the non-functional properties.

Returns:

The non-functional properties.

getRealReceiverIdentifier

public abstract String getRealReceiverIdentifier()

Get the identifier for fetching the resource identifier id.

Returns:

The resource identifier id.

getCodecInfos

public abstract String[] getCodecInfos(String name)

Get the en/decode info (important) for a parameter/set.

Parameters:

The - name of the parameter/set.

Returns:

The en/decode infos.

getSimplifiedRepresentation

public abstract String getSimplifiedRepresentation(Map<String,Object> msg)

Get a simplified human readable representation of the message content.

Parameters:

The - message.

Returns:

The simplified representation.

findContentCodec

public IContentCodec findContentCodec(IContentCodec[] codecs,
                             Map message,
                             String param)

Find a matching content codec for a given message parameter.

Parameters:

codecs - The available codecs.

message - The message.

param - The parameter to be (en/de)coded.

findContentCodec

public IContentCodec findContentCodec(IContentCodec[] codecs,
                             IMessageAdapter message,
                             String param)

Find a matching content codec for a given message parameter.

Parameters:

codecs - The available codecs.

message - The message.

param - The parameter to be (en/de)coded.

equals

public boolean equals(Object o)

Test if two message types are equal (based on the name).

Overrides:

equals in class Object

createReply

public Map<String,Object> createReply(Map<String,Object> msg)

Create a reply to a message.

Parameters:

mag - The message.

Returns:

The reply.