com.delphix.masking.api.plugin.referenceType

Class MappingSetReference

java.lang.Object

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

com.delphix.masking.api.plugin.referenceType.MappingSetReference

public final class MappingSetReference
extends GenericReference

This class wraps a mappingSet reference in order to make it discoverable by the MaskingAPI via reflection.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	database
java.lang.String	host
boolean	isRemote
java.lang.Integer	port
FileReference	propertiesRef
java.lang.String	schema

Constructor Summary

Constructors

Constructor and Description
MappingSetReference()
MappingSetReference(java.lang.String algorithmName) Build MappingSetReference for a local mapping set.
MappingSetReference(java.lang.String algorithmName, java.lang.String host, java.lang.Integer port, java.lang.String database, java.lang.String schema, FileReference propertiesRef, boolean isRemote) Construct a MappingSetReference.

Method Summary

Modifier and Type	Method and Description
void	checkValid() Check whether the reference is syntactically valid.
java.lang.String	getDatabase()
java.lang.String	getHost()
boolean	getIsRemote()
java.lang.Integer	getPort()
FileReference	getPropertiesRef()
java.lang.String	getSchema()
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

Field Detail

host

public java.lang.String host

port

public java.lang.Integer port

database

public java.lang.String database

schema

public java.lang.String schema

propertiesRef

public FileReference propertiesRef

isRemote

public boolean isRemote

Constructor Detail

MappingSetReference

public MappingSetReference()

MappingSetReference

public MappingSetReference(java.lang.String algorithmName)

Build MappingSetReference for a local mapping set.

Parameters:

algorithmName - The name of the algorithm to which the mappings belong

MappingSetReference

public MappingSetReference(java.lang.String algorithmName,
                           java.lang.String host,
                           java.lang.Integer port,
                           java.lang.String database,
                           java.lang.String schema,
                           FileReference propertiesRef,
                           boolean isRemote)

Construct a MappingSetReference. This constructor is used to build remote mapping sets for which a number of configuration inputs are required to connect to the external database where the mappings are stored.

Parameters:

algorithmName - The name of the algorithm to which the mappings belong

host - The host name or IP address for a remote mappings set

port - The port number for a remote mapping set

database - The database name for a remote mapping set

schema - The database schema for a remote mapping set

propertiesRef - The connection properties reference for a remote mapping set

isRemote - Whether the mapping set is remote

Method Detail

getValue

@JsonPropertyDescription(value="algorithmName")
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.

getHost

@JsonPropertyDescription(value="host")
public java.lang.String getHost()

getPort

@JsonPropertyDescription(value="port")
public java.lang.Integer getPort()

getDatabase

@JsonPropertyDescription(value="database")
public java.lang.String getDatabase()

getSchema

@JsonPropertyDescription(value="schema")
public java.lang.String getSchema()

getPropertiesRef

@JsonPropertyDescription(value="propertiesRef")
public FileReference getPropertiesRef()

getIsRemote

@JsonPropertyDescription(value="isRemote")
public boolean getIsRemote()

checkValid

public void checkValid()
                throws ComponentConfigurationException

Description copied from class: GenericReference

Check whether the reference is syntactically valid.

Overrides:

checkValid in class GenericReference

Throws:

ComponentConfigurationException - When the reference is not valid.