eva.v2.messaging.jms.beta.core — com.workiva/eva 2.0.3

acknowledge-mode-keyword clj

(acknowledge-mode-keyword mode)

Coerces a valid acknowledge-mode value to the human-readable keywords:

• :auto
• :client
• :dups-ok

If any of these keywords are passed, they will be returned unchanged. Any other value will result in an IllegalArgumentException.

acknowledge-mode-value clj

(acknowledge-mode-value mode)

Coerces the value to a JMS acknowledge-mode integer value. If a valid acknowledge-mode integer value is passed, it will be returned unchanged. The following keywords are also accepted:

• :auto -> javax.jms.Session/AUTO_ACKNOWLEDGE
• :client -> javax.jms.Session/CLIENT_ACKNOWLEDGE
• :dups-ok -> javax.jms.Session/DUPS_OK_ACKNOWLEDGE

Any other value will result in an IllegalArgumentException.

bytes-message? clj

(bytes-message? m)

Predicate that tests if m is a javax.jms.BytesMessage

connection-factory? clj

(connection-factory? cf)

Predicate that tests if the argument is a javax.jms.ConnectionFactory

connection? clj

(connection? c)

Predicate that tests if the argument is a javax.jms.Connection

create-connection clj

(create-connection cf)

(create-connection cf
                   {:as opts :keys [start? user password] :or {start? false}})

Produces a javax.jms.Connection from a javax.jms.ConnectionFactory

create-session clj

(create-session c)

(create-session c
                {transacted? :transacted?
                 ack-mode :acknowledge-mode
                 :or {transacted? false ack-mode :auto}})

Produces a javax.jms.Session on a javax.jms.Connection.

Accepts an optional, options map that can specify:

• whether the session is transactional
• the session's acknowledge-mode

Defaults to creating a non-transactional session with :auto acknowledge-mode.

delivery-mode-keyword clj

(delivery-mode-keyword mode)

Coerces a valid delivery-mode value to the human readable keywords:

• :persistent
• :non-persistent

If passed, these keywords are returned unchanged.

Any other value will result in an IllegalArgumentException.

delivery-mode-value clj

(delivery-mode-value mode)

Coerces a representation of a delivery mode to the integer value recognized by JMS. Valid keyword inputs are:

• :persistent
• :non-persistent

If a valid integer value is passed, it will be returned unchanged. Invalid integer values will throw an IllegalArgumentException.

Any other value will result in an IllegalArgumentException.

destination-name clj

(destination-name d)

Returns the string name of a Queue or Topic.

destination? clj

(destination? dest)

Predicate that tests if the value is a javax.jms.Destination

message-consumer clj

(message-consumer s d)

(message-consumer s d & {:keys [message-selector no-local? on-message]})

Creates a javax.jms.MessageConsumer on Session s which consumes messages sent to Destination d.

Accepts an optional map with the following keys:

• :message-selector :: a JMS message selection expression string;
• :no-local? :: if true, the consumer will not receive messages that were sent by producers using the same local, connection;
• on-message :: a function that will be called asynchronously whenever the consumer receives a message. The function must accept a single-argument which will be the that was message received.

message-consumer? clj

(message-consumer? c)

Predicate that tests if c is a javax.jms.MessageConsumer.

message-info clj

(message-info m)

Returns a map of the metadata common to all instances of javax.jms.Message.

Includes ONLY non-nil entries for:

• :message-id from Message#getJMSMessageID()
• :message-type from Message#getJMSTypes()
• :timestamp Instant derived from Message#getJMSTimeStamp()
• :expiration Instant derived from Message#getJMSExpiration
• :correlation-id from Message#getJMSCorrelationID
• :destination from Message#getJMSDestination
• :reply-to from Message#getJMSReplyTo()
• :delivery-mode derived from Message#getJMSDeliveryMode()
• :priority from Message#getJMSPriority()
• :redelivered? from Message#getJMSRedelivered()

message-producer clj

(message-producer s d)

(message-producer s d {dm :delivery-mode ttl :message-ttl})

Creates a javax.jms.MessageProducer on Session s that will send messages to Destination d. May optionally pass a map of {:delivery-mode dm, :message-ttl ttl} to configure the default delivery-mode and time-to-live for messages sent by the MessageProducer.

message-producer? clj

(message-producer? p)

Predicate that tests if p is a javax.jms.MessageProducer.

message? clj

(message? m)

Predicate that tests if m is an instance of javax.jms.Message.

queue clj

(queue s q)

Given a Session s, and a Queue identity string q, returns a javax.jms.Queue instance for the identified Queue. If q is already an instance of javax.jms.Queue, then it is returned unchanged. Any other value for q will result in an IllegalArgumentException.

queue? clj

(queue? dest)

Predicate that tests if the value is a javax.jms.Queue

read-bytes clj

(read-bytes m)

(read-bytes m arr)

(read-bytes m arr length)

Reads bytes from a javax.jms.BytesMessage. This only works with and mutates byte-arrays

Arities:

1. Pass a BytesMessage: returns a byte-array containing the contents of the message.
2. Pass BytesMessage and a byte-array: reads contents of message into the byte-array argument up-to the length of the byte-array; returns the byte-array.
3. Pass BytesMessage, byte-array, and integer length: reads upto 'length' bytes into byte-array from the BytesMessage; returns the byte-array.

send-message! clj

(send-message! p)

(send-message! p m)

(send-message! p d m)

Sends a Message m via MessageProducer p.

The single arity call is a no-op that allow send-message! to be used in a reducing or transducing context.

session-options clj

(session-options session)

Given a javax.jms.Session, returns a map of the options used to create/configure that session.

The resulting option map is valid to pass to create-session.

session? clj

(session? s)

Predicate that tests if the argument is a javax.jms.Session

set-message-info! clj

(set-message-info! m
                   {:keys [message-id message-type timestamp expiration
                           correlation-id destination reply-to delivery-mode
                           priority redelivered?]})

Sets common metadata on a Message.

topic clj

(topic s t)

Given a Session s, and a Topic identity string t, returns a javax.jms.Topic instance for the identified Topic. If t is already an instance of javax.jms.Topic, then it is returned unchanged. Any other value for t will result in an IllegalArgumentException.

topic? clj

(topic? dest)

Predicate that tests if the value is a javax.jms.Topic

write-bytes clj

(write-bytes m arr)

(write-bytes m arr offset length)

Writes the contents of byte-array 'arr' into the body of BytesMessage 'm'. May optionally pass integer 'offset' and 'length' which will write the contents of 'arr[offset]..arr[length-1]' into message 'm'.