com.delphix.masking.api.plugin.referenceType

Class AlgorithmInstanceReference

java.lang.Object

com.delphix.masking.api.plugin.referenceType.GenericReference

com.delphix.masking.api.plugin.referenceType.AlgorithmInstanceReference

public final class AlgorithmInstanceReference
extends GenericReference

This class wraps an algorithm instance reference in order to make it discoverable by the MaskingAPI via reflection.

Constructor Summary

Constructors

Constructor and Description
AlgorithmInstanceReference()
AlgorithmInstanceReference(java.lang.String name) Construct a reference to an algorithm instance.

Method Summary

Modifier and Type	Method and Description
void	checkValid() Test whether an algorithm reference is syntactically valid.
java.lang.String	getValue() Getter

Methods inherited from class com.delphix.masking.api.plugin.referenceType.GenericReference

checkOptionalReference, checkRequiredReference, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

AlgorithmInstanceReference

public AlgorithmInstanceReference()

AlgorithmInstanceReference

public AlgorithmInstanceReference(@Nonnull
                                  java.lang.String name)

Construct a reference to an algorithm instance.

Parameters:

name - The name of the algorithm instance, including plugin name and the ':' delimiter for algorithms provided by plugins.

Method Detail

getValue

@JsonPropertyDescription(value="The algorithm instance name, starting with \":\" for instances provided by this plugin")
public java.lang.String getValue()

Description copied from class: GenericReference

Getter

Overrides:

getValue in class GenericReference

Returns:

The name of the algorithm associated with this reference.

checkValid

public void checkValid()
                throws ComponentConfigurationException

Test whether an algorithm reference is syntactically valid. This does not test whether the referenced object is currently available. This method throws the appropriate exception if the reference is invalid.

Overrides:

checkValid in class GenericReference

Throws:

ComponentConfigurationException - When the reference is invalid