Package com.northconcepts.datapipeline.security

Class EncryptingReader

java.lang.Object
com.northconcepts.datapipeline.core.DataObject
com.northconcepts.datapipeline.core.Endpoint
com.northconcepts.datapipeline.core.DataEndpoint
com.northconcepts.datapipeline.core.DataReader
com.northconcepts.datapipeline.core.ProxyReader
com.northconcepts.datapipeline.internal.lang.IntegrationProxyReader
com.northconcepts.datapipeline.security.EncryptingReader
Direct Known Subclasses:
AsymmetricEncryptingReader, SymmetricEncryptingReader
public abstract class EncryptingReader extends IntegrationProxyReader
Base class for proxy readers that encrypt the selected fields of each record in place, or every field when none are selected.

  • Field Details

    • fields

      protected final FieldList fields

    • buffer

      protected final ByteArrayOutputStream2 buffer

    • serializer

      protected final BinarySerializer serializer

    • cipher

      protected Cipher cipher

  • Constructor Details

    • EncryptingReader

      public EncryptingReader(DataReader nestedDataReader)

  • Method Details

    • getFields

      public FieldList getFields()
      Returns the fields to encrypt; when empty, every top-level field of each record is encrypted.

    • addFields

      public EncryptingReader addFields(Collection<String> fieldNames)
      Adds fields to encrypt; only allowed before the reader is opened.

    • addFields

      public EncryptingReader addFields(String... fieldNames)
      Adds fields to encrypt; only allowed before the reader is opened.

    • open

      public void open() throws DataException
      Description copied from class: DataEndpoint
      Makes this endpoint ready for reading or writing.
      Overrides:
      open in class IntegrationProxyReader
      Throws:
      DataException

    • initCipher

      protected abstract void initCipher()
      Initializes or resets cipher for encryption; called when the reader opens and again after a field fails to encrypt.

    • interceptRecord

      protected final Record interceptRecord(Record record) throws Throwable
      Description copied from class: ProxyReader
      Overridden by subclasses to transform, drop, or observe a record on its way through this proxy.

      Contract for subclasses (see also docs/authoring/ProxyReader.md):

      • Return the record (possibly modified) to pass it downstream.
      • Return null to drop the record; the framework reads the next one.
      • Throw to fail the pipeline; the framework wraps the throwable in a DataException with .setRecord(record).
      • The nested DataReader is opened and closed for you; do not read from it here.
      • Do not call DataEndpoint.incrementRecordCount() here.
      Overrides:
      interceptRecord in class ProxyReader
      Throws:
      Throwable

    • encryptField

      protected final void encryptField(Field field) throws Throwable
      Encrypts the field with encryptFieldImpl(Field), re-initializing the cipher if that fails.
      Throws:
      Throwable

    • encryptFieldImpl

      protected abstract void encryptFieldImpl(Field field) throws Throwable
      Replaces the field's value in place with its encrypted form.
      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 ProxyReader