com.delphix.masking.api.plugin.utils

Class DriverComponentService

java.lang.Object

com.delphix.masking.api.plugin.utils.DriverComponentService

All Implemented Interfaces:

ComponentService

public class DriverComponentService
extends java.lang.Object
implements ComponentService

Constructor Summary

Constructors

Constructor and Description
DriverComponentService(JobInfo jobInfoIn, java.sql.Connection connection, java.lang.String instanceName)
DriverComponentService(JobInfo jobInfoIn, java.sql.Connection connection, java.lang.String instanceNameIn, MaskingLogService.MaskingLogServiceConfig maskingLogServiceConfig)
DriverComponentService(SingleOperationTaskInfo taskInfo)
DriverComponentService(SingleOperationTaskInfo taskInfo, java.sql.Connection connection, java.lang.String instanceName)
DriverComponentService(SingleOperationTaskInfo taskInfo, java.sql.Connection connection, java.lang.String instanceNameIn, MaskingLogService.MaskingLogServiceConfig maskingLogServiceConfig)
DriverComponentService(SingleOperationTaskInfo taskInfo, MaskingLogService.MaskingLogServiceConfig maskingLogServiceConfig)

Method Summary

Modifier and Type	Method and Description
void	cookJaninoExpression(org.codehaus.janino.ExpressionEvaluator evaluator, java.lang.String expression) "Cooks" (reads, scans, parses, and compiles) a one-line Java expression with the given Janino expression evaluator.
org.codehaus.janino.ExpressionEvaluator	createJaninoExpressionEvaluator() Creates a Janino expression evaluator.
<U> MaskingAlgorithm<U>	getAlgorithmByName(AlgorithmInstanceReference reference, MaskingAlgorithm.MaskingType type) Get a MaskingAlgorithm object for the algorithm specified by the reference and type.
<U> MaskingAlgorithm<U>	getAlgorithmByName(AlgorithmInstanceReference reference, MaskingAlgorithm.MaskingType type, MaskValueMetadata metadata) Get a MaskingAlgorithm object for the algorithm specified by the reference and type.
CryptoService	getCryptoService(KeyReference reference) Get a cryptographic service provider that wraps the key assigned to this component.
java.lang.String	getInstanceName() Get the name of this component instance.
JobInfo	getJobInfo() Get a JobInfo object, which contains references to the schema, table names, and column names in a masking rule set.
LogService	getLogService() Get a Logger object that can be used to log messages.
MaskingAlgorithm.MaskingType	getMaskingTypeForInstanceReference(AlgorithmInstanceReference reference) Useful for confirming masking type on algorithms from JSON configuration of chaining algorithms.
MaskValueMetadata	getMaskValueMetadata() Retrieve the metadata access interface for the masked field.
SingleOperationTaskInfo	getSingleOperationTaskInfo() Returns a SingleOperationTaskInfo object for SingleOperationTask where SingleOperationTaskInfo is a class to provide the input values/information table wise for specific SingleOperationTask.
java.sql.Connection	getTargetConnection() Get a Connection object, through which a DriverSupport Task will execute prepared statements on the target database.
java.io.InputStream	openInputFile(FileReference fileReference) Method to open a file resource by URI.
java.sql.Connection	openJdbcConnection(JdbcReference jdbcReference) Method to open a JDBC resource.
java.sql.Connection	openMappingConnection(MappingSetReference mappingSetReference) Method to open a connection to mapping database.

Methods inherited from class java.lang.Object

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

Constructor Detail

DriverComponentService

public DriverComponentService(SingleOperationTaskInfo taskInfo,
                              MaskingLogService.MaskingLogServiceConfig maskingLogServiceConfig)

DriverComponentService

public DriverComponentService(SingleOperationTaskInfo taskInfo,
                              java.sql.Connection connection,
                              java.lang.String instanceNameIn,
                              MaskingLogService.MaskingLogServiceConfig maskingLogServiceConfig)

DriverComponentService

public DriverComponentService(SingleOperationTaskInfo taskInfo)

DriverComponentService

public DriverComponentService(JobInfo jobInfoIn,
                              java.sql.Connection connection,
                              java.lang.String instanceNameIn,
                              MaskingLogService.MaskingLogServiceConfig maskingLogServiceConfig)

DriverComponentService

public DriverComponentService(JobInfo jobInfoIn,
                              java.sql.Connection connection,
                              java.lang.String instanceName)

DriverComponentService

public DriverComponentService(SingleOperationTaskInfo taskInfo,
                              java.sql.Connection connection,
                              java.lang.String instanceName)

Method Detail

openInputFile

public java.io.InputStream openInputFile(@Nonnull
                                         FileReference fileReference)

Description copied from interface: ComponentService

Method to open a file resource by URI. The resulting InputStream remains valid for the life of the calling MaskingAlgorithm object, but may be closed be when no longer needed to free resources.

Specified by:

openInputFile in interface ComponentService

Parameters:

fileReference - A reference to the file to be opened.

Returns:

An InputStream for the desired file

openJdbcConnection

public java.sql.Connection openJdbcConnection(@Nonnull
                                              JdbcReference jdbcReference)

Description copied from interface: ComponentService

Method to open a JDBC resource. The resulting Connection remains valid for the life of the calling MaskingAlgorithm object, but may be closed be when no longer needed to free resources.

Specified by:

openJdbcConnection in interface ComponentService

Parameters:

jdbcReference - A JdbcReference object to provide the jdbc connection information.

Returns:

A Connection object.

openMappingConnection

public java.sql.Connection openMappingConnection(@Nonnull
                                                 MappingSetReference mappingSetReference)

Description copied from interface: ComponentService

Method to open a connection to mapping database. This method is evolving and should presently only be used as needed by the mapping algorithm.

Specified by:

openMappingConnection in interface ComponentService

Parameters:

mappingSetReference - A MappingSetReference object which provides all the needed information to establish the connection.

Returns:

A Connection object.

getAlgorithmByName

public <U> MaskingAlgorithm<U> getAlgorithmByName(@Nonnull
                                                  AlgorithmInstanceReference reference,
                                                  @Nonnull
                                                  MaskingAlgorithm.MaskingType type,
                                                  @Nonnull
                                                  MaskValueMetadata metadata)

Description copied from interface: ComponentService

Get a MaskingAlgorithm object for the algorithm specified by the reference and type. It is only possible to find named instances of component algorithms using this method. The returned MaskingAlgorithm object is fully initialized and ready to mask data. The algorithm object created will be set to the same MaskingAlgorithm.MaskingMode value as the caller.

Specified by:

getAlgorithmByName in interface ComponentService

Type Parameters:

U - The data type masked by the returned algorithm, must exactly match what is requested in type

Parameters:

reference - A reference describing the algorithm instance to get

type - The masking data type the named algorithm is expected mask

metadata - The mask value metadata for the values that will be passed to the instance being created

Returns:

A masking algorithm object

getAlgorithmByName

public <U> MaskingAlgorithm<U> getAlgorithmByName(@Nonnull
                                                  AlgorithmInstanceReference reference,
                                                  @Nonnull
                                                  MaskingAlgorithm.MaskingType type)

Description copied from interface: ComponentService

Get a MaskingAlgorithm object for the algorithm specified by the reference and type. It is only possible to find named instances of component algorithms using this method. The returned MaskingAlgorithm object is fully initialized and ready to mask data. The default MaskValueMetadata values will be passed to the instance created. The algorithm object created will be set to the same MaskingAlgorithm.MaskingMode value as the caller.

Specified by:

getAlgorithmByName in interface ComponentService

Type Parameters:

U - The data type masked by the returned algorithm, must exactly match what is requested in type

Parameters:

reference - A reference describing the algorithm instance to get

type - The masking data type the named algorithm is expected mask

Returns:

A masking algorithm object

getMaskingTypeForInstanceReference

public MaskingAlgorithm.MaskingType getMaskingTypeForInstanceReference(@Nonnull
                                                                       AlgorithmInstanceReference reference)

Description copied from interface: ComponentService

Useful for confirming masking type on algorithms from JSON configuration of chaining algorithms.

Specified by:

getMaskingTypeForInstanceReference in interface ComponentService

Parameters:

reference - The reference to the algorithm instance from which to get the masking type.

Returns:

The masking type of the algorithm instance.

getCryptoService

public CryptoService getCryptoService(KeyReference reference)

Description copied from interface: ComponentService

Get a cryptographic service provider that wraps the key assigned to this component. This provider will remain valid for the life of the component object. Currently, only algorithm components may use this service.

Specified by:

getCryptoService in interface ComponentService

Parameters:

reference - A reference to the key to use. Currently, the reference value must be "", referring to the default algorithm key assigned to this algorithm.

Returns:

The cryptographic service provider object.

createJaninoExpressionEvaluator

public org.codehaus.janino.ExpressionEvaluator createJaninoExpressionEvaluator()

Description copied from interface: ComponentService

Creates a Janino expression evaluator.

Specified by:

createJaninoExpressionEvaluator in interface ComponentService

Returns:

A new Janino expression evaluator

cookJaninoExpression

public void cookJaninoExpression(org.codehaus.janino.ExpressionEvaluator evaluator,
                                 java.lang.String expression)
                          throws java.lang.Exception

Description copied from interface: ComponentService

"Cooks" (reads, scans, parses, and compiles) a one-line Java expression with the given Janino expression evaluator.

Specified by:

cookJaninoExpression in interface ComponentService

Parameters:

evaluator - The Janino expression evaluator that will cook the expression

expression - The expression to be cooked by the Janino expression evaluator

Throws:

java.lang.Exception - If the expression cannot be evaluated

getLogService

public LogService getLogService()

Description copied from interface: ComponentService

Get a Logger object that can be used to log messages. The logger has a rate limitter that can be configured in the Masking engine. The rate limitter controls the number of bytes per second. Attention! The sensitive (not masked) information should never be logged!

Specified by:

getLogService in interface ComponentService

Returns:

The MaskingLogService object.

getTargetConnection

public java.sql.Connection getTargetConnection()

Description copied from interface: ComponentService

Get a Connection object, through which a DriverSupport Task will execute prepared statements on the target database.

Specified by:

getTargetConnection in interface ComponentService

Returns:

A Connection object

getJobInfo

public JobInfo getJobInfo()

Description copied from interface: ComponentService

Get a JobInfo object, which contains references to the schema, table names, and column names in a masking rule set.

Specified by:

getJobInfo in interface ComponentService

Returns:

A masking JobInfo object

getInstanceName

public java.lang.String getInstanceName()

Description copied from interface: ComponentService

Get the name of this component instance.

Specified by:

getInstanceName in interface ComponentService

Returns:

The component instance name.

getSingleOperationTaskInfo

public SingleOperationTaskInfo getSingleOperationTaskInfo()

Description copied from interface: ComponentService

Returns a SingleOperationTaskInfo object for SingleOperationTask where SingleOperationTaskInfo is a class to provide the input values/information table wise for specific SingleOperationTask. For more details see SingleOperationTaskInfo object

Specified by:

getSingleOperationTaskInfo in interface ComponentService

Returns:

A SingleOperationTaskInfo object (null by default)

getMaskValueMetadata

public MaskValueMetadata getMaskValueMetadata()

Description copied from interface: ComponentService

Retrieve the metadata access interface for the masked field. This metadata includes values such as date format, maximum string length, etc. This method may only be invoked by single-column algorithm instances; that is, algorithms that do not consume GenericData objects. In cases where metadata is not available, this method will return null.

Specified by:

getMaskValueMetadata in interface ComponentService

Returns:

A metadata object describing the values to be masked, or null if metadata is not available.