kaos.core.csi.transport
Interface TransportSupport

All Known Implementing Classes:

TransportSupportImpl

public interface TransportSupport

Defines the operations to bind an entity, whose Locator is given to the specified transport and to send messages via a given transport.

Method Summary

void	bindMsgListenerToTransport(MessageListener listener, java.lang.String listenerName, Locator locator, java.lang.String transportName) Bind the specified MessageListener to the given Locator.
MessageReceiver	bindToTransport(java.lang.String receiverName, Locator receiverLocator, java.lang.String transportName)
Locator	createLocator(java.lang.String name, JasBean agentInitInfo, java.lang.String transportName)
KAoSServiceRoot	getServiceRoot(java.lang.String transportName) Return KAoSServiceRoot for the specified transportName.
java.util.List	getSupportedTransportsNames() Return the names of the currently supported transports.
boolean	isTransportSupported(java.lang.String name) Answer true if the given transport is supported, otherwise, answer false.
void	sendMessageTo(Locator senderLocator, Locator receiverLocator, java.lang.String senderName, java.lang.String receiverName, java.lang.String fipaPerformative, java.io.Serializable content) Send the given message content to the receiver, whose Locator is given.
void	sendMessageTo(Locator senderLocator, Locator receiverLocator, java.lang.String senderName, java.lang.String receiverName, java.lang.String fipaPerformative, java.io.Serializable content, java.lang.String transportName) Send the given message content to the receiver, whose Locator is given.

Method Detail

createLocator

Locator createLocator(java.lang.String name,
                      JasBean agentInitInfo,
                      java.lang.String transportName)

bindMsgListenerToTransport

void bindMsgListenerToTransport(MessageListener listener,
                                java.lang.String listenerName,
                                Locator locator,
                                java.lang.String transportName)
                                throws NotLocatableException,
                                       TransportFailure

Bind the specified MessageListener to the given Locator.

Parameters:

listener - MessageListener to receive messages using the given Locator.

listenerName - String containing the name of the receiver.

locator - Locator to be used to receive messages.

transportName - String indicating which transport to use

Throws:

NotLocatableException - if locator is not a local locator.

TransportFailure - if the binding process fails

bindToTransport

MessageReceiver bindToTransport(java.lang.String receiverName,
                                Locator receiverLocator,
                                java.lang.String transportName)
                                throws NotLocatableException,
                                       TransportFailure

Throws:

NotLocatableException

TransportFailure

sendMessageTo

void sendMessageTo(Locator senderLocator,
                   Locator receiverLocator,
                   java.lang.String senderName,
                   java.lang.String receiverName,
                   java.lang.String fipaPerformative,
                   java.io.Serializable content,
                   java.lang.String transportName)
                   throws NotLocatableException,
                          TransportFailure

Send the given message content to the receiver, whose Locator is given.

Parameters:

senderLocator - Locator of the sender.

receiverLocator - Locator of the receiver.

senderName - String containing the name of the sender.

receiverName - String containing the name of the receiver.

fipaPerformative - String containing the FIPA performative describing the message intent.

content - Serializable containing the message content.

transportName - String containing the name of the transport to be used.

Throws:

NotLocatableException - if the receiver cannot be located.

TransportFailure - if transport fails during message send.

sendMessageTo

void sendMessageTo(Locator senderLocator,
                   Locator receiverLocator,
                   java.lang.String senderName,
                   java.lang.String receiverName,
                   java.lang.String fipaPerformative,
                   java.io.Serializable content)
                   throws NotLocatableException,
                          TransportFailure

Send the given message content to the receiver, whose Locator is given.

Parameters:

senderLocator - Locator of the sender.

receiverLocator - Locator of the receiver.

senderName - String containing the name of the sender.

receiverName - String containing the name of the receiver.

fipaPerformative - String containing the FIPA performative describing the message intent.

content - Serializable containing the message content.

Throws:

NotLocatableException - if the receiver cannot be located.

TransportFailure - if transport fails during message send.

getSupportedTransportsNames

java.util.List getSupportedTransportsNames()

Return the names of the currently supported transports.

Returns:

a List containing Strings representing names of supported transports.

isTransportSupported

boolean isTransportSupported(java.lang.String name)

Answer true if the given transport is supported, otherwise, answer false.

Parameters:

name - String containing the name of the transport in question.

Returns:

a boolean indicating if the given transport is supported.

getServiceRoot

KAoSServiceRoot getServiceRoot(java.lang.String transportName)

Return KAoSServiceRoot for the specified transportName.

Parameters:

transportName - String containing the name of the transport to create a KAoSServiceRoot for.

Returns:

a KAoSServiceRoot specific for the transportName.