com.northconcepts.datapipeline.security.SymmetricEncryptingReader

public class SymmetricEncryptingReader extends EncryptingReader

An EncryptingReader that encrypts fields with a symmetric key, storing each as Base64 text from which a SymmetricDecryptingReader restores the 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.EncryptingReader
buffer, cipher, fields, serializer

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

SymmetricEncryptingReader(DataReader nestedDataReader)

SymmetricEncryptingReader(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.

SymmetricEncryptingReader

addFields(String... fieldNames)

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

SymmetricEncryptingReader

addFields(Collection<String> fieldNames)

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

protected void

encryptFieldImpl(Field field)

Replaces the field's value in place with its encrypted form.

String

getSymmetricAlgorithm()

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

SecretKey

getSymmetricKey()

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

protected void

initCipher()

Initializes or resets EncryptingReader.cipher for encryption; called when the reader opens and again after a field fails to encrypt.

SymmetricEncryptingReader

setSymmetricAlgorithm(String symmetricAlgorithm)

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

SymmetricEncryptingReader

setSymmetricKey(SecretKey symmetricKey)

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

Methods inherited from class com.northconcepts.datapipeline.security.EncryptingReader
encryptField, 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
- SymmetricEncryptingReader
  
  public SymmetricEncryptingReader(DataReader nestedDataReader)
- SymmetricEncryptingReader
  
  public SymmetricEncryptingReader(DataReader nestedDataReader, String symmetricAlgorithm, SecretKey symmetricKey)
Method Details
- getSymmetricAlgorithm
  
  public String getSymmetricAlgorithm()
  
  Returns the Cipher algorithm used to encrypt, such as AES; required to open the reader.
- setSymmetricAlgorithm
  
  public SymmetricEncryptingReader setSymmetricAlgorithm(String symmetricAlgorithm)
  
  Sets the Cipher algorithm used to encrypt, such as AES; required to open the reader.
- getSymmetricKey
  
  public SecretKey getSymmetricKey()
  
  Returns the secret key used to encrypt; required to open the reader.
- setSymmetricKey
  
  public SymmetricEncryptingReader setSymmetricKey(SecretKey symmetricKey)
  
  Sets the secret key used to encrypt; required to open the reader.
- addFields
  
  public SymmetricEncryptingReader addFields(Collection<String> fieldNames)
  
  Description copied from class: EncryptingReader
  
  Adds fields to encrypt; only allowed before the reader is opened.
  
  Overrides:
  
  addFields in class EncryptingReader
- addFields
  
  public SymmetricEncryptingReader addFields(String... fieldNames)
  
  Description copied from class: EncryptingReader
  
  Adds fields to encrypt; only allowed before the reader is opened.
  
  Overrides:
  
  addFields in class EncryptingReader
- initCipher
  
  protected void initCipher()
  
  Description copied from class: EncryptingReader
  
  Initializes or resets EncryptingReader.cipher for encryption; called when the reader opens and again after a field fails to encrypt.
  
  Specified by:
  
  initCipher in class EncryptingReader
- encryptFieldImpl
  
  protected void encryptFieldImpl(Field field) throws Throwable
  
  Description copied from class: EncryptingReader
  
  Replaces the field's value in place with its encrypted form.
  
  Specified by:
  
  encryptFieldImpl in class EncryptingReader
  
  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 EncryptingReader

Class SymmetricEncryptingReader

Nested Class Summary

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

Field Summary

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

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.EncryptingReader

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

SymmetricEncryptingReader

SymmetricEncryptingReader

Method Details

getSymmetricAlgorithm

setSymmetricAlgorithm

getSymmetricKey

setSymmetricKey

addFields

addFields

initCipher

encryptFieldImpl

addExceptionProperties