com.delphix.masking.api.plugin.utils

Class ComponentWrapper

java.lang.Object

com.delphix.masking.api.plugin.utils.ComponentWrapper

All Implemented Interfaces:

ComponentService

public class ComponentWrapper
extends java.lang.Object
implements ComponentService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComponentWrapper.ComponentInstanceDetails
static interface	ComponentWrapper.ComponentServiceBackend

Constructor Summary

Constructors

Constructor and Description
ComponentWrapper(java.lang.String pluginNameIn, java.lang.String instanceNameIn, ComponentCache componentCacheIn, MaskingComponent componentIn, MaskingLogService.MaskingLogServiceConfig maskingLogServiceConfig) Create a wrapper for a top level component

Method Summary

Modifier and Type	Method and Description
void	checkComponentDependencies(boolean isExternalAllowed) Recursively check all component dependencies referenced directly or indirectly by the wrapped component.
void	cleanupComponent() Initiate cleanup on this component and any closeables opened by this wrapper for the component.
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 algorithmReference, MaskingAlgorithm.MaskingType type, MaskValueMetadata metadata) Get a MaskingAlgorithm object for the algorithm specified by the reference and type.
CryptoService	getCryptoService(KeyReference reference) This implements the ComponentService method that provides access to the algorithm's key wrapped by the CryptoServiceImpl, which implements a number of cryptographic functions using that key.
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 algorithmReference) The method getAlgorithmByNamePrivileged above expects a type, then creates an instance of the algorithm and checks that type against it.
MaskValueMetadata	getMaskValueMetadata() Retrieve the metadata access interface for the masked field.
java.lang.String	getPluginName()
java.sql.Connection	getTargetConnection() Get a Connection object, through which a DriverSupport Task will execute prepared statements on the target database.
MaskingComponent	getUnreadyComponent() Get the component without calling setup.
java.io.InputStream	openInputFile(FileReference fileRef) 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.
void	setLogService(MaskingLogService logService)
void	setMaskingMode(MaskingAlgorithm.MaskingMode mode) Set the mode of operation for the wrapped algorithm.
MaskingComponent	setupComponentIfNeeded() Set up the wrapped component only if needed.
void	setValueMetadata(MaskValueMetadataImpl valueMetadata)
void	validate()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.delphix.masking.api.provider.ComponentService

getAlgorithmByName, getSingleOperationTaskInfo

Constructor Detail

ComponentWrapper

public ComponentWrapper(java.lang.String pluginNameIn,
                        java.lang.String instanceNameIn,
                        ComponentCache componentCacheIn,
                        MaskingComponent componentIn,
                        MaskingLogService.MaskingLogServiceConfig maskingLogServiceConfig)

Create a wrapper for a top level component

Parameters:

pluginNameIn - The name of the plugin

instanceNameIn - The name of the component instance

componentCacheIn - The component caching loader

componentIn - The component being wrapped

maskingLogServiceConfig - A MaskingLogService.MaskingLogServiceConfig object for The configuration of the logger.

Method Detail

setupComponentIfNeeded

public MaskingComponent setupComponentIfNeeded()

Set up the wrapped component only if needed. To ensure the component is always ready before use, use this method to get a reference to the wrapped component.

Returns:

The component managed by this wrapper

getUnreadyComponent

public MaskingComponent getUnreadyComponent()

Get the component without calling setup. Useful for getting information about a component without doing the work to fully initialize it.

Returns:

The potentially not-yet initialized component managed by this wrapper

cleanupComponent

public void cleanupComponent()

Initiate cleanup on this component and any closeables opened by this wrapper for the component.

validate

public void validate()
              throws ComponentConfigurationException

Throws:

ComponentConfigurationException

getInstanceName

public java.lang.String getInstanceName()

Get the name of this component instance. For algorithms, this corresponds to algorithmName in the Masking API and algorithmCd.

Specified by:

getInstanceName in interface ComponentService

Returns:

The name of the instance

checkComponentDependencies

public void checkComponentDependencies(boolean isExternalAllowed)

Recursively check all component dependencies referenced directly or indirectly by the wrapped component. Verify that all dependencies exist and that the dependency graph is free of cycles. Dependencies on resources not defined as MaskingComponents in this API are not checked.

Parameters:

isExternalAllowed - Whether dependencies may exist outside of the plugin that provided the component

Throws:

InvalidDependencyException - When a dependency is invalid or would result in a dependency loop

MissingDependencyException - When a dependency is missing

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.

openInputFile

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

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:

fileRef - A reference to the file to be opened.

Returns:

An InputStream for the desired file

getAlgorithmByName

public <U> MaskingAlgorithm<U> getAlgorithmByName(@Nonnull
                                                  AlgorithmInstanceReference algorithmReference,
                                                  @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:

algorithmReference - 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

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

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

getCryptoService

public CryptoService getCryptoService(KeyReference reference)

This implements the ComponentService method that provides access to the algorithm's key wrapped by the CryptoServiceImpl, which implements a number of cryptographic functions using that key.

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 service object wrapping the algorithm's key

createJaninoExpressionEvaluator

public org.codehaus.janino.ExpressionEvaluator createJaninoExpressionEvaluator()

Creates a Janino expression evaluator.

Specified by:

createJaninoExpressionEvaluator in interface ComponentService

Returns:

A new Janino expression evaluator

getMaskingTypeForInstanceReference

public MaskingAlgorithm.MaskingType getMaskingTypeForInstanceReference(@Nonnull
                                                                       AlgorithmInstanceReference algorithmReference)

The method getAlgorithmByNamePrivileged above expects a type, then creates an instance of the algorithm and checks that type against it. In a chaining algorithm we don't always know what the type should be, and this leads to nested exception handling. This method allows us to bypass that argument and just get the algorithm using what it already knows about it's type.

Specified by:

getMaskingTypeForInstanceReference in interface ComponentService

Parameters:

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

Returns:

The masking type of the algorithm instance.

cookJaninoExpression

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

"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

setMaskingMode

public void setMaskingMode(MaskingAlgorithm.MaskingMode mode)

Set the mode of operation for the wrapped algorithm. This must be done before the algorithm's setup method has been called.

Parameters:

mode - The mode of operation in which the algorithm should operate.

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.

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.

setValueMetadata

public void setValueMetadata(MaskValueMetadataImpl valueMetadata)

getPluginName

public java.lang.String getPluginName()

setLogService

public void setLogService(MaskingLogService logService)