com.northconcepts.datapipeline.security.SymmetricDecryptingReader

public class SymmetricDecryptingReader extends DecryptingReader

A DecryptingReader that decrypts fields written by a SymmetricEncryptingReader, restoring each field's original type and value.

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint
DataEndpoint.State
Field Summary

Fields inherited from class com.northconcepts.datapipeline.security.DecryptingReader
cipher, deserializer, fields

Fields inherited from class com.northconcepts.datapipeline.core.DataReader
fieldLineage, recordLineage

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint
lastRecord, PRODUCT, PRODUCT_VERSION, VENDOR, XML_INPUT_FACTORY_KEY

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint
BUFFER_SIZE, captureElapsedTime, DEFAULT_READ_BUFFER_SIZE

Fields inherited from class com.northconcepts.datapipeline.core.DataObject
id, log, name, TIMESTAMP_FORMAT
Constructor Summary

Constructors

Constructor

Description

SymmetricDecryptingReader(DataReader nestedDataReader)

SymmetricDecryptingReader(DataReader nestedDataReader, String symmetricAlgorithm, SecretKey symmetricKey)
Method Summary

Modifier and Type

Method

Description

DataException

addExceptionProperties(DataException exception)

Adds this endpoint's current state to a DataException.

SymmetricDecryptingReader

addFields(String... fieldNames)

Adds fields to decrypt; only allowed before the reader is opened.

SymmetricDecryptingReader

addFields(Collection<String> fieldNames)

Adds fields to decrypt; only allowed before the reader is opened.

protected void

decryptFieldImpl(Field field)

Replaces the field's encrypted value in place with the original type and value.

String

getSymmetricAlgorithm()

Returns the Cipher algorithm used to decrypt, such as AES; required to open the reader.

SecretKey

getSymmetricKey()

Returns the secret key used to decrypt; required to open the reader.

protected void

initCipher()

Initializes or resets DecryptingReader.cipher for decryption; called when the reader opens and again after a field fails to decrypt.

SymmetricDecryptingReader

setSymmetricAlgorithm(String symmetricAlgorithm)

Sets the Cipher algorithm used to decrypt, such as AES; required to open the reader.

SymmetricDecryptingReader

setSymmetricKey(SecretKey symmetricKey)

Sets the secret key used to decrypt; required to open the reader.

Methods inherited from class com.northconcepts.datapipeline.security.DecryptingReader
decryptField, getFields, interceptRecord, open

Methods inherited from class com.northconcepts.datapipeline.core.ProxyReader
available, close, getNestedReader, map, map, readImpl, setNestedDataReader, setNestedDataReader

Methods inherited from class com.northconcepts.datapipeline.core.DataReader
addLineage, getBufferSize, getNestedEndpoint, getReader, getRootEndpoint, getRootReader, isExhausted, isLineageSupported, isSaveLineage, peek, pop, push, read, setSaveLineage, skip

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint
decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, resetRecordCount, toString

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint
addElapsedtime, assertClosed, assertNotOpened, assertOpened, finalize, getClosedOn, getDescription, getElapsedTime, getElapsedTimeAsString, getOpenedOn, getOpenElapsedTime, getOpenElapsedTimeAsString, getSelfTime, getSelfTimeAsString, getState, isCaptureElapsedTime, isClosed, isOpen, setCaptureElapsedTime, setDescription

Methods inherited from class com.northconcepts.datapipeline.core.DataObject
exception, exception, exception, getId, getName, resetID

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- SymmetricDecryptingReader
  
  public SymmetricDecryptingReader(DataReader nestedDataReader)
- SymmetricDecryptingReader
  
  public SymmetricDecryptingReader(DataReader nestedDataReader, String symmetricAlgorithm, SecretKey symmetricKey)
Method Details
- getSymmetricAlgorithm
  
  public String getSymmetricAlgorithm()
  
  Returns the Cipher algorithm used to decrypt, such as AES; required to open the reader.
- setSymmetricAlgorithm
  
  public SymmetricDecryptingReader setSymmetricAlgorithm(String symmetricAlgorithm)
  
  Sets the Cipher algorithm used to decrypt, such as AES; required to open the reader.
- getSymmetricKey
  
  public SecretKey getSymmetricKey()
  
  Returns the secret key used to decrypt; required to open the reader.
- setSymmetricKey
  
  public SymmetricDecryptingReader setSymmetricKey(SecretKey symmetricKey)
  
  Sets the secret key used to decrypt; required to open the reader.
- addFields
  
  public SymmetricDecryptingReader addFields(Collection<String> fieldNames)
  
  Description copied from class: DecryptingReader
  
  Adds fields to decrypt; only allowed before the reader is opened.
  
  Overrides:
  
  addFields in class DecryptingReader
- addFields
  
  public SymmetricDecryptingReader addFields(String... fieldNames)
  
  Description copied from class: DecryptingReader
  
  Adds fields to decrypt; only allowed before the reader is opened.
  
  Overrides:
  
  addFields in class DecryptingReader
- initCipher
  
  protected void initCipher()
  
  Description copied from class: DecryptingReader
  
  Initializes or resets DecryptingReader.cipher for decryption; called when the reader opens and again after a field fails to decrypt.
  
  Specified by:
  
  initCipher in class DecryptingReader
- decryptFieldImpl
  
  protected void decryptFieldImpl(Field field) throws Throwable
  
  Description copied from class: DecryptingReader
  
  Replaces the field's encrypted value in place with the original type and value.
  
  Specified by:
  
  decryptFieldImpl in class DecryptingReader
  
  Throws:
  
  Throwable
- addExceptionProperties
  
  public DataException addExceptionProperties(DataException exception)
  
  Description copied from class: Endpoint
  
  Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.
  
  Overrides:
  
  addExceptionProperties in class DecryptingReader

Class SymmetricDecryptingReader

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint

Field Summary

Fields inherited from class com.northconcepts.datapipeline.security.DecryptingReader

Fields inherited from class com.northconcepts.datapipeline.core.DataReader

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint

Fields inherited from class com.northconcepts.datapipeline.core.DataObject

Constructor Summary

Method Summary

Methods inherited from class com.northconcepts.datapipeline.security.DecryptingReader

Methods inherited from class com.northconcepts.datapipeline.core.ProxyReader

Methods inherited from class com.northconcepts.datapipeline.core.DataReader

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint

Methods inherited from class com.northconcepts.datapipeline.core.DataObject

Methods inherited from class java.lang.Object

Constructor Details

SymmetricDecryptingReader

SymmetricDecryptingReader

Method Details

getSymmetricAlgorithm

setSymmetricAlgorithm

getSymmetricKey

setSymmetricKey

addFields

addFields

initCipher

decryptFieldImpl

addExceptionProperties