com.delphix.masking.api.plugin.referenceType

Class JdbcReference

java.lang.Object

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

com.delphix.masking.api.plugin.referenceType.JdbcReference

public class JdbcReference
extends GenericReference

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

Since:

1.1.0

Field Summary

Fields

Modifier and Type	Field and Description
FileReference	credFileReference

Constructor Summary

Constructors

Constructor and Description
JdbcReference()
JdbcReference(java.lang.Integer driverId, java.lang.String jdbcUrl, FileReference creds) Construct a reference to the JDBC connection information

Method Summary

Modifier and Type	Method and Description
void	checkValid() Check whether the reference is syntactically valid.
FileReference	getCredFileReference()
java.lang.Integer	getJdbcDriverId()
java.lang.String	getValue() Getter
void	setJdbcDriverId(java.lang.Integer driverId)

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

credFileReference

public FileReference credFileReference

Constructor Detail

JdbcReference

public JdbcReference()

JdbcReference

public JdbcReference(java.lang.Integer driverId,
                     java.lang.String jdbcUrl,
                     FileReference creds)

Construct a reference to the JDBC connection information

Parameters:

driverId - The ID of the extended driver uploaded via jdbcDriver API endpoint.

jdbcUrl - The JDBC URL of the database server

creds - A FileReference object to a file that contains credentials in JSON format. It should have the schema {"username": "USERNAME", "password": "PASSWORD"}

Method Detail

getValue

@JsonPropertyDescription(value="Jdbc URL of the database server")
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.

getJdbcDriverId

@JsonPropertyDescription(value="ID of the extended jdbc driver")
public java.lang.Integer getJdbcDriverId()

getCredFileReference

@JsonPropertyDescription(value="The reference to the file storing the credentials in the form username")
public FileReference getCredFileReference()

setJdbcDriverId

public void setJdbcDriverId(java.lang.Integer driverId)

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.