PutJMS

Deprecation notice:

This processor is deprecated and may be removed in future releases.

Please consider using one the following alternatives: PublishJMS

Description:

Creates a JMS Message from the contents of a FlowFile and sends the message to a ActiveMQ JMS Server.

Tags:

jms, send, put

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
JMS ProviderJMS ProviderActiveMQ
  • ActiveMQ
The Provider used for the JMS Server
URLURLThe URL of the JMS Server
Destination NameDestination NameThe name of the JMS Topic or queue to use
Destination TypeDestination TypeQueue
  • Queue
  • Topic
The type of the JMS Destination to use
Communications TimeoutCommunications Timeout30 secThe amount of time to wait when attempting to receive a message before giving up and assuming failure
Message Batch SizeMessage Batch Size10The number of messages to pull/push in a single iteration of the processor
UsernameUsernameUsername used for authentication and authorization
PasswordPasswordPassword used for authentication and authorization
Sensitive Property: true
SSL Context ServiceSSL Context ServiceController Service API:
SSLContextService
Implementations: StandardRestrictedSSLContextService
StandardSSLContextService
The Controller Service to use in order to obtain an SSL Context.
Message TypeMessage Typebyte
  • byte
  • stream
  • text
  • map
  • empty
The Type of JMS Message to Construct
Message PriorityMessage PriorityThe Priority of the Message
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Reply-To QueueReply-To QueueThe name of the queue to which a reply to should be added
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Max Buffer SizeMax Buffer Size1 MBThe maximum amount of data that can be buffered for a JMS Message. If a FlowFile's size exceeds this value, the FlowFile will be routed to failure.
Message Time to LiveMessage Time to LiveThe amount of time that the message should live on the destination before being removed; if not specified, the message will never expire.
Copy Attributes to JMS PropertiesCopy Attributes to JMS Propertiestrue
  • true
  • false
Whether or not FlowFile Attributes should be translated into JMS Message Properties. If true, all attributes starting with 'jms.' will be set as Properties on the JMS Message (without the 'jms.' prefix). If an attribute exists that starts with the same value but ends in '.type', that attribute will be used to determine the JMS Message Property type.
Client ID PrefixClient ID PrefixA human-readable ID that can be used to associate connections with yourself so that the maintainers of the JMS Server know who to contact if problems arise

Relationships:

NameDescription
successAll FlowFiles that are sent to the JMS destination are routed to this relationship
failureAll FlowFiles that cannot be routed to the JMS destination are routed to this relationship

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.

See Also:

GetJMSQueue, GetJMSTopic