com.eibus.transport

Class Middleware

java.lang.Object

com.eibus.transport.Middleware

public class Middleware
extends java.lang.Object

Middleware is used to send bytes from and to other processes. This class abstracts as much as possible from the actual implementation issues of specific types of middleware. Each type of middleware is addressed by the protocol that occurs in a URI. (e.g. 'msmq' for Microsoft Message Queuing middleware, 'socket' for the cheap Cordys ESB implementation on top of java.net.Socket, 'MQSeries' for IBM MQ Series Integration, etc.).

Each Middleware object will create an Inbound Queue for each URI that it can receive messages from. These Inbound Queues are created by different TransportProviders, depending on the protocol in the URI. When a Middleware object is opened, you can receive Messages on it, and send Messages with it. For each Message that is received, the onReceive() method in the MessageListener object will be called. When a Message is sent, depending on the protocol in the URI a TransportProvider is used to create an Outbound Queue with which it can actually send the Message. For sending a Message, you have to specify either a specific URI, or the name of an entry that is registered in LDAP. This entry is supposed to have a list of URIs. These URIs are retrieved by the Middleware object through a call to the method LDAPDirectory.getURIs(name).

Version:

1.2

Author:

Thijs Petter

See Also:

com.eibus.transport.ITransportProvider, Message, MessageListener, com.eibus.transport.URI

Method Summary

Modifier and Type	Method and Description
IRouting	_getRoutingInstance(Target oTarget)
static boolean	_isCurrentThreadTransactional() Returns true if the message current thread is handling a message that was received on a transactional transport.
void	_onProblemClear(IManagedComponent managedComponent, IProblemDefinition problemDefinition, ILocalizableString message, java.lang.Object[] arguments)
void	_onProblemRaise(IManagedComponent managedComponent, IProblemDefinition problemDefinition, ILocalizableString message, java.lang.Object[] arguments)
void	close() Close the connections to the Cordys ESB
void	createManagedComponent(IManagedComponent parentComponent)
void	createManagedComponent(IManagedComponent parentComponent, java.lang.String name, ILocalizableString description)
void	createManagedComponent(IManagedComponent parentComponent, java.lang.String name, java.lang.String description) Deprecated. Use the localizable alternative instead.
java.lang.String	getAddress() Returns the first URI of any of the inbound queues.
java.lang.String[]	getAddresses() Retrieves an array of all URIs for which the Middleware object has inbound queues (i.e., on which it can receive messages).
LDAPDirectory	getDirectory() Returns the proxy to the Directory Service.
static Middleware	getInstance(java.lang.String name) Returns the middleware instance with the specified name, or null if it does not exist.
static Middleware	getInstance(java.lang.String name, MessageListener listener, LDAPDirectory directory) Create or get a Middleware abstraction object.
static Middleware	getInstance(java.lang.String name, MessageListener listener, LDAPDirectory directory, int threadMultiplier)
MessageListener	getListener()
int	getMaxConcurrentWorkers()
static java.util.Enumeration<java.lang.String>	getMiddlewareNames() Returns an Enumeration of the currently created Middleware instances.
java.lang.String	getName() Returns the name of this Middleware object.
java.lang.String	getNonTransactionalInboundURI() Returns the first URI of any of the NonTransactionalInboundURI
java.lang.String[]	getNonTransactionalInboundURIs() Deprecated.
java.lang.String	getTransactionalInboundURI() Returns the first URI of any of the TransactionalInboundURI
java.lang.String[]	getTransactionalInboundURIs() Deprecated.
long	getWorkerTimeout()
static boolean	isAuthenticated()
boolean	isClosed()
boolean	isOpen()
boolean	isStopAccepting()
void	open() Opens the Middleware object, i.e., from now on, incoming SOAP Messages can be expected.
void	send(Message message) Sends the Message object to any of the targets specified inside of it.
void	send(Message message, MessageOptions messageOptions)
void	send(java.lang.String[] targets, Message message) Deprecated.
void	send(java.lang.String[] targets, Message message, MessageOptions messageOptions) Deprecated.
static void	setCredentials(java.lang.String userName, java.lang.String passWord) Deprecated.
void	stopAcceptingMessages() This method stops accepting new messages but doesn't stop the consuming of new messages.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Middleware getInstance(java.lang.String name,
                                     MessageListener listener,
                                     LDAPDirectory directory)
                              throws ExceptionGroup,
                                     DirectoryException

Create or get a Middleware abstraction object.

Parameters:

name - The name for which to connect to the Middleware.

listener - The callback object that will be called when a Message comes in from the Middleware.

directory - The directory proxy used to retrieve directory information.

Returns:

The Middleware object. This is either newly created, or it is an already existing entry.

Throws:

LDAPException - If a failure happened in the communication with the LDAP server

ExceptionGroup - If no InboundQueues could be created for any of the URIs listed for the entry to be opened.

DirectoryException

getInstance

public static Middleware getInstance(java.lang.String name,
                                     MessageListener listener,
                                     LDAPDirectory directory,
                                     int threadMultiplier)
                              throws ExceptionGroup,
                                     DirectoryException

Throws:

ExceptionGroup

DirectoryException

getInstance

public static Middleware getInstance(java.lang.String name)

Returns the middleware instance with the specified name, or null if it does not exist. This does NOT create a new Middleware object.

getMiddlewareNames

public static java.util.Enumeration<java.lang.String> getMiddlewareNames()

Returns an Enumeration of the currently created Middleware instances.

getMaxConcurrentWorkers

public int getMaxConcurrentWorkers()

createManagedComponent

public void createManagedComponent(IManagedComponent parentComponent)

createManagedComponent

@Deprecated
public void createManagedComponent(IManagedComponent parentComponent,
                                                java.lang.String name,
                                                java.lang.String description)

Deprecated. Use the localizable alternative instead.

Parameters:

parentComponent -

name -

description -

createManagedComponent

public void createManagedComponent(IManagedComponent parentComponent,
                                   java.lang.String name,
                                   ILocalizableString description)

_onProblemRaise

public void _onProblemRaise(IManagedComponent managedComponent,
                            IProblemDefinition problemDefinition,
                            ILocalizableString message,
                            java.lang.Object[] arguments)

_onProblemClear

public void _onProblemClear(IManagedComponent managedComponent,
                            IProblemDefinition problemDefinition,
                            ILocalizableString message,
                            java.lang.Object[] arguments)

stopAcceptingMessages

public void stopAcceptingMessages()

This method stops accepting new messages but doesn't stop the consuming of new messages. The transactional workerthreads will also stop consuming.

isStopAccepting

public boolean isStopAccepting()

getName

public java.lang.String getName()

Returns the name of this Middleware object. This can be put in a SOAP Message header in the 'component' tag

Returns:

The name of the Middleware object.

getDirectory

public LDAPDirectory getDirectory()

Returns the proxy to the Directory Service.

Returns:

Proxy to the Directory Service.

getTransactionalInboundURIs

@Deprecated
public java.lang.String[] getTransactionalInboundURIs()

Deprecated.

Retrieves an array of all Transactional URIs for which the Middleware object has inbound queues.

getNonTransactionalInboundURIs

@Deprecated
public java.lang.String[] getNonTransactionalInboundURIs()

Deprecated.

Retrieves an array of all NonTransactional URIs for which the Middleware object has inbound queues.

Returns:

getTransactionalInboundURI

public java.lang.String getTransactionalInboundURI()

Returns the first URI of any of the TransactionalInboundURI

getNonTransactionalInboundURI

public java.lang.String getNonTransactionalInboundURI()

Returns the first URI of any of the NonTransactionalInboundURI

Returns:

getAddresses

public java.lang.String[] getAddresses()

Retrieves an array of all URIs for which the Middleware object has inbound queues (i.e., on which it can receive messages). These addresses can be put e.g. in the header of a SOAP Message as the reply-to field.

Returns:

An array containing the URIs on which this Middleware object can receive messages.

getAddress

public java.lang.String getAddress()

Returns the first URI of any of the inbound queues. This can be used in the 'reply-to' tag of a SOAP Message header.

Returns:

The uri that is not null, or null if there is not a non-null uri.

open

public void open()

Opens the Middleware object, i.e., from now on, incoming SOAP Messages can be expected. A Middleware object that has been closed cannot be re-opened. This will result in an IllegalStateException. If a Middleware object has been closed, it has been removed from the internal administration and a new Middleware object should be retrieved through the getInstance method.

Throws:

java.lang.IllegalStateException - if close() method has been called on the middleware object.

isOpen

public boolean isOpen()

close

public void close()

Close the connections to the Cordys ESB

isClosed

public boolean isClosed()

send

@Deprecated
public void send(java.lang.String[] targets,
                              Message message)
                       throws ExceptionGroup

Deprecated.

Sets the targets in the message and calls the send method with one parameter.

Throws:

ExceptionGroup

send

@Deprecated
public void send(java.lang.String[] targets,
                              Message message,
                              MessageOptions messageOptions)
                       throws ExceptionGroup

Deprecated.

Sets the targets in the message and calls the send method with one parameter.

Throws:

ExceptionGroup

send

public void send(Message message,
                 MessageOptions messageOptions)
          throws ExceptionGroup

Throws:

ExceptionGroup

send

public void send(Message message)
          throws ExceptionGroup

Sends the Message object to any of the targets specified inside of it. A target string should either have a URI syntax, or be a name of a directory entry that will return uri strings when the method LDAPDirectory.getURIs(target) is called. The message will be sent to the first one of all possible uris that can be retrieved this way and for which a middleware connection can be found that actually sends the message. If the message cannot be sent to any of the supposed targets, every exception that occured will be packed in the ExceptionGroup that is thrown.

Throws:

ExceptionGroup - contains all the exceptions that occured while trying to send the message

_getRoutingInstance

public IRouting _getRoutingInstance(Target oTarget)

setCredentials

@Deprecated
public static void setCredentials(java.lang.String userName,
                                               java.lang.String passWord)
                                        throws CredentialsFailedException

Deprecated.

Throws:

CredentialsFailedException

isAuthenticated

public static boolean isAuthenticated()

_isCurrentThreadTransactional

public static boolean _isCurrentThreadTransactional()

Returns true if the message current thread is handling a message that was received on a transactional transport.

Returns:

true if the message current thread is handling a message that was received on a transactional transport; false otherwise.

getListener

public MessageListener getListener()

getWorkerTimeout

public long getWorkerTimeout()