org.apache.nifi.processors.standard

Class AttributesToJSON

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.AttributesToJSON

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @Tags(value={"json","attributes","flowfile"})
 @InputRequirement(value=INPUT_REQUIRED)
 @CapabilityDescription(value="Generates a JSON representation of the input FlowFile Attributes. The resulting JSON can be written to either a new Attribute \'JSONAttributes\' or written to the FlowFile as content.")
 @WritesAttribute(attribute="JSONAttributes",
                 description="JSON representation of Attributes")
public class AttributesToJSON
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_JSON
private static String	AT_LIST_SEPARATOR
private Set<String>	attributes
static PropertyDescriptor	ATTRIBUTES_LIST
static PropertyDescriptor	ATTRIBUTES_REGEX
private Set<String>	attributesToRemove
static PropertyDescriptor	DESTINATION
static String	DESTINATION_ATTRIBUTE
static String	DESTINATION_CONTENT
private boolean	destinationContent
static PropertyDescriptor	INCLUDE_CORE_ATTRIBUTES
static String	JSON_ATTRIBUTE_NAME
static PropertyDescriptor	NULL_VALUE_FOR_EMPTY_STRING
private Boolean	nullValueForEmptyString
private static com.fasterxml.jackson.databind.ObjectMapper	objectMapper
private Pattern	pattern
private List<PropertyDescriptor>	properties
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships

Constructor Summary

Constructors

Constructor and Description
AttributesToJSON()

Method Summary

Modifier and Type	Method and Description
private Set<String>	buildAtrs(String atrList, Set<String> atrsToExclude)
protected Map<String,String>	buildAttributesMapForFlowFile(FlowFile ff, Set<String> attributes, Set<String> attributesToRemove, boolean nullValForEmptyString, Pattern attPattern) Builds the Map of attributes that should be included in the JSON that is emitted from this process.
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)

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

onTrigger

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

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, 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.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

JSON_ATTRIBUTE_NAME

public static final String JSON_ATTRIBUTE_NAME

See Also:

Constant Field Values

AT_LIST_SEPARATOR

private static final String AT_LIST_SEPARATOR

See Also:

Constant Field Values

DESTINATION_ATTRIBUTE

public static final String DESTINATION_ATTRIBUTE

See Also:

Constant Field Values

DESTINATION_CONTENT

public static final String DESTINATION_CONTENT

See Also:

Constant Field Values

APPLICATION_JSON

public static final String APPLICATION_JSON

See Also:

Constant Field Values

ATTRIBUTES_LIST

public static final PropertyDescriptor ATTRIBUTES_LIST

ATTRIBUTES_REGEX

public static final PropertyDescriptor ATTRIBUTES_REGEX

DESTINATION

public static final PropertyDescriptor DESTINATION

INCLUDE_CORE_ATTRIBUTES

public static final PropertyDescriptor INCLUDE_CORE_ATTRIBUTES

NULL_VALUE_FOR_EMPTY_STRING

public static final PropertyDescriptor NULL_VALUE_FOR_EMPTY_STRING

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

properties

private List<PropertyDescriptor> properties

relationships

private Set<Relationship> relationships

objectMapper

private static final com.fasterxml.jackson.databind.ObjectMapper objectMapper

attributesToRemove

private volatile Set<String> attributesToRemove

attributes

private volatile Set<String> attributes

nullValueForEmptyString

private volatile Boolean nullValueForEmptyString

destinationContent

private volatile boolean destinationContent

pattern

private volatile Pattern pattern

Constructor Detail

AttributesToJSON

public AttributesToJSON()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

buildAttributesMapForFlowFile

protected Map<String,String> buildAttributesMapForFlowFile(FlowFile ff,
                                                           Set<String> attributes,
                                                           Set<String> attributesToRemove,
                                                           boolean nullValForEmptyString,
                                                           Pattern attPattern)

Builds the Map of attributes that should be included in the JSON that is emitted from this process.

Returns:

Map of values that are feed to a Jackson ObjectMapper

buildAtrs

private Set<String> buildAtrs(String atrList,
                              Set<String> atrsToExclude)

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException