flux.file
Class FileEncryptPgpAction

java.lang.Object
  fluximpl.ActionFlowChartImpl
      fluximpl.ActionImpl
          fluximpl.file.AbstractSingleFileParameter
              fluximpl.file.AbstractDoubleFileParameter
                  fluximpl.file.pgp.AbstractPgpAction
                      fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl
                          flux.file.FileEncryptPgpAction

All Implemented Interfaces:

Action, DoubleFileParameter, SingleFileParameter, RuntimeDataMap, fluximpl.dev.ActionDev, fluximpl.dev.ActionTriggerDev, java.io.Serializable, java.lang.Cloneable

public class FileEncryptPgpAction
extends fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl

Encrypts a set of files using PGP encryption. The encryption is secured by either a public key from the repository or a passphrase. The bytes of each file are streamed from the source host and are encrypted along the way so no unencrypted data is stored in transit.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

See Also:

Serialized Form

Field Summary

Fields inherited from class fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl

VARIABLE_NAME

Fields inherited from class fluximpl.ActionImpl

END_OF_RUN, JOIN_EXP, START_OF_RUN, TIMEOUT_BI, TIMEOUT_BI_NAMESPACE

Fields inherited from class fluximpl.ActionFlowChartImpl

actionsLock

Constructor Summary

FileEncryptPgpAction()
Creates a PGP encryption action that is not associated with a flow chart.

FileEncryptPgpAction(FlowChart flowChart, java.lang.String name)
Creates a PGP encryption action that is associated with the specified flow chart.

Method Summary

PgpEncryptionAlgorithm	getAlgorithm() Returns the encryption algorithm used for the PGP encryption.
java.lang.String	getKeyNamespace() Returns the repository namespace this action will use to retrieve the public key.
java.lang.String	getPassphrase() Returns the passphrase used to secure the PGP encryption.
boolean	isArmored() Indicates whether the encryption will be ASCII armored.
boolean	isDeleteSource() Indicates whether the unencrypted source files should be deleted after completing the encryption.
void	setAlgorithm(PgpEncryptionAlgorithm algorithm) Sets the encryption algorithm used for the PGP encryption.
void	setArmored(boolean armored) Sets whether the encryption will be ASCII armored.
void	setDeleteSource(boolean deleteSource) Sets whether the unencrypted source files should be deleted after completing the encryption.
void	setKeyNamespace(java.lang.String repositoryNamespace) Sets the repository namespace this action will use to retrieve the public key.
void	setPassphrase(java.lang.String passPhrase) Sets the passphrase used to secure the PGP encryption.

Methods inherited from class fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl

doPgpWork, verify

Methods inherited from class fluximpl.file.pgp.AbstractPgpAction

getHiddenVariableNames

Methods inherited from class fluximpl.file.AbstractDoubleFileParameter

addTarget, execute, getIndexedTargets, getIndexedTargets, getTargets, isPreserveDirectoryStructure, setIndexedTargets, setIndexedTargets, setPreserveDirectoryStructure, setTargets

Methods inherited from class fluximpl.file.AbstractSingleFileParameter

addSource, clear, getIndexedSources, getIndexedSources, getSources, setIndexedSources, setIndexedSources, setSources

Methods inherited from class fluximpl.ActionImpl

addFlow, addFlow, addInFlow, addOutFlow, addPropertyChangeListener, addSignalFlow, auditForAgent, calculateTimeout, clearInFlow, clone, cloneFlows, countSignals, doDataMapping, equals, getAuditTrailDetails, getFlows, getInFlows, getJoinExpression, getNote, getOutFlows, getPoint, getPostscript, getPostscriptLanguage, getPrescript, getPrescriptLanguage, getResultInfo, getRuntimeDataMap, getSignalsToMonitor, getTimeoutBusinessInterval, getTimeoutBusinessIntervalNamespace, getTimeoutExpression, getX, getY, hashCode, isEndOfRun, isJoinPoint, isMarkedForSkip, isSkippable, isStartAction, isStartOfRun, isTransactionBreak, makeTimeoutSignal, postClone, preClone, removeFlow, removeInFlow, removePropertyChangeListener, setElseFlow, setEndOfRun, setErrorFlow, setErrorFlowWithoutRollback, setErrorFlowWithRollback, setJoinExpression, setJoinPoint, setMarkedForSkip, setName, setNameWithoutErrorCheck, setNote, setPoint, setPostscript, setPostscriptLanguage, setPrescript, setPrescriptLanguage, setRuntimeDataMap, setSignalsToMonitor, setSkippable, setStartAction, setStartOfRun, setTimeoutBusinessInterval, setTimeoutBusinessIntervalNamespace, setTimeoutExpression, setTimeoutFlow, setTransactionBreak, setX, setY, toString, verifyOnClient, verifyTimeout

Methods inherited from class fluximpl.ActionFlowChartImpl

getDescription, getId, getName, getVariableManager, reset, setDescription, setId, setVariableManager

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface flux.file.SingleFileParameter

addSource, clear, getSources

Constructor Detail

FileEncryptPgpAction

public FileEncryptPgpAction()

Creates a PGP encryption action that is not associated with a flow chart.

FileEncryptPgpAction

public FileEncryptPgpAction(FlowChart flowChart,
                            java.lang.String name)

Creates a PGP encryption action that is associated with the specified flow chart.

Method Detail

getAlgorithm

public PgpEncryptionAlgorithm getAlgorithm()

Returns the encryption algorithm used for the PGP encryption.

Overrides:

getAlgorithm in class fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl

Returns:

The encryption algorithm used for this PGP encryption.

getKeyNamespace

public java.lang.String getKeyNamespace()

Returns the repository namespace this action will use to retrieve the public key. This property cannot be set if a passphrase has been specified.

Overrides:

getKeyNamespace in class fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl

Returns:

The repository namespace this action will use to retrieve the public key.

getPassphrase

public java.lang.String getPassphrase()

Returns the passphrase used to secure the PGP encryption. This property cannot be set if a key namespace has been specified.

Overrides:

getPassphrase in class fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl

Returns:

The passphrase used to secure the PGP encryption.

isArmored

public boolean isArmored()

Indicates whether the encryption will be ASCII armored.

Overrides:

isArmored in class fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl

Returns:

Whether the encryption will be ASCII armored.

isDeleteSource

public boolean isDeleteSource()

Indicates whether the unencrypted source files should be deleted after completing the encryption.

Overrides:

isDeleteSource in class fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl

Returns:

Whether the unencrypted source files should be deleted after completing the encryption.

setAlgorithm

public void setAlgorithm(PgpEncryptionAlgorithm algorithm)

Sets the encryption algorithm used for the PGP encryption.

Overrides:

setAlgorithm in class fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl

Parameters:

algorithm - The encryption algorithm used for the PGP encryption.

setArmored

public void setArmored(boolean armored)

Sets whether the encryption will be ASCII armored.

Overrides:

setArmored in class fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl

Parameters:

armored - Whether the encryption will be ASCII armored.

setDeleteSource

public void setDeleteSource(boolean deleteSource)

Sets whether the unencrypted source files should be deleted after completing the encryption.

Overrides:

setDeleteSource in class fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl

Parameters:

deleteSource - Whether the unencrypted source files should be deleted after completing the encryption.

setKeyNamespace

public void setKeyNamespace(java.lang.String repositoryNamespace)

Sets the repository namespace this action will use to retrieve the public key. This property cannot be set if a passphrase has been specified.

Overrides:

setKeyNamespace in class fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl

Parameters:

repositoryNamespace - The repository namespace this action will use to retrieve the public key. This property can not be set if a passphrase has been specified.

setPassphrase

public void setPassphrase(java.lang.String passPhrase)

Sets the passphrase used to secure the PGP encryption. This property cannot be set if a key namespace has been specified.

Overrides:

setPassphrase in class fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl

Parameters:

passPhrase - The passphrase used to secure the PGP encryption.