org.apache.nifi.processors.standard

Class GetJMSTopic

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.JmsConsumer

org.apache.nifi.processors.standard.GetJMSTopic

All Implemented Interfaces:

ConfigurableComponent, Processor

Deprecated.

@PrimaryNodeOnly
 @Deprecated
 @DeprecationNotice(classNames="org.apache.nifi.jms.processors.ConsumeJMS",
                   reason="This processor is deprecated and may be removed in future releases.")
 @TriggerSerially
 @TriggerWhenEmpty
 @InputRequirement(value=INPUT_FORBIDDEN)
 @Tags(value={"jms","topic","subscription","durable","non-durable","listen","get","pull","source","consume","consumer"})
 @CapabilityDescription(value="Pulls messages from a ActiveMQ JMS Topic, creating a FlowFile for each JMS Message or bundle of messages, as configured.")
 @SeeAlso(value=PutJMS.class)
public class GetJMSTopic
extends JmsConsumer

Field Summary

Fields

Modifier and Type	Field and Description
private List<PropertyDescriptor>	properties Deprecated.
static String	SUBSCRIPTION_NAME_PROPERTY Deprecated.
private WrappedMessageConsumer	wrappedConsumer Deprecated.

Fields inherited from class org.apache.nifi.processors.standard.JmsConsumer

MAP_MESSAGE_PREFIX, REL_SUCCESS

Constructor Summary

Constructors

Constructor and Description
GetJMSTopic() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	cleanupResources() Deprecated.
protected void	decryptPassword(Properties properties, ProcessContext context) Deprecated. Attempts to locate the password in the specified properties.
private Path	getSubscriptionPath() Deprecated.
private Properties	getSubscriptionPropertiesFromContext(ProcessContext context) Deprecated. Returns the subscription details from the specified context.
private Properties	getSubscriptionPropertiesFromFile() Deprecated. Loads the subscription details from disk.
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors() Deprecated.
void	handleSubscriptions(ProcessContext context) Deprecated.
void	onRemoved(ProcessContext context) Deprecated.
void	onStopped() Deprecated.
void	onTrigger(ProcessContext context, ProcessSession session) Deprecated.
private void	persistSubscriptionInfo(ProcessContext context) Deprecated. Persists the subscription details for future use.
private void	unsubscribe(ProcessContext context) Deprecated. Loads subscription info from the Subscription File and unsubscribes from the subscription, if the file exists; otherwise, does nothing
private void	unsubscribe(String url, String username, String password, String subscriptionId, String jmsProvider, int timeoutMillis) Deprecated.

Methods inherited from class org.apache.nifi.processors.standard.JmsConsumer

consume, createMapMessageValues, getRelationships, map2FlowFile

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

SUBSCRIPTION_NAME_PROPERTY

public static final String SUBSCRIPTION_NAME_PROPERTY

Deprecated.

See Also:

Constant Field Values

wrappedConsumer

private volatile WrappedMessageConsumer wrappedConsumer

Deprecated.

properties

private final List<PropertyDescriptor> properties

Deprecated.

Constructor Detail

GetJMSTopic

public GetJMSTopic()

Deprecated.

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Deprecated.

Overrides:

getSupportedPropertyDescriptors in class JmsConsumer

cleanupResources

@OnStopped
public void cleanupResources()

Deprecated.

getSubscriptionPath

private Path getSubscriptionPath()

Deprecated.

handleSubscriptions

@OnScheduled
public void handleSubscriptions(ProcessContext context)
                                      throws IOException,
                                             javax.jms.JMSException

Deprecated.

Throws:

IOException

javax.jms.JMSException

decryptPassword

protected void decryptPassword(Properties properties,
                               ProcessContext context)

Deprecated.

Attempts to locate the password in the specified properties. If found, decrypts it using the specified context.

Parameters:

properties - properties

context - context

onRemoved

@OnRemoved
public void onRemoved(ProcessContext context)
                          throws IOException,
                                 javax.jms.JMSException

Deprecated.

Throws:

IOException

javax.jms.JMSException

persistSubscriptionInfo

private void persistSubscriptionInfo(ProcessContext context)
                              throws IOException

Deprecated.

Persists the subscription details for future use.

Parameters:

context - context

Throws:

IOException - ex

getSubscriptionPropertiesFromContext

private Properties getSubscriptionPropertiesFromContext(ProcessContext context)

Deprecated.

Returns the subscription details from the specified context. Note: if a password is set, the resulting entry will be encrypted.

Parameters:

context - context

Returns:

Returns the subscription details from the specified context

getSubscriptionPropertiesFromFile

private Properties getSubscriptionPropertiesFromFile()
                                              throws IOException

Deprecated.

Loads the subscription details from disk. Since the details are coming from disk, if a password is set, the resulting entry will be encrypted.

Returns:

properties

Throws:

IOException - ex

unsubscribe

private void unsubscribe(ProcessContext context)
                  throws IOException,
                         javax.jms.JMSException

Deprecated.

Loads subscription info from the Subscription File and unsubscribes from the subscription, if the file exists; otherwise, does nothing

Throws:

IOException - ex

javax.jms.JMSException - ex

unsubscribe

private void unsubscribe(String url,
                         String username,
                         String password,
                         String subscriptionId,
                         String jmsProvider,
                         int timeoutMillis)
                  throws javax.jms.JMSException

Deprecated.

Throws:

javax.jms.JMSException

onStopped

@OnStopped
public void onStopped()

Deprecated.

onTrigger

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

Deprecated.

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException