jadex.bridge.service.types.message

Interface IMessageService

All Superinterfaces:

IService

public interface IMessageService
extends IService

The interface for the message service. It is responsible for managing the transports and sending/delivering messages.

Field Summary

Fields inherited from interface jadex.bridge.service.IService

EMPTY_SERVICES

Method Summary

Methods

Modifier and Type	Method and Description
IFuture<Void>	addContentCodec(IContentCodec codec) Add content codec type.
IFuture<Void>	addMessageCodec(Class codec) Add message codec type.
IFuture<Void>	addMessageListener(IMessageListener listener, IFilter filter) Add a message listener.
IFuture<IInputConnection>	createInputConnection(IComponentIdentifier sender, IComponentIdentifier receiver, Map<String,Object> nonfunc) Create a virtual input connection.
IFuture<IOutputConnection>	createOutputConnection(IComponentIdentifier sender, IComponentIdentifier receiver, Map<String,Object> nonfunc) Create a virtual output connection.
void	deliverMessage(Object msg) Deliver a raw message to some components.
IFuture<String[]>	getAddresses() Get addresses of all transports.
String[]	getAddressSchemes() Get addresses of all transports.
IFuture<Map<Byte,ICodec>>	getAllCodecs() Get the codecs with message codecs.
IFuture<ICodec[]>	getDefaultCodecs() Get the default codecs.
MessageType	getMessageType(String type) Get the message type.
IFuture<Void>	refreshAddresses() Announce that addresses of transports might have changed.
IFuture<Void>	removeContentCodec(IContentCodec codec) Remove content codec type.
IFuture<Void>	removeMessageCodec(Class codec) Remove message codec type.
IFuture<Void>	removeMessageListener(IMessageListener listener) Remove a message listener.
IFuture<Void>	sendMessage(Map<String,Object> message, MessageType msgtype, IComponentIdentifier sender, IResourceIdentifier rid, IComponentIdentifier realrec, byte[] codecids) Send a message.
IFuture<IComponentIdentifier>	updateComponentIdentifier(IComponentIdentifier cid) Update component identifier with current addresses.

Methods inherited from interface jadex.bridge.service.IService

getPropertyMap, getServiceIdentifier, isValid

Method Detail

sendMessage

IFuture<Void> sendMessage(Map<String,Object> message,
                        MessageType msgtype,
                        IComponentIdentifier sender,
                        IResourceIdentifier rid,
                        IComponentIdentifier realrec,
                        byte[] codecids)

Send a message.

Parameters:

message - The message as key value pairs.

msgtype - The message type.

sender - The sender component identifier.

rid - The resource identifier used by the sending component (i.e. corresponding to classes of objects in the message map).

realrec - The real receiver if different from the message receiver (e.g. message to rms encapsulating service call to other component).

codecids - The codecs to use for encoding (if different from default).

nonfunc - The non functional properties that need to be preserved.

Returns:

Future that indicates an exception when messages could not be delivered to components.

deliverMessage

void deliverMessage(Object msg)

Deliver a raw message to some components.

Parameters:

msg - Byte array containing a message in the form {prolog}{data}.

createOutputConnection

IFuture<IOutputConnection> createOutputConnection(IComponentIdentifier sender,
                                                IComponentIdentifier receiver,
                                                Map<String,Object> nonfunc)

Create a virtual output connection.

createInputConnection

IFuture<IInputConnection> createInputConnection(IComponentIdentifier sender,
                                              IComponentIdentifier receiver,
                                              Map<String,Object> nonfunc)

Create a virtual input connection.

addMessageListener

IFuture<Void> addMessageListener(IMessageListener listener,
                               IFilter filter)

Add a message listener.

Parameters:

listener - The change listener.

filter - An optional filter to only receive notifications for matching messages.

removeMessageListener

IFuture<Void> removeMessageListener(IMessageListener listener)

Remove a message listener.

Parameters:

listener - The change listener.

addContentCodec

IFuture<Void> addContentCodec(IContentCodec codec)

Add content codec type.

Parameters:

codec - The codec type.

removeContentCodec

IFuture<Void> removeContentCodec(IContentCodec codec)

Remove content codec type.

Parameters:

codec - The codec type.

addMessageCodec

IFuture<Void> addMessageCodec(Class codec)

Add message codec type.

Parameters:

codec - The codec type.

removeMessageCodec

IFuture<Void> removeMessageCodec(Class codec)

Remove message codec type.

Parameters:

codec - The codec type.

refreshAddresses

IFuture<Void> refreshAddresses()

Announce that addresses of transports might have changed.

updateComponentIdentifier

IFuture<IComponentIdentifier> updateComponentIdentifier(IComponentIdentifier cid)

Update component identifier with current addresses.

Parameters:

cid - The component identifier.

Returns:

The component identifier.

getAddresses

IFuture<String[]> getAddresses()

Get addresses of all transports.

Returns:

The addresses of all transports.

getAddressSchemes

String[] getAddressSchemes()

Get addresses of all transports.

Returns:

The address schemes of all transports.

getMessageType

MessageType getMessageType(String type)

Get the message type.

Parameters:

type - The type name.

Returns:

The message type.

getAllCodecs

IFuture<Map<Byte,ICodec>> getAllCodecs()

Get the codecs with message codecs.

Returns:

The codec factory.

getDefaultCodecs

IFuture<ICodec[]> getDefaultCodecs()

Get the default codecs.

Returns:

The default codecs.