com.delphix.masking.api.plugin.typeAdapters

Interface TypeAdapter<A,D>

Type Parameters:

A - The algorithm data type

D - The underlying data type

All Known Implementing Classes:

BigDecimalToBigInteger, BigDecimalToBoolean, BigDecimalToDouble, BigDecimalToInteger, BigDecimalToLong, BigDecimalToString, ByteBufferToBinary, ByteBufferToString, LocalDateTimeToBigDecimal, LocalDateTimeToBigInteger, LocalDateTimeToDate, LocalDateTimeToDouble, LocalDateTimeToInteger, LocalDateTimeToLong, LocalDateTimeToString, PassThroughAdapter, StringToBigDecimal, StringToBigInteger, StringToBinary, StringToBoolean, StringToByteBuffer, StringToDate, StringToDouble, StringToInteger, StringToLong

public interface TypeAdapter<A,D>

This is the general interface implemented by classes used internally by the masking framework to apply algorithms to data that is not of the type expected by the algorithm. The possible algorithm types are enumerated in MaskingAlgorithm.MaskingType, while the possible underlying types are enumerated in UnderlyingDataType.

Each type adapter class implements a pair of type conversions. As each value to be masked requires a new TypeAdapter, a TypeAdapterFactory is typically used to create them. That class also maintains a list of available adapters classes.

If a type conversion cannot be performed because the underlying value is empty or all-whitespace, the adapter should return null in underlyingToAlgorithm, but substitute the original empty value back in algorithmToUnderlying should the algorithm return null. This allows empty values to pass through unchanged, even when the algorithmType is not able to express such empty values. This is necessary, for example, when a Date algorithm is applied to String type underlying date.

Since:

1.3.0

Method Summary

Modifier and Type	Method and Description
D	algorithmToUnderlying(A algorithmValue) Convert an object from the algorithm type to the underlying type.
default void	configure(MaskValueMetadata metadata) Configure this type adapter.
default void	configure(MaskValueMetadata metadata, MaskingAlgorithm<A> algorithm) Configure this adapter.
MaskingAlgorithm.MaskingType	getAlgorithmType() Get the algorithm type of this type adapter.
UnderlyingDataType	getUnderlyingType() Get the underlying type of this type adapter.
A	underlyingToAlgorithm(D underlyingValue) Convert an object from the underlying type to the algorithm type.

Method Detail

getAlgorithmType

MaskingAlgorithm.MaskingType getAlgorithmType()

Get the algorithm type of this type adapter.

Returns:

The algorithm type

getUnderlyingType

UnderlyingDataType getUnderlyingType()

Get the underlying type of this type adapter.

Returns:

The underlying type

configure

default void configure(MaskValueMetadata metadata)

Configure this type adapter. This method is always called prior to any of the below methods.

Parameters:

metadata - An interface providing methods to retrieve additional information about the underlying type

configure

default void configure(MaskValueMetadata metadata,
                       @Nullable
                       MaskingAlgorithm<A> algorithm)

Configure this adapter. This method is always called prior to any of the below methods.

Parameters:

metadata - An interface providing methods to retrieve additional information about the underlying type

algorithm - An algorithm instance this adapter is instantiated for

Since:

1.8.0

algorithmToUnderlying

D algorithmToUnderlying(A algorithmValue)
                 throws PostMaskTypeConversionException

Convert an object from the algorithm type to the underlying type.

Parameters:

algorithmValue - An object of the type referenced by getAlgorithmType

Returns:

An object of the type referenced by getUnderlyingType

Throws:

PostMaskTypeConversionException - If the type conversion fails

underlyingToAlgorithm

A underlyingToAlgorithm(D underlyingValue)
                 throws PreMaskTypeConversionException

Convert an object from the underlying type to the algorithm type.

Parameters:

underlyingValue - An object of the type referenced by getUnderlyingType

Returns:

An object of the type referenced by getAlgorithmType

Throws:

PreMaskTypeConversionException - If the type conversion fails