org.apache.nifi.processors.pgp

Class DecryptContentPGP

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.pgp.DecryptContentPGP

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"PGP","GPG","OpenPGP","Encryption","RFC 4880"})
 @CapabilityDescription(value="Decrypt contents of OpenPGP messages. Using the Packaged Decryption Strategy preserves OpenPGP encoding to support subsequent signature verification.")
 @SeeAlso(value={EncryptContentPGP.class,SignContentPGP.class,VerifyContentPGP.class})
 @WritesAttribute(attribute="pgp.literal.data.filename",description="Filename from decrypted Literal Data") @WritesAttribute(attribute="pgp.literal.data.modified",description="Modified Date from decrypted Literal Data") @WritesAttribute(attribute="pgp.symmetric.key.algorithm.block.cipher",description="Symmetric-Key Algorithm Block Cipher") @WritesAttribute(attribute="pgp.symmetric.key.algorithm.id",description="Symmetric-Key Algorithm Identifier")
public class DecryptContentPGP
extends AbstractProcessor

Decrypt Content using Open Pretty Good Privacy decryption methods

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DecryptContentPGP.DecryptStreamCallback

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	DECRYPTION_STRATEGY
private static List<PropertyDescriptor>	DESCRIPTORS
static Relationship	FAILURE
static PropertyDescriptor	PASSPHRASE
private static String	PASSWORD_BASED_ENCRYPTION
static PropertyDescriptor	PRIVATE_KEY_SERVICE
private static String	PUBLIC_KEY_ENCRYPTION
private static Set<Relationship>	RELATIONSHIPS
static Relationship	SUCCESS

Constructor Summary

Constructors

Constructor and Description
DecryptContentPGP()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext context) Custom Validate requires at least one decryption property to be configured
private DecryptionStrategy	getDecryptionStrategy(ProcessContext context)
private char[]	getPassphrase(ProcessContext context)
private PGPPrivateKeyService	getPrivateKeyService(ProcessContext context)
Set<Relationship>	getRelationships() Get Relationships
List<PropertyDescriptor>	getSupportedPropertyDescriptors() Get Supported Property Descriptors
void	onTrigger(ProcessContext context, ProcessSession session) On Trigger decrypts Flow File contents using configured properties

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

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

SUCCESS

public static final Relationship SUCCESS

FAILURE

public static final Relationship FAILURE

DECRYPTION_STRATEGY

public static final PropertyDescriptor DECRYPTION_STRATEGY

PASSPHRASE

public static final PropertyDescriptor PASSPHRASE

PRIVATE_KEY_SERVICE

public static final PropertyDescriptor PRIVATE_KEY_SERVICE

RELATIONSHIPS

private static final Set<Relationship> RELATIONSHIPS

DESCRIPTORS

private static final List<PropertyDescriptor> DESCRIPTORS

PASSWORD_BASED_ENCRYPTION

private static final String PASSWORD_BASED_ENCRYPTION

See Also:

Constant Field Values

PUBLIC_KEY_ENCRYPTION

private static final String PUBLIC_KEY_ENCRYPTION

See Also:

Constant Field Values

Constructor Detail

DecryptContentPGP

public DecryptContentPGP()

Method Detail

getRelationships

public Set<Relationship> getRelationships()

Get Relationships

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

Returns:

Processor Relationships

getSupportedPropertyDescriptors

public final List<PropertyDescriptor> getSupportedPropertyDescriptors()

Get Supported Property Descriptors

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

Processor Supported Property Descriptors

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

On Trigger decrypts Flow File contents using configured properties

Specified by:

onTrigger in class AbstractProcessor

Parameters:

context - Process Context

session - Process Session

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext context)

Custom Validate requires at least one decryption property to be configured

Overrides:

customValidate in class AbstractConfigurableComponent

Parameters:

context - Validation Context

Returns:

Collection of Validation Results

getPassphrase

private char[] getPassphrase(ProcessContext context)

getPrivateKeyService

private PGPPrivateKeyService getPrivateKeyService(ProcessContext context)

getDecryptionStrategy

private DecryptionStrategy getDecryptionStrategy(ProcessContext context)