com.delphix.masking.api.provider

Interface MaskValueMetadata

All Known Implementing Classes:

MaskValueMetadataImpl

public interface MaskValueMetadata

This interface provides metadata describing each value being masked.

Since:

1.4.0

Field Summary

Fields

Modifier and Type	Field and Description
static long	UNKNOWN_LENGTH_SENTINEL
static long	UNLIMITED_LENGTH_SENTINEL

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDataPathFieldName() Get the field or column name of the data this metadata applies to, or null if no path information is available.
java.lang.String	getDataPathParentName() Get the record or table name of the data this metadata applies to, or null if no path information is available.
java.time.format.DateTimeFormatter	getDateTimeFormatter() Get a formatter appropriate for converting String values to and from LocalDateTime objects.
MaskingAlgorithm.MaskingType	getMaskingType() Get the MaskingAlgorithm.MaskingType type of the values being masked.
long	getMaxLength() Get the maximum size of the value being masked.
int	getNumericPrecision() Get the numeric precision, in digits, of the field.
UnderlyingDataType	getStorageType() Get the UnderlyingDataType value indicating the storage type of the value masked.
java.lang.String	getStringCharsetName() Get the name of the Charset used to encode string values in the underlying data format.
int	getStringMaxLength() Get the maximum length of String that will fit in the field.
boolean	isAutoIncrementField() Get a boolean value indicating whether the field is AUTO_INCREMENT.
boolean	isStringMaxLengthEncoded() Get a boolean value indicating whether the value returned by getStringMaxLength() method represents the maximum Java String length in characters (false), or a byte length limit that should be applied to the encoded String (true).

Field Detail

UNKNOWN_LENGTH_SENTINEL

static final long UNKNOWN_LENGTH_SENTINEL

See Also:

Constant Field Values

UNLIMITED_LENGTH_SENTINEL

static final long UNLIMITED_LENGTH_SENTINEL

See Also:

Constant Field Values

Method Detail

getStorageType

UnderlyingDataType getStorageType()

Get the UnderlyingDataType value indicating the storage type of the value masked. This information more precisely reflects storage type of the value than MaskingType. The result will be null when this information is not available.

The special values UNKNOWN_LENGTH_SENTINEL and UNLIMITED_LENGTH_SENTINEL represent special case values for maximum length. Presence of these sentinels typically means no length restriction will be applied to the mask value.

Returns:

The storage type of value being masked

Since:

1.8.0

getMaxLength

long getMaxLength()

Get the maximum size of the value being masked. The max length will be set if known for all storage types. For string types, this be either the number of characters, or the number of byte of storage available, depending on whether isStringMaxLengthEncoded() returns true.

Returns:

The maximum length of the masked value

Since:

1.8.0

getDateTimeFormatter

java.time.format.DateTimeFormatter getDateTimeFormatter()

Get a formatter appropriate for converting String values to and from LocalDateTime objects.

Returns:

The formatter.

getStringMaxLength

int getStringMaxLength()

Get the maximum length of String that will fit in the field. This method is now an alias for getMaxLength, with the exception that values greater than Integer.MAX_VALUE are reported as Integer.MAX_VALUE.

Returns:

The maximum length of the masked String.

isStringMaxLengthEncoded

boolean isStringMaxLengthEncoded()

Get a boolean value indicating whether the value returned by getStringMaxLength() method represents the maximum Java String length in characters (false), or a byte length limit that should be applied to the encoded String (true).

Returns:

whether the value of getStringMaxLength represents a byte limit on the encoded value

getStringCharsetName

java.lang.String getStringCharsetName()

Get the name of the Charset used to encode string values in the underlying data format.

Returns:

The name of the Charset.

getNumericPrecision

int getNumericPrecision()

Get the numeric precision, in digits, of the field. This is the maximum number of base 10 digits that can be store in the field without rounding. This value is approximate when storageType is LONG or DOUBLE, and indicates the number of full decimal digits the field can carry. For example, a 16-bit integer will show value of 4, since the values from 32,768 - 99,999 cannot be represented.

This value is undefined for storage types other than BIG_DECIMAL, LONG and DOUBLE.

A value of 0 will be returned if the numeric precision is known

Returns:

The base numeric precision of the field

Since:

1.8.0

getMaskingType

MaskingAlgorithm.MaskingType getMaskingType()

Get the MaskingAlgorithm.MaskingType type of the values being masked. This information is provided to allow ADVANCED_OBJECT type algorithms to determine the underlying object type for values being masked.

Returns:

The type of value being masked

Since:

1.5.0

getDataPathFieldName

@Nullable
java.lang.String getDataPathFieldName()

Get the field or column name of the data this metadata applies to, or null if no path information is available.

Returns:

The field name

Since:

1.12.0

getDataPathParentName

@Nullable
java.lang.String getDataPathParentName()

Get the record or table name of the data this metadata applies to, or null if no path information is available. For path based inventories, this is the path component immediately above the field or column name.

Returns:

The field name

Since:

1.12.0

isAutoIncrementField

boolean isAutoIncrementField()

Get a boolean value indicating whether the field is AUTO_INCREMENT.

Returns:

whether the field has auto-incrementing values

Since:

1.16.0