Package org.frankframework.jms

Class JMSFacade

java.lang.Object
org.frankframework.jndi.JndiBase
org.frankframework.jms.JMSFacade
All Implemented Interfaces:
FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IScopeProvider, IXAEnabled, NameAware, ConfigurableLifecycle, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle
Direct Known Subclasses:
AbstractJmsListener, AbstractJmsMessageBrowser, JmsSender
@DestinationType(JMS) public class JMSFacade extends JndiBase implements ConfigurableLifecycle, FrankElement, NameAware, HasPhysicalDestination, IXAEnabled
Provides functions for jms connections, queues and topics and acts as a facade to hide for clients whether a Queue or Topic is used.
The destinationType field specifies which type should be used.
This class sends messages with JMS.
Author:
Gerrit van Brakel

  • Field Details

    • log

      protected org.apache.logging.log4j.Logger log

    • JMS_MESSAGECLASS_KEY

      public static final String JMS_MESSAGECLASS_KEY
      See Also:

    • messagingSource

      protected MessagingSource messagingSource

  • Constructor Details

    • JMSFacade

      public JMSFacade()

  • Method Details

    • setMessageClass

      public void setMessageClass(JMSFacade.MessageClass messageClass)
      The JMS Message class for the outgoing message. Currently supported are JMSFacade.MessageClass.TEXT for JMS TextMessage, JMSFacade.MessageClass.BYTES for JMS BytesMessage, or JMSFacade.MessageClass.AUTO for auto-determination based on whether the input Message is binary or character.

      Defaults to JMSFacade.MessageClass.AUTO, unless the default is overridden in AppConstants with property jms.messageClass.default

    • getLogPrefix

      protected String getLogPrefix()

    • configure

      public void configure() throws ConfigurationException
      Description copied from interface: IConfigurable
      Configure this component.

      configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

      In the case of a container, this will propagate the configure signal to all components that apply.

      Specified by:
      configure in interface IConfigurable
      Throws:
      ConfigurationException - in case it was not able to configure the component.

    • getConnectionFactoryName

      public String getConnectionFactoryName() throws JmsException
      Throws:
      JmsException

    • getJmsMessagingSource

      protected JmsMessagingSource getJmsMessagingSource() throws JmsException
      Throws:
      JmsException

    • getMessagingSource

      protected MessagingSource getMessagingSource() throws JmsException
      Throws:
      JmsException

    • setJndiContextPrefix

      @Autowired public void setJndiContextPrefix(String jndiContextPrefix)

    • createSession

      protected jakarta.jms.Session createSession() throws JmsException
      Returns a session on the connection for a topic or a queue
      Throws:
      JmsException

    • closeSession

      protected void closeSession(jakarta.jms.Session session)

    • start

      public void start()
      Obtains a connection and a serviceQueue.
      Specified by:
      start in interface ConfigurableLifecycle
      Specified by:
      start in interface org.springframework.context.Lifecycle

    • stop

      public void stop()
      Releases references to serviceQueue and connection.
      Specified by:
      stop in interface org.springframework.context.Lifecycle
      Overrides:
      stop in class JndiBase

    • isRunning

      public boolean isRunning()
      Specified by:
      isRunning in interface org.springframework.context.Lifecycle

    • createMessage

      @Nonnull public jakarta.jms.Message createMessage(jakarta.jms.Session session, String correlationID, Message message) throws jakarta.jms.JMSException, IOException
      Throws:
      jakarta.jms.JMSException
      IOException

    • createMessage

      @Nonnull public jakarta.jms.Message createMessage(jakarta.jms.Session session, String correlationID, Message message, JMSFacade.MessageClass messageClass) throws jakarta.jms.JMSException, IOException
      Throws:
      jakarta.jms.JMSException
      IOException

    • createBytesMessage

      @Nonnull protected jakarta.jms.Message createBytesMessage(jakarta.jms.Session session, String correlationID, Message message) throws jakarta.jms.JMSException, IOException
      Throws:
      jakarta.jms.JMSException
      IOException

    • createTextMessage

      @Nonnull protected jakarta.jms.TextMessage createTextMessage(jakarta.jms.Session session, String correlationID, Message message) throws jakarta.jms.JMSException, IOException
      Throws:
      jakarta.jms.JMSException
      IOException

    • setMessageCorrelationID

      public void setMessageCorrelationID(jakarta.jms.Message message, String correlationID) throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • getDestination

      public jakarta.jms.Destination getDestination() throws JmsException
      Throws:
      JmsException

    • getDestination

      public jakarta.jms.Destination getDestination(String destinationName)

    • getMessageConsumerForCorrelationId

      public jakarta.jms.MessageConsumer getMessageConsumerForCorrelationId(jakarta.jms.Session session, jakarta.jms.Destination destination, String correlationId) throws jakarta.jms.JMSException
      Gets a MessageConsumer object for either Topics or Queues.
      Returns:
      a MessageConsumer with the right filter (messageSelector)
      Throws:
      jakarta.jms.JMSException

    • getMessageConsumer

      public jakarta.jms.MessageConsumer getMessageConsumer(jakarta.jms.Session session, jakarta.jms.Destination destination, String selector) throws jakarta.jms.JMSException
      Create a MessageConsumer. In this overloaded function the selector is taken into account. This ensures that listeners (or other extensions of this class) do not influence how the selector is used: when a correlationID should be in the filter the getMessageConsumerForCorrelationId should be used, otherwise the getMessageConsumer function which has no attribute for selector. When a MessageSelector is set, it will be used when no correlation id is required.
      Parameters:
      session - the Session
      destination - the Destination
      selector - the MessageSelector
      Returns:
      MessageConsumer
      Throws:
      jakarta.jms.JMSException

    • getMessageConsumer

      public jakarta.jms.MessageConsumer getMessageConsumer(jakarta.jms.Session session, jakarta.jms.Destination destination) throws jakarta.jms.JMSException
      Create a MessageConsumer, on a specific session and for a specific destination. This functions hides wether we work via Topics or Queues and whether a messageSelector is set.
      Parameters:
      session - the Session
      destination - the Destination
      Returns:
      the MessageConsumer
      Throws:
      jakarta.jms.JMSException

    • getMessageProducer

      public jakarta.jms.MessageProducer getMessageProducer(jakarta.jms.Session session, jakarta.jms.Destination destination) throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • getPhysicalDestinationShortName

      public String getPhysicalDestinationShortName()

    • getPhysicalDestinationShortName

      public String getPhysicalDestinationShortName(boolean throwException) throws JmsException
      Throws:
      JmsException

    • getPhysicalDestinationName

      public String getPhysicalDestinationName()
      Specified by:
      getPhysicalDestinationName in interface HasPhysicalDestination

    • send

      public String send(jakarta.jms.Session session, jakarta.jms.Destination dest, String correlationId, Message message, String messageType, long timeToLive, int deliveryMode, int priority, boolean ignoreInvalidDestinationException, Map<String,Object> properties) throws jakarta.jms.JMSException, SenderException, IOException
      Throws:
      jakarta.jms.JMSException
      SenderException
      IOException

    • send

      public String send(jakarta.jms.MessageProducer messageProducer, jakarta.jms.Message message) throws jakarta.jms.JMSException
      Send a message
      Parameters:
      messageProducer -
      message -
      Returns:
      messageID of sent message
      Throws:
      jakarta.jms.JMSException

    • send

      public String send(jakarta.jms.MessageProducer messageProducer, jakarta.jms.Message message, boolean ignoreInvalidDestinationException) throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • logMessageDetails

      protected void logMessageDetails(jakarta.jms.Message message, jakarta.jms.MessageProducer messageProducer) throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • send

      public String send(jakarta.jms.Session session, jakarta.jms.Destination dest, jakarta.jms.Message message) throws jakarta.jms.JMSException
      Send a message
      Parameters:
      session -
      dest - destination
      message -
      Returns:
      message ID of the sent message
      Throws:
      jakarta.jms.JMSException

    • send

      public String send(jakarta.jms.Session session, jakarta.jms.Destination dest, jakarta.jms.Message message, boolean ignoreInvalidDestinationException) throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • sendByQueue

      protected String sendByQueue(jakarta.jms.QueueSession session, jakarta.jms.Queue destination, jakarta.jms.Message message) throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • sendByTopic

      protected String sendByTopic(jakarta.jms.TopicSession session, jakarta.jms.Topic destination, jakarta.jms.Message message) throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • isSessionsArePooled

      public boolean isSessionsArePooled()

    • getContext

      public MessageContext getContext(jakarta.jms.Message message) throws jakarta.jms.JMSException
      Throws:
      jakarta.jms.JMSException

    • extractMessage

      public Message extractMessage(jakarta.jms.Message jmsMessage, Map<String,Object> context, boolean soap, String soapHeaderSessionKey, SoapWrapper soapWrapper) throws jakarta.jms.JMSException, SAXException, TransformerException, IOException, XmlException
      Extracts string from message obtained from getRawMessage(Map). May also extract other parameters from the message and put those in the threadContext.

      Supports only TextMessages and BytesMessage.

      Throws:
      jakarta.jms.JMSException
      SAXException
      TransformerException
      IOException
      XmlException

    • extractMessageBody

      protected Message extractMessageBody(Message message, Map<String,Object> context, SoapWrapper soapWrapper) throws SAXException, TransformerException, IOException, XmlException
      Throws:
      SAXException
      TransformerException
      IOException
      XmlException

    • checkTransactionManagerValidity

      public void checkTransactionManagerValidity()

    • toString

      public String toString()
      Overrides:
      toString in class JndiBase

    • setDestinationName

      public void setDestinationName(String destinationName)
      Name of the JMS destination (queue or topic) to use

    • setDestinationType

      public void setDestinationType(JMSFacade.JmsDestinationType destinationType)
      Type of the messaging destination. This function also sets the useTopicFunctions field, that controls whether Topic functions are used or Queue functions.
      Default value
      QUEUE

    • setAcknowledgeMode

      public void setAcknowledgeMode(JMSFacade.AcknowledgeMode acknowledgeMode)
      If not transacted, the way the application informs the JMS provider that it has successfully received a message.
      Default value
      auto

    • setPersistent

      @Deprecated(forRemoval=true, since="7.6.0") public void setPersistent(boolean value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Controls whether messages are processed persistently. When set true, the JMS provider ensures that messages aren't lost when the application might crash.

    • setSubscriberType

      public void setSubscriberType(JMSFacade.SubscriberType subscriberType)
      Only applicable for topics
      Default value
      DURABLE

    • setQueueConnectionFactoryName

      public void setQueueConnectionFactoryName(String name)
      Used when destinationType = QUEUE. The JNDI-name of the queueConnectionFactory to use to connect to a queue if IXAEnabled.isTransacted() returns false. The corresponding connection factory should be configured not to support XA transactions.

    • setTopicConnectionFactoryName

      public void setTopicConnectionFactoryName(String topicConnectionFactoryName)
      Used when destinationType = TOPIC. The JNDI-name of the connection factory to use to connect to a topic if IXAEnabled.isTransacted() returns false. The corresponding connection factory should be configured not to support XA transactions.

    • setTransacted

      public void setTransacted(boolean transacted)
      Controls whether messages are send under transaction control. If set true, messages are committed or rolled back under control of an XA-transaction.
      Default value
      false

    • setCorrelationIdToHex

      public void setCorrelationIdToHex(boolean correlationIdToHex)
      Transform the value of the correlationid to a hexadecimal value if it starts with id: (preserving the id: part). Useful when sending messages to MQ which expects this value to be in hexadecimal format when it starts with id:, otherwise generating the error: MQJMS1044: String is not a valid hexadecimal number
      Default value
      false

    • setCorrelationIdToHexPrefix

      public void setCorrelationIdToHexPrefix(String correlationIdToHexPrefix)
      Prefix to check before executing correlationIdToHex. If empty (and correlationIdToHex equals true) all correlationid's are transformed, this is useful in case you want the entire correlationId to be transformed (for example when the receiving party doesn't allow characters like a colon to be present in the correlationId).
      Default value
      id:

    • setMessageTimeToLive

      public void setMessageTimeToLive(long ttl)
      The time in milliseconds it takes for the message to expire. If the message is not consumed before, it will be lost. Must be a positive value for request/reply type of messages, 0 disables the expiry timeout
      Default value
      0

    • setCorrelationIdMaxLength

      public void setCorrelationIdMaxLength(int i)
      If set (>=0) and the length of the correlationId exceeds this maximum length, the correlationId is trimmed from the left side of a string to this maximum length
      Default value
      -1

    • setMessageSelector

      public void setMessageSelector(String newMessageSelector)
      If set, the value of this attribute is used as a selector to filter messages.
      Default value
      0 (unlimited)

    • setAuthAlias

      public void setAuthAlias(String string)
      Alias used to obtain credentials for authentication to JMS server

    • setLookupDestination

      public void setLookupDestination(boolean b)
      If set false, the destinationName is used directly instead of performing a JNDI lookup
      Default value
      true

    • setName

      public void setName(String name)
      The name of this FrankElement
      Specified by:
      setName in interface NameAware