jadex.platform.service.message.transport

Interface ITransport

All Known Implementing Classes:

HttpRelayTransport, LocalTransport, NIOTCPTransport, TCPTransport

public interface ITransport

Interface for Jadex Standalone transports.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAddresses() Get the addresses of this transport.
java.lang.String[]	getServiceSchemas() Returns the prefixes of this transport
boolean	isApplicable(java.lang.String address) Test if a transport is applicable for the target address.
boolean	isNonFunctionalSatisfied(java.util.Map<java.lang.String,java.lang.Object> nonfunc, java.lang.String address) Test if a transport satisfies the non-functional requirements.
void	sendMessage(java.lang.String address, ISendTask task) Send a message to the given address.
jadex.commons.future.IFuture<java.lang.Void>	shutdown() Perform cleanup operations (if any).
jadex.commons.future.IFuture<java.lang.Void>	start() Start the transport.

Method Detail

start

jadex.commons.future.IFuture<java.lang.Void> start()

Start the transport.

shutdown

jadex.commons.future.IFuture<java.lang.Void> shutdown()

Perform cleanup operations (if any).

isApplicable

boolean isApplicable(java.lang.String address)

Test if a transport is applicable for the target address.

Returns:

True, if the transport is applicable for the address.

isNonFunctionalSatisfied

boolean isNonFunctionalSatisfied(java.util.Map<java.lang.String,java.lang.Object> nonfunc,
                                 java.lang.String address)

Test if a transport satisfies the non-functional requirements.

Parameters:

nonfunc - The non-functional requirements (name, value).

address - The transport address.

Returns:

True, if the transport satisfies the non-functional requirements.

sendMessage

void sendMessage(java.lang.String address,
                 ISendTask task)

Send a message to the given address. This method is called multiple times for the same message, i.e. once for each applicable transport / address pair. The transport should asynchronously try to connect to the target address (or reuse an existing connection) and afterwards call-back the ready() method on the send task. The send manager calls the obtained send commands of the transports and makes sure that the message gets sent only once (i.e. call send commands sequentially and stop, when a send command finished successfully). All transports may keep any established connections open for later messages.

Parameters:

address - The address to send to.

task - A task representing the message to send.

getServiceSchemas

java.lang.String[] getServiceSchemas()

Returns the prefixes of this transport

Returns:

Transport prefixes.

getAddresses

java.lang.String[] getAddresses()

Get the addresses of this transport.

Returns:

An array of strings representing the addresses of this message transport mechanism.