kaos.core.service.transport.grid
Class GridMessageTransportService

java.lang.Object
  kaos.core.service.transport.grid.GridMessageTransportService

public class GridMessageTransportService
extends java.lang.Object

Field Summary

static java.lang.String	FACTORY_CLASS A well known key used by the transport service Service Provider Interface (SPI).
static java.lang.String	SERVICE_ID_FILE_NAME

Constructor Summary

GridMessageTransportService()
Constructors

GridMessageTransportService(ServiceProperties env)

Method Summary

TransportMessage	createTransportMessage() Create an empty TransportMessage suitable for attribute population and use.
ServiceProperties	getServiceProperties() Returns the service properties associated with the transport service.
boolean	isSupported(Locator l) Determines if the specified locator is supported by the transport service.
Locator	newLocalLocator() Returns a new local locator whose transport type is supported by the transport service.
Locator	newLocalLocator(JasBean env) Returns a new local locator whose transport type is supported by the transport service and has the provided environment properties.
MessageReceiver	newMessageReceiver() Returns a new MessageReceiver suitable for local binding.
MessageReceiver	newMessageReceiver(JasBean env) Returns a new MessageReceiver suitable for local binding having the specified properties.
MessageSender	newMessageSender() Returns a new MessageSender capable of binding to message receivers supported by this transport service.
MessageSender	newMessageSender(JasBean env) Returns a new MessageSender capable of binding to message receivers supported by this transport service and having the specified properties.
void	sendMessage(TransportMessage msg) A convenience method directed to a message sending endpoint specified by the message receiver's locator.
void	sendMessage(TransportMessage msg, Locator loc) A convenience method directed to a message sending endpoint specified by the provided locator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FACTORY_CLASS

public static java.lang.String FACTORY_CLASS

A well known key used by the transport service Service Provider Interface (SPI).

SERVICE_ID_FILE_NAME

public static java.lang.String SERVICE_ID_FILE_NAME

Constructor Detail

GridMessageTransportService

public GridMessageTransportService()

Constructors

GridMessageTransportService

public GridMessageTransportService(ServiceProperties env)

Method Detail

getServiceProperties

public ServiceProperties getServiceProperties()
                                       throws TransportFailure

Returns the service properties associated with the transport service.

Returns:

the transport's service properties.

Throws:

TransportFailure - if any transport related failure occurs.

createTransportMessage

public TransportMessage createTransportMessage()

Create an empty TransportMessage suitable for attribute population and use. The returned value may be null.

Returns:

an empty TransportMessage

isSupported

public boolean isSupported(Locator l)
                    throws TransportFailure

Determines if the specified locator is supported by the transport service.

Parameters:

l - the locator to test for supportability.

Returns:

true if the specified locator is supported.

Throws:

TransportFailure - if any transport related failure occurs.

newLocalLocator

public Locator newLocalLocator()
                        throws TransportFailure

Returns a new local locator whose transport type is supported by the transport service.

Returns:

a Locator.

Throws:

TransportFailure - if any transport related failure occurs.

newLocalLocator

public Locator newLocalLocator(JasBean env)
                        throws TransportFailure

Returns a new local locator whose transport type is supported by the transport service and has the provided environment properties.

Throws:

TransportFailure - if any transport related failure occurs.

newMessageSender

public MessageSender newMessageSender()
                               throws TransportFailure

Returns a new MessageSender capable of binding to message receivers supported by this transport service.

Returns:

MessageSender a message sender with general capabilities.

Throws:

TransportFailure - if any transport related failure occurs.

newMessageSender

public MessageSender newMessageSender(JasBean env)
                               throws TransportFailure

Returns a new MessageSender capable of binding to message receivers supported by this transport service and having the specified properties.

Parameters:

env - specific attributes required of the returned message sender.

Throws:

TransportFailure - if any transport related failure occurs.

newMessageReceiver

public MessageReceiver newMessageReceiver()
                                   throws TransportFailure

Returns a new MessageReceiver suitable for local binding.

Returns:

MessageReceiver a message receiver with general capabilities.

Throws:

TransportFailure - if any transport related failure occurs.

newMessageReceiver

public MessageReceiver newMessageReceiver(JasBean env)
                                   throws TransportFailure

Returns a new MessageReceiver suitable for local binding having the specified properties.

Parameters:

env - specific attributes required of the returned message receiver.

Returns:

MessageReceiver a message receiver with specific capabilities.

Throws:

TransportFailure - if any transport related failure occurs.

sendMessage

public void sendMessage(TransportMessage msg)
                 throws NotLocatableException,
                        TransportFailure

A convenience method directed to a message sending endpoint specified by the message receiver's locator.

Parameters:

msg - the message to send to the receiving agent.

Throws:

NotLocatableException - if a message transport service is not available supporting the specified environment.

TransportFailure - if any transport related failure occurs.

sendMessage

public void sendMessage(TransportMessage msg,
                        Locator loc)
                 throws NotLocatableException,
                        TransportFailure

A convenience method directed to a message sending endpoint specified by the provided locator.

Parameters:

msg - the message to send to the receiving agent.

loc - the locator describing the remote message receiving endpoint.

Throws:

NotLocatableException - if a message transport service is not available supporting the specified environment.

TransportFailure - if any transport related failure occurs.