org.apache.nifi.processors.standard

Class PutJMS

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.PutJMS

All Implemented Interfaces:

ConfigurableComponent, Processor

Deprecated.

@Deprecated
 @DeprecationNotice(classNames="org.apache.nifi.jms.processors.PublishJMS",
                   reason="This processor is deprecated and may be removed in future releases.")
 @Tags(value={"jms","send","put"})
 @InputRequirement(value=INPUT_REQUIRED)
 @CapabilityDescription(value="Creates a JMS Message from the contents of a FlowFile and sends the message to a ActiveMQ JMS Server.")
 @SeeAlso(value={GetJMSQueue.class,GetJMSTopic.class})
public class PutJMS
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MESSAGE_PRIORITY Deprecated.
private Queue<WrappedMessageProducer>	producerQueue Deprecated.
private List<PropertyDescriptor>	properties Deprecated.
static Relationship	REL_FAILURE Deprecated.
static Relationship	REL_SUCCESS Deprecated.
private Set<Relationship>	relationships Deprecated.
static Charset	UTF8 Deprecated.

Constructor Summary

Constructors

Constructor and Description
PutJMS() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	cleanupResources() Deprecated.
private void	copyAttributesToJmsProps(FlowFile flowFile, javax.jms.Message message) Deprecated. Iterates through all of the flow file's metadata and for any metadata key that starts with jms., the value for the corresponding key is written to the JMS message as a property.
private javax.jms.Message	createMessage(javax.jms.Session jmsSession, ProcessContext context, byte[] messageContent, FlowFile flowFile, javax.jms.Destination replyToQueue, Integer priority) Deprecated.
Set<Relationship>	getRelationships() Deprecated.
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors() Deprecated.
void	onTrigger(ProcessContext context, ProcessSession session) Deprecated.

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

UTF8

public static final Charset UTF8

Deprecated.

DEFAULT_MESSAGE_PRIORITY

public static final int DEFAULT_MESSAGE_PRIORITY

Deprecated.

See Also:

Constant Field Values

REL_SUCCESS

public static final Relationship REL_SUCCESS

Deprecated.

REL_FAILURE

public static final Relationship REL_FAILURE

Deprecated.

producerQueue

private final Queue<WrappedMessageProducer> producerQueue

Deprecated.

properties

private final List<PropertyDescriptor> properties

Deprecated.

relationships

private final Set<Relationship> relationships

Deprecated.

Constructor Detail

PutJMS

public PutJMS()

Deprecated.

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Deprecated.

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Deprecated.

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

cleanupResources

@OnStopped
public void cleanupResources()

Deprecated.

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Deprecated.

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

createMessage

private javax.jms.Message createMessage(javax.jms.Session jmsSession,
                                        ProcessContext context,
                                        byte[] messageContent,
                                        FlowFile flowFile,
                                        javax.jms.Destination replyToQueue,
                                        Integer priority)
                                 throws javax.jms.JMSException

Deprecated.

Throws:

javax.jms.JMSException

copyAttributesToJmsProps

private void copyAttributesToJmsProps(FlowFile flowFile,
                                      javax.jms.Message message)
                               throws javax.jms.JMSException

Deprecated.

Iterates through all of the flow file's metadata and for any metadata key that starts with jms., the value for the corresponding key is written to the JMS message as a property. The name of this property is equal to the key of the flow file's metadata minus the jms.. For example, if the flowFile has a metadata entry:

jms.count = 8

then the JMS message will have a String property added to it with the property name count and value 8. If the flow file also has a metadata key with the name jms.count.type, then the value of that metadata entry will determine the JMS property type to use for the value. For example, if the flow file has the following properties:

jms.count = 8
jms.count.type = integer

Then message will have an INTEGER property added with the value 8.

If the type is not valid for the given value (e.g., jms.count.type = integer and jms.count = hello, then this JMS property will not be added to message.

Parameters:

flowFile - The flow file whose metadata should be examined for JMS properties.

message - The JMS message to which we want to add properties.

Throws:

javax.jms.JMSException - ex