org.apache.nifi.processors.standard

Class CryptographicHashAttribute

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.CryptographicHashAttribute

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @Tags(value={"attributes","hash","md5","sha","keccak","blake2","cryptography"})
 @InputRequirement(value=INPUT_REQUIRED)
 @CapabilityDescription(value="Calculates a hash value for each of the specified attributes using the given algorithm and writes it to an output attribute. Please refer to https://csrc.nist.gov/Projects/Hash-Functions/NIST-Policy-on-Hash-Functions for help to decide which algorithm to use. ")
 @WritesAttribute(attribute="<Specified Attribute Name per Dynamic Property>",
                 description="This Processor adds an attribute whose value is the result of hashing the specified attribute. The name of this attribute is specified by the value of the dynamic property.")
 @DynamicProperty(name="A flowfile attribute key for attribute inspection",
                 value="Attribute Name",
                 description="The property name defines the attribute to look for and hash in the incoming flowfile. The property value defines the name to give the generated attribute. Attribute names must be unique.")
public class CryptographicHashAttribute
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CryptographicHashAttribute.PartialAttributePolicy

Field Summary

Fields

Modifier and Type	Field and Description
private static AllowableValue	ALLOW_PARTIAL_ATTRIBUTES_VALUE
private AtomicReference<Map<String,String>>	attributeToGenerateNameMapRef
(package private) static PropertyDescriptor	CHARACTER_SET
private static AllowableValue	FAIL_PARTIAL_ATTRIBUTES_VALUE
(package private) static PropertyDescriptor	FAIL_WHEN_EMPTY
(package private) static PropertyDescriptor	HASH_ALGORITHM
(package private) static PropertyDescriptor	PARTIAL_ATTR_ROUTE_POLICY
private static List<PropertyDescriptor>	properties
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
private static Set<Relationship>	relationships

Constructor Summary

Constructors

Constructor and Description
CryptographicHashAttribute()

Method Summary

Modifier and Type	Method and Description
private static String	getMissingKeysString(Set<String> foundKeys, Set<String> wantedKeys)
Set<Relationship>	getRelationships()
private static SortedMap<String,String>	getRelevantAttributes(FlowFile flowFile, Map<String,String> attributeToGeneratedNameMap)
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
private String	hashValue(HashAlgorithm algorithm, String value, Charset charset)
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue)
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, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

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

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, 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, validate

Field Detail

ALLOW_PARTIAL_ATTRIBUTES_VALUE

private static final AllowableValue ALLOW_PARTIAL_ATTRIBUTES_VALUE

FAIL_PARTIAL_ATTRIBUTES_VALUE

private static final AllowableValue FAIL_PARTIAL_ATTRIBUTES_VALUE

CHARACTER_SET

static final PropertyDescriptor CHARACTER_SET

FAIL_WHEN_EMPTY

static final PropertyDescriptor FAIL_WHEN_EMPTY

HASH_ALGORITHM

static final PropertyDescriptor HASH_ALGORITHM

PARTIAL_ATTR_ROUTE_POLICY

static final PropertyDescriptor PARTIAL_ATTR_ROUTE_POLICY

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

relationships

private static final Set<Relationship> relationships

properties

private static final List<PropertyDescriptor> properties

attributeToGenerateNameMapRef

private final AtomicReference<Map<String,String>> attributeToGenerateNameMapRef

Constructor Detail

CryptographicHashAttribute

public CryptographicHashAttribute()

Method Detail

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

onPropertyModified

public void onPropertyModified(PropertyDescriptor descriptor,
                               String oldValue,
                               String newValue)

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

Specified by:

onTrigger in class AbstractProcessor

getRelevantAttributes

private static SortedMap<String,String> getRelevantAttributes(FlowFile flowFile,
                                                              Map<String,String> attributeToGeneratedNameMap)

hashValue

private String hashValue(HashAlgorithm algorithm,
                         String value,
                         Charset charset)

getMissingKeysString

private static String getMissingKeysString(Set<String> foundKeys,
                                           Set<String> wantedKeys)