com.eibus.connector.nom

Class Connector

java.lang.Object

com.eibus.connector.nom.Connector

All Implemented Interfaces:

MessageListener

public class Connector
extends java.lang.Object
implements MessageListener

A Connector holds an XML connection to Cordys ESB. This means, that you can use it to send and receive SOAP messages with it.

A connection to the Cordys ESB is always made for a SOAP Node. SOAPNodes are registered in a Directory Service, so that other applications can find it too. When you create a Connector, the Cordys ESB software will lookup what physical connection to open to the Cordys ESB. Starting from the moment that you call the open() method on the Connector, other applications on the Cordys ESB can send SOAPMessages to you, and you can send SOAPMessages to other applications.

A Connector can be used in a client oriented application (in which you ask things to other SOAP Nodes) or in a service oriented application (in which you react on incoming SOAPMessages of clients).
When you build a service oriented application, you have to implement a SOAPMessageListener that will handle incoming SOAPMessages. You have to register the listener in the ListenerPool of the Connector. When the Connector receives a SOAP message, it will look in the message for a message id. If it finds the message id, it will check in the ListenerPool whether there is a SOAPMessageListener subscribed on this specific message id. If there is no listener subscribed, the SOAP message will be deleted without notification. You can register listeners per message id. There is also an option to register a default listener, that will handle incoming SOAP Messages for which no listener is registered. If you consider building a service oriented application, take a look at ApplicationConnector, since extending this class will take automatic care of protocol specific issues, that must be handled in a SOAP message. ApplicationConnector allows you to concentrate on your application specific contents of incoming SOAP messages.
When you build a client application, a typical communication scenario is that of sending a SOAP message to the Cordys ESB and then hold the calling Thread until an answer is arrived. This is called synchronous communication. The methods sendAndWait are designed for this. Underlying, these methods make use of the send methods, since the transport abstraction layers of the Cordys ESB only support asynchronous communication. If you call a sendAndWait() method, this call will block either until the answer comes back, or until a timeout has expired. You can set the timeout in general, or specify it in the call. If the timeout is 0, the method call will wait indefinitely if no answer comes back.

Any SOAP message that comes in from the Cordys ESB is parsed first. The SOAP message arrives as a Message object, which is parsed with the Document of the Connector. For performance reasons, this Document class is implemented in C. Object creation in Java is very expensive, when you compare it to C memory allocation. When you represent each node in an XML Document as a Java Object, a lot of these objects have to be created. Therefore, the C implementation will create 'C objects' that are represented in Java as int. A SOAP message is represented as an int. You can manipulate your SOAP message with the functions in the XML package and in the CO package.
Each Connector has only one Document, that is used for every XML manipulation. You are encouraged to use this same Document that you can retrieve with the getDocument() method to do your XML manipulations as well.

If you call the close() method on the Connector, it has become invalid and you cannot use it anymore. It is also removed from the internal component cache. Any subsequent call on the Connector will result in an IllegalStateException. If you call any of the send methods on the Connector before it has been opened, this will also result in an IllegalStateException. If you call the open() method on an already opened Connector, nothing will happen.

See Also:

com.eibus.connector.dom.Connector, Middleware, Message, ListenerPool, ApplicationConnector, Document

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Connector.SOAPMethod This class wraps a SOAP method through the NOM/DOM wrapper.

Field Summary

Fields

Modifier and Type	Field and Description
static int	USE_MULTI_DOC
static int	USE_SINGLE_DOC

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel(int envelope, boolean restartServer) Retrieves the message id from the header and calls the cancel(messageId, restartServer) method.
void	cancel(java.lang.String messageId, boolean restartServer) Cancels an outstanding message with the specified identifier.
void	close() Closes the connection to the Cordys ESB.
void	createManagedComponent(IManagedComponent parentComponent)
void	createManagedComponent(IManagedComponent parentComponent, java.lang.String name, java.lang.String description)
int	createSOAPMessage(java.lang.String uri) The SOAP:Body node is returned from this function.
int	createSOAPMessage(java.lang.String receiver, Identity senderIdentity, java.lang.String uri) The SOAP:Body node is returned from this function.
int	createSOAPMessage(java.lang.String receiver, java.lang.String uri) Creates a new SOAP Envelope node, with a header and a body in it.
int	createSOAPMessage(java.lang.String receiver, java.lang.String senderUser, java.lang.String uri) The SOAP:Body node is returned from this function.
int	createSOAPMessageWithPrefix(java.lang.String receiver, Identity senderIdentity, java.lang.String uri, java.lang.String prefix) The :Body node is returned from this function.For example prefix is "SOAP".
int	createSOAPMessageWithPrefix(java.lang.String receiver, java.lang.String senderUser, java.lang.String uri, java.lang.String prefix) The :Body node is returned from this function.
int	createSOAPMethod(java.lang.String namespace, java.lang.String method) Creates the method node inside the body node
int	createSOAPMethod(java.lang.String organization, java.lang.String namespace, java.lang.String method) Creates the method node inside the body node
int	createSOAPMethod(java.lang.String organizationalUser, java.lang.String organization, java.lang.String namespace, java.lang.String method) Creates the method node inside the body node.
int	createSOAPMethodEx(java.lang.String namespace, java.lang.String method, java.lang.String organization, java.lang.String senderUser, java.lang.String receiver, java.lang.String uri) Creates the method node inside the body node
static java.util.Enumeration<Connector>	getConnectors() Returns an Enumeration of the currently created connectors.
Document	getDocument() Deprecated. since BCP C.1, please use Node.getDocument() OR Node.getDocument()
static Connector	getInstance(java.lang.String name) Returns a Connector for the name.
static Connector	getInstance(java.lang.String name, int threadMultiplier)
ListenerPool	getListenerPool() Returns the listener administration.
Middleware	getMiddleware() Returns the middleware object that is being used by this connector to send messages to the Cordys ESB and receives messages from the Cordys ESB.
long	getTimeout() Synchronous calls 'to the Cordys ESB' suspend their Thread until an answer arrives, or until a timer has expired.
static boolean	isAuthenticated()
boolean	isClosed() Indicates if the Connector is closed.
boolean	isOpen() Indicates if the Connector is open.
void	onReceive(Message message) Is called by the Cordys ESB when a message comes in.
void	open() Opens the connection to the Cordys ESB.
void	send(int envelope) Send a message to the Cordys ESB.
void	send(int envelope, MessageOptions messageOptions) Send a message to the Cordys ESB.
void	sendAndCallback(int envelope, SOAPMessageListener listener) Send a message to the Cordys ESB.
void	sendAndCallback(int envelope, SOAPMessageListener listener, MessageOptions messageoptions) Send a message with message options ( NON_TRANSACTIONAL_REPLY or TRANSACTIONAL_REPLY)
void	sendAndCallbackEx(int request, SOAPMessageListener listener, Identity identity) Populate the request with missing routing information, then send request.
int	sendAndWait(int envelope) Send a message to the Cordys ESB and suspend the current thread until a message comes back, or until the default timeout period has expired.
int	sendAndWait(int envelope, long timeout) Send a message to the Cordys ESB and suspend the current thread until a message comes back, or until the timeout period has expired.
int	sendAndWaitEx(int request, Identity identity) Populate the request with missing routing information, then send request and wait for response.
int	sendAndWaitEx(int request, long timeout, Identity identity) Populate the request with missing routing information, then send request and wait for response.
void	sendEx(int request, Identity identity) Populate the request with missing routing information, then send request.
void	sendEx(int request, MessageOptions messageOptions, Identity identity) Populate the request with missing routing information, then send request.
static void	setCredentials(java.lang.String userName, java.lang.String password) Deprecated.
void	setDocPerThreadConfig(int config) Set the configuration option for having a nom Document per thread.
void	setTimeout(long timeout) Synchronous calls 'to the Cordys ESB' suspend their Thread until an answer arrives, or until a timer has expired.
Connector.SOAPMethod	wrapSOAPMethod(int bodyNode) Wraps the given body node in a wrapper object that provides XML DOM interfaces over it and provides memory management.

Methods inherited from class java.lang.Object

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

Field Detail

USE_MULTI_DOC

public static final int USE_MULTI_DOC

See Also:

Constant Field Values

USE_SINGLE_DOC

public static final int USE_SINGLE_DOC

See Also:

Constant Field Values

Method Detail

getInstance

public static Connector getInstance(java.lang.String name)
                             throws ExceptionGroup,
                                    DirectoryException

Returns a Connector for the name. If a connector was already created, that one is returned, otherwise a new instance is created.

 // This returns the connector instance "Anonymous Client" if already exists
 // or else creates a new instance. This method only returns instance of connector
 // A connection should be open explicitly by calling open() method if it is not already open.
 Connector connector = Connector.getInstance("Anonymous Client");
 

Parameters:

name - The name under which the connector will connect to the Cordys ESB (either existing in LDAP or not). If the name is not in the LDAP server, then an anonymous connector is created, otherwise the connection points for listed for the entry in the LDAP server are opened.

Throws:

LDAPException - If error happened in the communication with the LDAP server. Passed on from the method Middleware.getInstance().

ExceptionGroup - Contains all exceptions that occured during creation of a connection to the underlying middleware. Passed on from the method Middleware.getInstance().

DirectoryException

getInstance

public static Connector getInstance(java.lang.String name,
                    int threadMultiplier)
                             throws ExceptionGroup,
                                    DirectoryException

Throws:

ExceptionGroup

DirectoryException

getConnectors

public static java.util.Enumeration<Connector> getConnectors()

Returns an Enumeration of the currently created connectors.

  java.util.Enumeration enumeration = Connector.getConnectors();
 

createManagedComponent

public void createManagedComponent(IManagedComponent parentComponent)

createManagedComponent

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

open

public void open()

Opens the connection to the Cordys ESB. Only after this method is called, SOAP Messages can be received.

  Connector connector = Connector.getInstance("Anonymous Client");
  if(! connector.isOpen()) // it is always recommended to check whether the connection is already open
      connector.open();

Throws:

java.lang.IllegalStateException - if the connector is closed.

isOpen

public boolean isOpen()

Indicates if the Connector is open. A connector is either UNINITIALIZED, OPENED or CLOSED.

Returns:

true if the Connector is open, false otherwise (i.e. if it is uninitialized or closed).

isClosed

public boolean isClosed()

Indicates if the Connector is closed. A connector is either UNINITIALIZED, OPENED or CLOSED.

Returns:

true if the Connector is close, false otherwise (i.e. if it is uninitialized or opened).

getMiddleware

public Middleware getMiddleware()

Returns the middleware object that is being used by this connector to send messages to the Cordys ESB and receives messages from the Cordys ESB.

      Connector connector = Connector.getInstance("Anonymous Client");
      Middleware middleWare = connector.getMiddleWare();
  

Returns:

The Middleware object used for transportation of messages.

getDocument

@Deprecated
public Document getDocument()

Deprecated. since BCP C.1, please use Node.getDocument() OR Node.getDocument()

Returns the document that this connector uses to parse incoming XML documents.

 Connector connector = Connector.getInstance("Anonymous Client");
 Document document = connector.getDocument();

Returns:

The Document used to parse incoming messages

setTimeout

public void setTimeout(long timeout)

Synchronous calls 'to the Cordys ESB' suspend their Thread until an answer arrives, or until a timer has expired. setTimeout() sets the default timeout for this timer.

Parameters:

timeout - The specified timeout period. Overrides current timeout period only if timeout>=0. If timeout==0, synchronous calls will block indefinitely, if no answer is received.

getTimeout

public long getTimeout()

Synchronous calls 'to the Cordys ESB' suspend their Thread until an answer arrives, or until a timer has expired. getTimeout() returns the default timeout for this timer.

getListenerPool

public ListenerPool getListenerPool()

Returns the listener administration. Call back objects for incoming messages must be registered in this pool. Usually a SOAP message is identified by its message id, and you can store a call back for each message id.

close

public void close()

Closes the connection to the Cordys ESB. After this call, the connector can no longer be used to send or receive messages.

onReceive

public void onReceive(Message message)

Is called by the Cordys ESB when a message comes in.

Specified by:

onReceive in interface MessageListener

Parameters:

message - The incoming message.

createSOAPMessage

public int createSOAPMessage(java.lang.String uri)

The SOAP:Body node is returned from this function.

Parameters:

uri - A specific address to which this SOAP message should be tried to sent first. Use this only if you want to send the message to a Soap Node that is not registered in the directory server and is also not running in this process.

Returns:

The SOAP:Body node

createSOAPMessage

public int createSOAPMessage(java.lang.String receiver,
                    java.lang.String uri)

Creates a new SOAP Envelope node, with a header and a body in it. This header will contain sender information (i.e., it will contain the name of the component in this connector, and its primary reply-to address, as well as the currently logged on user (retrieved from the WCPProperties with WCPProperties.USER)). Also, the header will contain the specified receiver information, if it was available. The XML Document that is returned will have the following structure

 SOAP:Envelope
  +-- SOAP:Header
      +-- header
          +-- sender
              +-- component
                  +-- name of component in this connector
              +-- reply-to
                  +-- primary reply address on which this connector is listening
              +-- user
                  +-- name of currently logged on user
          +-- receiver
              +-- component  <-- only if specified in receiver-parameter
                  +-- receiver-parameter
              +-- sent-to     <-- only if specified in uri-parameter
                  +-- uri-parameter
  +-- SOAP:Body
 

   Connector connector = Connector.getInstance("Anonymous Client");
   String receiver = "dn of the receiver"
   if(!connector.isOpen())
      connector.open();
   connector.createSOAPMessage(receiver,null);

The SOAP:Body node is returned from this function.

Parameters:

receiver - The name of the component that is supposed to receive this SOAP message. This name should either be a name that is registered in the Directory Server, or it should be the name of a Connector that is running in this process as well.

uri - A specific address to which this SOAP message should be tried to sent first. Use this only if you want to send the message to a Soap Node that is not registered in the directory server and is also not running in this process.

Returns:

The SOAP:Body node

createSOAPMessage

public int createSOAPMessage(java.lang.String receiver,
                    java.lang.String senderUser,
                    java.lang.String uri)

The SOAP:Body node is returned from this function.

Parameters:

receiver - The name of the component that is supposed to receive this SOAP message. This name should either be a name that is registered in the Directory Server, or it should be the name of a Connector that is running in this process as well.

senderUser - The name of the component/ user that is sending this SOAP Message.

uri - A specific address to which this SOAP message should be tried to sent first. Use this only if you want to send the message to a Soap Node that is not registered in the directory server and is also not running in this process.

Returns:

The SOAP:Body node

createSOAPMessageWithPrefix

public int createSOAPMessageWithPrefix(java.lang.String receiver,
                              java.lang.String senderUser,
                              java.lang.String uri,
                              java.lang.String prefix)

The :Body node is returned from this function. For example prefix is "SOAP".

Parameters:

receiver - The name of the component that is supposed to receive this SOAP message. This name should either be a name that is registered in the Directory Server, or it should be the name of a Connector that is running in this process as well.

senderUser - The name of the component/ user that is sending this SOAP Message.

uri - A specific address to which this SOAP message should be tried to sent first. Use this only if you want to send the message to a Soap Node that is not registered in the directory server and is also not running in this process.

prefix - A prefix to SOAP Request. For example prefix is "SOAP".

Returns:

prefix:Body for example "SOAP:Body"

createSOAPMessage

public int createSOAPMessage(java.lang.String receiver,
                    Identity senderIdentity,
                    java.lang.String uri)

The SOAP:Body node is returned from this function.

Parameters:

receiver - The name of the component that is supposed to receive this SOAP message. This name should either be a name that is registered in the Directory Server, or it should be the name of a Connector that is running in this process as well.

senderUser - The name of the component/ user that is sending this SOAP Message.

uri - A specific address to which this SOAP message should be tried to sent first. Use this only if you want to send the message to a Soap Node that is not registered in the directory server and is also not running in this process.

Returns:

The SOAP:Body node

createSOAPMessageWithPrefix

public int createSOAPMessageWithPrefix(java.lang.String receiver,
                              Identity senderIdentity,
                              java.lang.String uri,
                              java.lang.String prefix)

The :Body node is returned from this function.For example prefix is "SOAP".

Parameters:

receiver - The name of the component that is supposed to receive this SOAP message. This name should either be a name that is registered in the Directory Server, or it should be the name of a Connector that is running in this process as well.

senderUser - The name of the component/ user that is sending this SOAP Message.

uri - A specific address to which this SOAP message should be tried to sent first. Use this only if you want to send the message to a Soap Node that is not registered in the directory server and is also not running in this process.

prefix - A prefix to SOAP Request. For example prefix is "SOAP".

Returns:

prefix:Body for example "SOAP:Body"

createSOAPMethod

public int createSOAPMethod(java.lang.String namespace,
                   java.lang.String method)
                     throws DirectoryException

Creates the method node inside the body node

Parameters:

namespace - The namespace of the methodset

method - Name of the method that should be invoked

Returns:

returns the created method node

Throws:

DirectoryException - If a soapNode implementing the specified namespace is not found

wrapSOAPMethod

public Connector.SOAPMethod wrapSOAPMethod(int bodyNode)
                                    throws XMLException

Wraps the given body node in a wrapper object that provides XML DOM interfaces over it and provides memory management. After using this object, the caller should call deleteXML() on it.

Parameters:

bodyNode - the body node to be wrapped

Returns:

the wrapped SOAP method

Throws:

XMLException - when XML processing fails

createSOAPMethod

public int createSOAPMethod(java.lang.String organization,
                   java.lang.String namespace,
                   java.lang.String method)
                     throws DirectoryException

Creates the method node inside the body node

Parameters:

organization - The name of the organization

namespace - The namespace of the methodset

method - Name of the method that should be invoked

Returns:

returns the created method node

Throws:

DirectoryException - If a soapNode implementing the specified namespace is not found

createSOAPMethodEx

public int createSOAPMethodEx(java.lang.String namespace,
                     java.lang.String method,
                     java.lang.String organization,
                     java.lang.String senderUser,
                     java.lang.String receiver,
                     java.lang.String uri)
                       throws DirectoryException

Creates the method node inside the body node

Parameters:

namespace - The namespace of the methodset

method - Name of the method that should be invoked

organization - The name of the organization

senderUser - The name of the component/ user that is sending this SOAP Message.

receiver - The name of the component that is supposed to receive this SOAP message. This name should either be a name that is registered in the Directory Server, or it should be the name of a Connector that is running in this process as well.

uri - A specific address to which this SOAP message should be tried to sent first. Use this only if you want to send the message to a Soap Node that is not registered in the directory server and is also not running in this process.

Returns:

returns the created method node

Throws:

DirectoryException - If a soapNode implementing the specified namespace is not found

createSOAPMethod

public int createSOAPMethod(java.lang.String organizationalUser,
                   java.lang.String organization,
                   java.lang.String namespace,
                   java.lang.String method)
                     throws DirectoryException

Creates the method node inside the body node.

Parameters:

organizationalUser - The name of the acting user.

organization - The name of the organization

namespace - The namespace of the methodset

method - Name of the method that should be invoked

Returns:

returns the created method node

Throws:

DirectoryException - If a soapNode implementing the specified namespace is not found

sendAndWait

public int sendAndWait(int envelope)
                throws TimeoutException,
                       ExceptionGroup

Send a message to the Cordys ESB and suspend the current thread until a message comes back, or until the default timeout period has expired. The address information of the receiver of the message is retrieved from the header. If no message-id is present in the header, one is generated, so that the expected reply can be recognized when it comes back from the Cordys ESB.

  Connector connector = Connector.getInstance("Anonymous Client");
  if(! connector.isOpen())
      connector.open();
  int soapMethod = connector.createSOAPMethod("namespace","methodName");
  int response = connector.sendAndWait(Node.getParent(soapMethod));

Parameters:

envelope - The pointer to the XML tree representing the SOAP message

Throws:

ExceptionGroup - if the message could not be sent

TimeoutException - if the timer expired before a reply was received

sendAndWaitEx

public int sendAndWaitEx(int request,
                Identity identity)
                  throws TimeoutException,
                         ExceptionGroup

Populate the request with missing routing information, then send request and wait for response.

Parameters:

request - The pointer to the XML tree representing the SOAP message be blocked. If timeout is less than 0, the default timeout will be used.

identity - The identity that is send to the soap processor

Throws:

ExceptionGroup - if the message could not be sent

TimeoutException - if the timer expired before a reply was received

See Also:

Connector.sendAndWait(), Identity

sendAndWait

public int sendAndWait(int envelope,
              long timeout)
                throws CancelRequestException,
                       TimeoutException,
                       ExceptionGroup

Send a message to the Cordys ESB and suspend the current thread until a message comes back, or until the timeout period has expired. The address information of the receiver of the message is retrieved from the header. If no message-id is present in the header of the message, one is generated, so that the expected reply can be recognized when it comes back from the Cordys ESB.

  Connector connector = Connector.getInstance("Anonymous Client");
  if(! connector.isOpen())
      connector.open();
  int soapMethod = connector.createSOAPMethod("namespace","methodName");
  int response = connector.sendAndWait(Node.getParent(soapMethod),30000);
 

Parameters:

envelope - The pointer to the XML tree representing the SOAP message

timeout - The timeout period for which the calling Thread at maximum should be blocked. If timeout is less than 0, the default timeout will be used.

Throws:

ExceptionGroup - if the message could not be sent

TimeoutException - if the timer expired before a reply was received

CancelRequestException

sendAndWaitEx

public int sendAndWaitEx(int request,
                long timeout,
                Identity identity)
                  throws TimeoutException,
                         ExceptionGroup

Populate the request with missing routing information, then send request and wait for response.

Parameters:

request - The pointer to the XML tree representing the SOAP message be blocked. If timeout is less than 0, the default timeout will be used.

timeout - The timeout period for which the calling Thread at maximum should be blocked. If timeout is less than 0, the default timeout will be used.

identity - The identity that is send to the soap processor

Throws:

ExceptionGroup - if the message could not be sent

TimeoutException - if the timer expired before a reply was received

See Also:

Connector.sendAndWait(), Identity

sendAndCallback

public void sendAndCallback(int envelope,
                   SOAPMessageListener listener)
                     throws ExceptionGroup

Send a message to the Cordys ESB. Retrieves address information from the header. Registers the listener in the ListenerPool of this connector. If no message id is available in the header, one is generated automatically. If an answer for this message is received, the listener will be called, and removed from the listener pool.

  Connector connector = Connector.getInstance("Anonymous Client");
  if(! connector.isOpen())
      connector.open();
  int soapMethod = connector.createSOAPMethod("namespace","methodName");
  connector.sendAndCallback(Node.getParent(soapMethod),new MyListener());
  ........
  ........
  .....
   class MyListener implements SOAPMessageListener
   {
       public boolean onReceive(int message)
       {
           // do some thing
           System.out.println(Node.writeToString(message,true));
           return true;
       }
   }
 

Parameters:

envelope - int reference of the SOAP Envelope

listener - Listener that is listens for the specified SOAP Message

Throws:

ExceptionGroup - if the message could not be sent

sendAndCallbackEx

public void sendAndCallbackEx(int request,
                     SOAPMessageListener listener,
                     Identity identity)
                       throws TimeoutException,
                              ExceptionGroup

Populate the request with missing routing information, then send request. The response is processed by the callback.

Parameters:

request - The pointer to the XML tree representing the SOAP message be blocked. If timeout is less than 0, the default timeout will be used.

listener - Listener that is listens for the specified SOAP Message

identity - The identity that is send to the soap processor

Throws:

ExceptionGroup - if the message could not be sent

TimeoutException - if the timer expired before a reply was received

See Also:

Connector.sendAndCallback(), Identity

send

public void send(int envelope)
          throws ExceptionGroup

Send a message to the Cordys ESB. Retrieves address information from the header.

  Connector connector = Connector.getInstance("Anonymous Client");
  if(! connector.isOpen())
      connector.open();
  connector.getListenerPool().setDefaultListener(new MyListener());
  int soapMethod = connector.createSOAPMethod("namespace","methodName");
  connector.send(Node.getParent(soapMethod));
  ...........
  ........
  .......
   class MyListener implements SOAPMessageListener
   {
       public boolean onReceive(int message)
       {
           // do some thing
           System.out.println(Node.writeToString(message,true));
           return true;
       }
   }

Parameters:

envelope - int reference of the SOAP MEssage

Throws:

ExceptionGroup - if connector fails to send message

sendEx

public void sendEx(int request,
          Identity identity)
            throws TimeoutException,
                   ExceptionGroup

Populate the request with missing routing information, then send request.

Parameters:

request - The pointer to the XML tree representing the SOAP message be blocked. If timeout is less than 0, the default timeout will be used.

identity - The identity that is send to the soap processor

Throws:

ExceptionGroup - if the message could not be sent

TimeoutException - if the timer expired before a reply was received

See Also:

Connector.send(), Identity

send

public void send(int envelope,
        MessageOptions messageOptions)
          throws ExceptionGroup

Send a message to the Cordys ESB. Retrieves address information from the header.

  Connector connector = Connector.getInstance("Anonymous Client");
  if(! connector.isOpen())
      connector.open();
  connector.getListenerPool().setDefaultListener(new MyListener());
  int soapMethod = connector.createSOAPMethod("namespace","methodName");
  connector.send(Node.getParent(soapMethod),MessageOptions.NON_TRANSACTIONAL_REPLY);
  ...........
  ........
  .......
   class MyListener implements SOAPMessageListener
   {
       public boolean onReceive(int message)
       {
           // do some thing
           System.out.println(Node.writeToString(message,true));
           return true;
       }
   }

Parameters:

envelope - int reference of the SOAP MEssage

messageOptions - to set the transactional behaviour of the message send.

Throws:

ExceptionGroup - if connector fails to send message

sendEx

public void sendEx(int request,
          MessageOptions messageOptions,
          Identity identity)
            throws TimeoutException,
                   ExceptionGroup

Populate the request with missing routing information, then send request.

Parameters:

request - The pointer to the XML tree representing the SOAP message be blocked. If timeout is less than 0, the default timeout will be used.

identity - The identity that is send to the soap processor

messageOptions - to set the transactional behaviour of the message send.

Throws:

ExceptionGroup - if the message could not be sent

TimeoutException - if the timer expired before a reply was received

See Also:

Connector.send(), Identity

cancel

public void cancel(int envelope,
          boolean restartServer)

Retrieves the message id from the header and calls the cancel(messageId, restartServer) method.

Parameters:

envelope - The request for which the reply needs to be canceled.

restartServer - not applicable irrespective of the value passed.

cancel

public void cancel(java.lang.String messageId,
          boolean restartServer)

Cancels an outstanding message with the specified identifier. If a thread is waiting for a reply to the message with the specified id, it will receive a CancelException

Parameters:

envelope - The id of the request for which the reply needs to be canceled.

restartServer - not applicable irrespective of the value passed.

setCredentials

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

Deprecated.

Throws:

CredentialsFailedException

isAuthenticated

public static boolean isAuthenticated()

setDocPerThreadConfig

public void setDocPerThreadConfig(int config)

Set the configuration option for having a nom Document per thread.

Parameters:

config - One of USE_SINGLE_DOC or USE_MULTI_DOC.

sendAndCallback

public void sendAndCallback(int envelope,
                   SOAPMessageListener listener,
                   MessageOptions messageoptions)
                     throws ExceptionGroup

Send a message with message options ( NON_TRANSACTIONAL_REPLY or TRANSACTIONAL_REPLY)

Parameters:

envelope -

listener -

messageoptions -

Throws:

ExceptionGroup