kaos.core.service.transport
Class BufferedMessageTransportService

java.lang.Object
  extended by kaos.core.service.transport.BufferedMessageTransportService

public class BufferedMessageTransportService
extends java.lang.Object

Since:
1.0
Author:
KAoS Team

Constructor Summary
BufferedMessageTransportService(MessageTransportService mts)
           
 
Method Summary
 TransportMessage createTransportMessage()
           
 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 l)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BufferedMessageTransportService

public BufferedMessageTransportService(MessageTransportService mts)
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.

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. The transport service uses its own values for host name and port# of the Corba name server to set the corresponding properties in the locator. The locator doesn't have a name, so using it without setting its name will cause failure.

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.

Parameters:
env - The jasbean object whose properties will be used to set this locator's corresponding properties.
Returns:
a Locator.
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.
Returns:
MessageSender a message sender with specified properties.
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 specified attributes.
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 l)
                 throws NotLocatableException,
                        TransportFailure
Throws:
NotLocatableException
TransportFailure

createTransportMessage

public TransportMessage createTransportMessage()