com.delphix.masking.api.plugin.referenceType

Class KeyReference

java.lang.Object

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

com.delphix.masking.api.plugin.referenceType.KeyReference

public final class KeyReference
extends GenericReference

This class wraps a key reference in order to make it discoverable by the MaskingAPI via reflection. Currently, the only supported value for a key reference is "", but in the future, this may refer to keys in an external keystore.

Constructor Summary

Constructors

Constructor and Description
KeyReference()
KeyReference(java.lang.String value) Construct a key reference.

Method Summary

Modifier and Type	Method and Description
void	checkValid() Test whether an key 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

KeyReference

public KeyReference()

KeyReference

public KeyReference(@Nonnull
                    java.lang.String value)

Construct a key reference.

Parameters:

value - The only value currently supported is "", referring to the algorithm's key.

Method Detail

getValue

@JsonPropertyDescription(value="The key identifier - only \"\" is supported indicating the component\'s built-in key")
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 key 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. Key references are a special case where empty string is a valid value, referring to the component's built-in key.

Overrides:

checkValid in class GenericReference

Throws:

ComponentConfigurationException - When the reference is invalid