jadex.bridge

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.
void	deliverMessage(Map message, String msgtype, IComponentIdentifier[] receivers) Deliver a message to some components.
String[]	getAddresses() Get addresses of all transports.
String[]	getAddressSchemes() Get addresses of all transports.
Object	getCodecFactory() Get the codec factory
MessageType	getMessageType(String type) Get the message type.
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 message, MessageType msgtype, IComponentIdentifier sender, ClassLoader cl, byte[] codecids) Send a message.

Methods inherited from interface jadex.bridge.service.IService

getPropertyMap, getServiceIdentifier, isValid

Method Detail

sendMessage

IFuture<Void> sendMessage(Map message,
                        MessageType msgtype,
                        IComponentIdentifier sender,
                        ClassLoader cl,
                        byte[] codecids)

Send a message.

Parameters:

map - The message as key value pairs.

msgtype - The message type.

sender - The sender component identifier.

cl - The class loader used by the sending component (i.e. corresponding to classes of objects in the message map).

Returns:

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

deliverMessage

void deliverMessage(Map message,
                  String msgtype,
                  IComponentIdentifier[] receivers)

Deliver a message to some components.

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.

getAddresses

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.

getCodecFactory

Object getCodecFactory()

Get the codec factory

Returns:

The codec factory.