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.
<U> MaskingAlgorithm<U>	getAlgorithmByName(AlgorithmInstanceReference algorithmReference, MaskingAlgorithm.MaskingType type) 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.
LogService	getLogService() Get a Logger object that can be used to log messages.
java.lang.String	getPluginName()
MaskingComponent	getUnreadyComponent() Get the component without calling setup.
java.io.InputStream	openInputFile(FileReference fileRef) Method to open a file resource by URI.
void	setLogService(MaskingLogService logService)
MaskingComponent	setupComponentIfNeeded() Set up the wrapped component only if needed.
void	validate()

Methods inherited from class java.lang.Object

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

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

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)

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.

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

Returns:

A masking algorithm 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

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.

Specified by:

getLogService in interface ComponentService

Returns:

The MaskingLogService object.

getPluginName

public java.lang.String getPluginName()

setLogService

public void setLogService(MaskingLogService logService)