com.delphix.masking.api.plugin.utils

Class ComponentChecker

java.lang.Object

com.delphix.masking.api.plugin.utils.ComponentChecker

public final class ComponentChecker
extends java.lang.Object

This class provides a method to check whether a component implements the MaskingAlgorithm interface, and if so, which data type it masks. In the future, methods will be added to discover the dependencies of components on other objects such as algorithms or files.

Method Summary

Modifier and Type	Method and Description
static java.util.Set<AlgorithmInstanceReference>	getAllAlgorithmInstanceRefs(MaskingComponent component) Return as list of all AlgorithmInstanceReference objects referenced by fields in the MaskingComponent object.
static java.util.Set<FileReference>	getAllFileRefs(MaskingComponent component) Return as list of all FileReference objects stored in fields of the MaskingComponent object.
static java.util.Set<KeyReference>	getAllKeyRefs(MaskingComponent component) Return as list of all KeyReference objects stored in fields of the MaskingComponent object.
static MaskingAlgorithm.MaskingType	getMaskingType(MaskingComponent obj) Determines the data type supported by the MaskingAlgorithm interface, and validates that the correct, matching ValueMetadata type parameter was chosen.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getMaskingType

public static MaskingAlgorithm.MaskingType getMaskingType(MaskingComponent obj)

Determines the data type supported by the MaskingAlgorithm interface, and validates that the correct, matching ValueMetadata type parameter was chosen.

Parameters:

obj - The object to be evaluated

Returns:

The class name of the data type supported for masking, or null if the object doesn't implement the MaskingAlgorithm interface.

Throws:

java.lang.IllegalArgumentException - When the object implements an invalid MaskingAlgorithm type

getAllAlgorithmInstanceRefs

public static java.util.Set<AlgorithmInstanceReference> getAllAlgorithmInstanceRefs(MaskingComponent component)

Return as list of all AlgorithmInstanceReference objects referenced by fields in the MaskingComponent object.

Parameters:

component - The component to be checked for algorithm instance references

Returns:

The collection of algorithm instance references

getAllFileRefs

public static java.util.Set<FileReference> getAllFileRefs(MaskingComponent component)

Return as list of all FileReference objects stored in fields of the MaskingComponent object.

Parameters:

component - The component to be checked for file references

Returns:

The collection of file references

getAllKeyRefs

public static java.util.Set<KeyReference> getAllKeyRefs(MaskingComponent component)

Return as list of all KeyReference objects stored in fields of the MaskingComponent object.

Parameters:

component - The component to be checked for key references

Returns:

The set of key references