com.delphix.masking.api.plugin

Interface MaskingBatch<T>

Type Parameters:

T - The type of values contained in the batch

All Known Implementing Classes:

RunnableBatch

public interface MaskingBatch<T>

This class stores a set of values to be masked, and is the input type to the MaskingAlgorithm.maskBatch(com.delphix.masking.api.plugin.MaskingBatch<T>) method. The type paramter T must correspond with one of the classes mentioned in MaskingAlgorithm.MaskingType

Batch masking typically proceeds as follows:

• Determine the size of the batch using size().
• Extract each value to be masked by calling getValue(int) with index values from 0 to (size - 1).
• Mask all values in the batch.
• Add each masked result to the batch by calling setValue(int, T) with index values from 0 to (size - 1).
• Indicate errors masking any particular value by calling setValue(int, T) passing the value index and the error that occurred

Since:

1.5.0

Method Summary

Modifier and Type	Method and Description
T	getValue(int index) Get the value to be masked at a particular index from the batch.
void	setError(int index, MaskingException e) Set the error that occurred when masking a particular item in a batch.
void	setValue(int index, T value) Set the masking result at a particular index in the batch.
int	size() Get the size of the batch.

Method Detail

getValue

@Nullable
T getValue(int index)

Get the value to be masked at a particular index from the batch.

Parameters:

index - The index of the value to get, in the range of 0 to size - 1

Returns:

The value to be masked

setValue

void setValue(int index,
              @Nullable
              T value)

Set the masking result at a particular index in the batch.

Parameters:

index - The index of the value to set, in the range of 0 to size - 1

value - The masked value

setError

void setError(int index,
              @Nonnull
              MaskingException e)

Set the error that occurred when masking a particular item in a batch. All value-specific masking errors should be reported using this method rather throwing an exception directly from MaskingAlgorithm.maskBatch(com.delphix.masking.api.plugin.MaskingBatch<T>).

Parameters:

index - The index of value that was being masked when the error occurred, in the range of 0 to size - 1

e - The error that occurred.

size

int size()

Get the size of the batch.

Returns:

The size of the batch