com.delphix.masking.api.plugin.referenceType

Class GenericReference

java.lang.Object

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

Direct Known Subclasses:

AlgorithmInstanceReference, FileReference, JdbcReference, KeyReference, MappingSetReference

public abstract class GenericReference
extends java.lang.Object

This is the generic type for references to external resources used by components.

Method Summary

Modifier and Type	Method and Description
static void	checkOptionalReference(GenericReference ref, java.lang.String fieldName) Static method to validate an option reference.
static void	checkRequiredReference(GenericReference ref, java.lang.String fieldName) Static method to validate a reference who value is required.
void	checkValid() Check whether the reference is syntactically valid.
java.lang.String	getValue() Getter
void	setValue(java.lang.String value) Setter Sets the reference value.

Methods inherited from class java.lang.Object

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

Method Detail

getValue

public java.lang.String getValue()

Getter

Returns:

The name of the algorithm associated with this reference.

setValue

public void setValue(@Nonnull
                     java.lang.String value)

Setter Sets the reference value.

Parameters:

value - The name of the object, associated with this reference

checkValid

public void checkValid()
                throws ComponentConfigurationException

Check whether the reference is syntactically valid.

Throws:

ComponentConfigurationException - When the reference is not valid.

checkRequiredReference

public static void checkRequiredReference(GenericReference ref,
                                          java.lang.String fieldName)
                                   throws ComponentConfigurationException

Static method to validate a reference who value is required.

Parameters:

ref - The reference to validate

fieldName - The name of the reference for exception reporting

Throws:

ComponentConfigurationException - When the reference is invalid.

checkOptionalReference

public static void checkOptionalReference(GenericReference ref,
                                          java.lang.String fieldName)
                                   throws ComponentConfigurationException

Static method to validate an option reference.

Parameters:

ref - The reference to validate

fieldName - The name of the reference for exception reporting

Throws:

ComponentConfigurationException - When the reference is invalid.