com.wm.app.b2b.server.jms.producer

Class ProducerFacade

java.lang.Object

com.wm.app.b2b.server.jms.producer.ProducerFacade

public class ProducerFacade
extends java.lang.Object

The ProducerFacade class provides a unified interface to the JMS message producer functionality. It includes methods to send, send and wait, reply, wait for a reply, and create JMS messages. At this time, the only way to send a MapMessage or StreamMessage is to create them directly using this class. The methods in this class will also take the client side queue (CSQ) into consideration before sending any messages (if configured to do so). If specified, Integration Server places messages in the CSQ if the JMS provider is not available when the method that sends the JMS message is called.

Constructor Summary

Constructors

Constructor and Description
ProducerFacade()

Method Summary

Modifier and Type	Method and Description
static BytesMessage	createBytesMessage(java.lang.String aliasName) Returns a BytesMessage object that can then be sent to the JMS provider.
static MapMessage	createMapMessage(java.lang.String aliasName) Returns a MapMessage object that can then be sent to the JMS provider.
static ObjectMessage	createObjectMessage(java.lang.String aliasName) Returns an ObjectMessage object that can then be sent to a Destination on the JMS provider.
static StreamMessage	createStreamMessage(java.lang.String aliasName) Returns a StreamMessage object that can then be sent to the JMS provider.
static TextMessage	createTextMessage(java.lang.String aliasName) Returns a TextMessage object that can then be sent to a destination on the JMS provider.
static IData	send(java.lang.String aliasName, java.lang.String destinationName, int destinationType, IData header, IData properties, IData body, boolean useCSQ) Sends a message to the JMS provider.
static IData	sendAndWait(java.lang.String aliasName, java.lang.String destinationName, int destinationType, java.lang.String destinationNameReplyTo, int destinationTypeReplyTo, long waitTime, IData header, IData properties, IData body, boolean useCSQ) Sends a message to the JMS provider and optionally, waits for a reply.
static void	sendLargeMessageStream(java.lang.String aliasName, java.lang.String destinationName, int destinationType, java.io.InputStream inputStream) Deprecated. No replacement. webMethods Broker is deprecated, which results in the deprecation of this method.
static IData	sendReplyFromOnDemandConsumer(IData header, IData properties, IData body, OnDemandConsumer consumer, Message originalMessage) Sends a reply message in response to a request message received by an OnDemandConsumer.
static IData	sendReplyFromTrigger(IData header, IData properties, IData body) Sends a reply message in response to a request message received and processed by a JMS trigger.
static IData	waitForReply(java.lang.String correlationID, long waitTime) Waits for a reply sent in response to an asynchronous request.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProducerFacade

public ProducerFacade()

Method Detail

createTextMessage

public static TextMessage createTextMessage(java.lang.String aliasName)
                                     throws JMSException,
                                            JMSSubsystemException,
                                            ResourceUnavailableException

Returns a TextMessage object that can then be sent to a destination on the JMS provider.

Parameters:

aliasName - a String containing the name of the JMS connection alias that you want to use to send the message

Returns:

a TextMessage object

Throws:

JMSException - if the JMS provider fails to create this message due to some internal error

JMSSubsystemException - if the specified aliasName does not exist or if another error occurs within the JMS subsystem

ResourceUnavailableException - if the JMS provider specified in the JMS connection alias is not available

See Also:

javax.jms.Session#createTextMessage()

createObjectMessage

public static ObjectMessage createObjectMessage(java.lang.String aliasName)
                                         throws JMSException,
                                                JMSSubsystemException,
                                                ResourceUnavailableException

Returns an ObjectMessage object that can then be sent to a Destination on the JMS provider.

Parameters:

aliasName - a String containing the name of the JMS connection alias that you want to use to send the message

Returns:

an ObjectMessage object

Throws:

JMSException - if the JMS provider fails to create this message due to some internal error

JMSSubsystemException - if the specified aliasName does not exist or if another error occurs within the JMS subsystem

ResourceUnavaiableException - if the JMS provider specified in the JMS connection alias is not available

ResourceUnavailableException

See Also:

javax.jms.Session#createObjectMessage()

createStreamMessage

public static StreamMessage createStreamMessage(java.lang.String aliasName)
                                         throws JMSException,
                                                JMSSubsystemException,
                                                ResourceUnavailableException

Returns a StreamMessage object that can then be sent to the JMS provider.

Parameters:

aliasName - a String specifying the JMS connection alias that you want to use to send the JMS message.

Returns:

a StreamMessage object

Throws:

JMSException - if the JMS provider fails to create this message due to some internal error

JMSSubsystemException - if the specified aliasName does not exist or if another error occurs within the JMS subsystem

ResourceUnavailableException - if the JMS provider specified in the JMS connection alias is not available

See Also:

javax.jms.Session#createStreamMessage()

createMapMessage

public static MapMessage createMapMessage(java.lang.String aliasName)
                                   throws JMSException,
                                          JMSSubsystemException,
                                          ResourceUnavailableException

Returns a MapMessage object that can then be sent to the JMS provider.

Parameters:

aliasName - a String that specifies the JMS connection alias that you want to use to send the JMS message.

Returns:

a MapMessage object

Throws:

JMSException - if the JMS provider fails to create this message due to some internal error

JMSSubsystemException - if the specified aliasName does not exist or if another error occurs within the JMS subsystem

ResourceUnavailableException - if the JMS provider specified in the JMS connection alias is not available

See Also:

javax.jms.Session#createMapMessage()

createBytesMessage

public static BytesMessage createBytesMessage(java.lang.String aliasName)
                                       throws JMSException,
                                              JMSSubsystemException,
                                              ResourceUnavailableException

Returns a BytesMessage object that can then be sent to the JMS provider.

Parameters:

aliasName - a String that specifies the JMS connection alias that you want to use to send the JMS message.

Returns:

a BytesMessage object

Throws:

JMSException - if the JMS provider fails to create this message due to some internal error

JMSSubsystemException - if the specified aliasName does not exist or if another error occurs within the JMS subsystem

ResourceUnavailableException - if the JMS provider specified in the JMS connection alias is not available *

See Also:

javax.jms.Session#createBytesMessage()

send

public static IData send(java.lang.String aliasName,
                         java.lang.String destinationName,
                         int destinationType,
                         IData header,
                         IData properties,
                         IData body,
                         boolean useCSQ)
                  throws JMSSubsystemException,
                         ResourceUnavailableException

Sends a message to the JMS provider.

Returns an IData containing the JMS message sent to the JMS provider. Some of the header fields in a JMS message are populated by the JMS provider after the message is sent. For example, the header field JMSMessageID is not in the JMS message sent by Integration Server, but JMSMessageID is in the header after the JMS provider receives the message.

Parameters:

aliasName - a String for JMS connection alias that you want to use to send the message

destinationName - a String for Name or lookup name of the Destination to which you want to send the message. Specify the lookup name of the Destination object when the JMS connection alias uses JNDI to retrieve administered objects. Specify the provider-specific name of the Destination when the JMS connection alias uses the native webMethods API to connect directly to the webMethods JMS Provider.

destinationType - an int indicating whether the destination is a queue or topic; Queue = 0; Topic = 1

header - an IData containing the header for the JMS message

properties - an IData containing the properties for the JMS message

body - an IData containing the body of the JMS message

useCSQ - a boolean indicating whether or not Integration Server places messages in the client side queue if the JMS provider is not available at the time this method is called. True to use the client side queue; otherwise false. Note that if aliasName specifies a transacted JMS connection alias, useCSQ must be set to false. Messages sent as part of a transaction cannot be written to the client side queue.

Returns:

an IData containing the JMS message sent to the JMS provider.

Throws:

JMSSubsystemException - if an error occurs within the JMS subsystem, for example: if an aliasName is not provided; if a destinationName is not provided; if the specified aliasName is for a transacted JMS connection alias and useCSQ is set to true; if the specified JMS connection alias is not configured to use a client side queue and useCSQ is set to true; if Integration Server is unable to write the message to the client side queue; if Integration Server is unable to send the message to the JMS provider

ResourceUnavailableException - if the JMS provider is not available when this method is called and useCSQ is set to false

sendLargeMessageStream

public static void sendLargeMessageStream(java.lang.String aliasName,
                                          java.lang.String destinationName,
                                          int destinationType,
                                          java.io.InputStream inputStream)
                                   throws JMSSubsystemException,
                                          ResourceUnavailableException

Deprecated. No replacement. webMethods Broker is deprecated, which results in the deprecation of this method.

Sends a large message stream to the webMethods Broker.

This method allows you to stream large amounts of data or a large file from a message producer to a message consumer. You can only send and receive large messages from Integration Server when working with the webMethods Broker.

Large message streams cannot be sent or received as part of a transaction.

If the connection between Integration Server and the webMethods JMS Provider fails before this method sends the entire message stream, you need to re-send the entire stream when the connection is re-established.

Parameters:

aliasName - a String for the JMS connection alias that you want to use to send the message

destinationName - a String for the name of the destination to which you want to send the message

destinationType - an int indicating whether the destination is a queue or topic; Queue = 0; Topic = 1

inputStream - an InputStream object for the message stream you want to send

Throws:

JMSSubsystemException - if an error occurs within the JMS subsystem, for example: if the required parameters aliasName, destinationName, or inputStream are not provided; if the specified JMS connection alias has a transaction type of LOCAL_TRANSACTION or XA_TRANSACTION

ResourceUnavailableException - if the webMethods Broker is not available when this method is called; if the connection to the webMethods JMS Provider fails before the entire message stream is sent

sendAndWait

public static IData sendAndWait(java.lang.String aliasName,
                                java.lang.String destinationName,
                                int destinationType,
                                java.lang.String destinationNameReplyTo,
                                int destinationTypeReplyTo,
                                long waitTime,
                                IData header,
                                IData properties,
                                IData body,
                                boolean useCSQ)
                         throws JMSSubsystemException,
                                ResourceUnavailableException

Sends a message to the JMS provider and optionally, waits for a reply.

Returns an IData containing the JMS message sent to the JMS provider. Some of the header fields in a JMS message are populated by the JMS provider after the message is sent. For example, the header field JMSMessageID is not in the JMS message sent by Integration Server, but JMSMessageID is in the header after the JMS provider receives the message.

This method can initiate a request/reply in a synchronous or asynchronous manner.

In a synchronous request/reply, this method waits for a reply before continuing. In an asynchronous request/reply, this method that sends the request continues after sending the message. To retrieve the reply, call one of the waitForReply method. A waitTime < 1 indicates the request/reply is asynchronous.

The replying message consumer uses the value or uuid or JMSMessageID in the requesting JMS message to correlate the request and the response. If you specify the uuid when sending the request, the replying Integration Server will use the uuid as the JMSCorrelationID of the reply message. If you do not specify a uuid, the replying message consumer uses the JMSMessageID set by the JMS provider as the JMSCorrelationID of the reply message.

Integration Server can write messages to the client side queue only for messages sent as part of an asynchronous request/reply. That is, if the waitTime is < 1 and the JMS provider is not available when this method is called, Integration Server places the message in the client side queue. Client side queuing cannot be used for a synchronous request/reply.

If you do not specify a destination for reply messages, Integration Server uses a temporaryQueue to receive the reply. A temporaryQueue is a queue object created for the duration of a particular connection. It can only be consumed by the connection from which it was created.

Parameters:

aliasName - a String for JMS connection alias that you want to use to send the message

destinationName - a String for Name or lookup name of the Destination to which you want to send the message. Specify the lookup name of the Destination object when the JMS connection alias uses JNDI to retrieve administered objects. Specify the provider-specific name of the Destination when the JMS connection alias uses the native webMethods API to connect directly to the webMethods JMS Provider.

destinationType - an int indicating whether the destination is a queue or topic; Queue = 0; Topic = 1

destinationNameReplyTo - a String for the name or lookup name of the Destination to which you want the reply message sent. Specify the lookup name of the Destination object when the JMS connection alias uses JNDI to retrieve administered objects. Specify the provider-specific name of the Destination when the JMS connection alias uses the native webMethods API to connect directly to the webMethods Broker.

destinationTypeReplyTo - an int that indicates if the destination to which the reply to be sent is a queue or topic; Queue = 0; Topic = 1

waitTime - a long indicating the time to wait (in milliseconds) for the response to arrive. A waitTime < 1 indicates the request/reply is asynchronous.

header - an IData containing the header for the JMS message

properties - an IData containing the properties for the JMS message

body - an IData containing the body of the JMS message

useCSQ - a boolean indicating whether or not Integration Server places messages in the client side queue if the JMS provider is not available at the time this method is called. True to use the client side queue; otherwise false. Note that if aliasName specifies a transacted JMS connection alias or waitTime is < 1, useCSQ must be set to false. Messages sent as part of a transaction cannot be written to the client side queue.

Returns:

an IData containing the JMS message sent to the JMS provider.

Throws:

JMSSubsystemException - if an error occurs within the JMS subsystem, for example: if the required parameters aliasName and destinationName are not provided; if useCSQ is set to true and the waitTime is greater than 0 (a synchronous request reply cannot use the client side queue); if useCSQ is set to true and the JMS connection alias is transacted (messages sent as part of a transaction cannot be written to the client side queue); if the message cannot be written to the client side queue; if the message cannot be sent to the JMS provider; if the reply message does not specify a correlation ID; if the reply message cannot be retrieved

ResourceUnavailableException - if the JMS provider is not available

See Also:

waitForReply(String, long)

sendReplyFromTrigger

public static IData sendReplyFromTrigger(IData header,
                                         IData properties,
                                         IData body)
                                  throws JMSException,
                                         JMSSubsystemException,
                                         ResourceUnavailableException

Sends a reply message in response to a request message received and processed by a JMS trigger.

Returns an IData containing the JMS message sent to the JMS provider. Some of the header fields in a JMS message are populated by the JMS provider after the message is sent. For example, the header field JMSMessageID is not in the JMS message sent by Integration Server, but JMSMessageID is in the header after the JMS provider receives the message.

This method obtains information about the reply to destination and correlation ID from the original message request.

To send a reply to a message received by an OnDemandConsumer, use sendReplyFromOnDemandConsumer(IData, IData, IData, OnDemandConsumer, Message)

Parameters:

header - an IData for the header of the reply JMS message

properties - an IData for the properties of the reply JMS message

body - an IData for the body of the reply JMS message

Returns:

an IData for the reply message sent to the JMS provider

Throws:

JMSException - if the JMS provider fails for some internal error

JMSSubsystemException - if an error occurs within the JMS subsystem

ResourceUnavailableException - if the JMS provider is not available

See Also:

sendReplyFromOnDemandConsumer(IData, IData, IData, OnDemandConsumer, Message)

sendReplyFromOnDemandConsumer

public static IData sendReplyFromOnDemandConsumer(IData header,
                                                  IData properties,
                                                  IData body,
                                                  OnDemandConsumer consumer,
                                                  Message originalMessage)
                                           throws JMSException,
                                                  JMSSubsystemException,
                                                  ResourceUnavailableException

Sends a reply message in response to a request message received by an OnDemandConsumer. An OnDemandConsumer can be created using the built-in service pub.jms:createConsumer.

Returns an IData containing the JMS message sent to the JMS provider. Some of the header fields in a JMS message are populated by the JMS provider after the message is sent. For example, the header field JMSMessageID is not in the JMS message sent by Integration Server, but JMSMessageID is in the header after the JMS provider receives the message.

To send a reply to a message received by a JMS trigger, use sendReplyFromTrigger(IData, IData, IData). *

Parameters:

header - an IData for the header of the reply JMS message

properties - an IData for the properties of the reply JMS message

body - an IData for the body of the reply JMS message

consumer - the OnDemandConsumer object used to receive the request message from the JMS provider. This method uses information from the message consumer to create a message producer that will send the reply message. Use the built-in service pub.jms.createConsumer to create an OnDemandConsumer.

originalMessage - a Message object that contains the request message

Returns:

an IData for the reply message sent to the JMS provider

Throws:

JMSException - if the JMS provider fails for some internal error

JMSSubsystemException - if an error occurs within the JMS subsystem

ResourceUnavailableException - if the JMS provider is not available

See Also:

sendReplyFromTrigger(IData, IData, IData)

waitForReply

public static IData waitForReply(java.lang.String correlationID,
                                 long waitTime)
                          throws JMSSubsystemException

Waits for a reply sent in response to an asynchronous request. Returns an IData containing the reply JMS message if the reply is received before the waitTime elapses. If a reply is not received before the waitTime elapses, this method returns a null IData.

The replying JMS client uses the value of the JMSMesssageID in the request message as the JMSCorrelationID. The JMSCorrelation ID associates the reply with the original request. Consequently, use the JMSMessageID in the IData returned by sendAndWait method as the correlationID for this method.

Parameters:

correlationID - a String for the identifier used to associate the reply message with the initial request

waitTime - a long for the time to wait (in milliseconds) for the reply to arrive. If no value is specified, the method waits indefinitely for a reply.

Returns:

an IData for the reply JMS message. If the waitTime elapsed before a reply was received, the returned IData will be null.

Throws:

JMSSubsystemException - if an error occurs within the JMS subsystem