com.delphix.masking.api.plugin.utils

Class ComponentCache

java.lang.Object

com.delphix.masking.api.plugin.utils.ComponentCache

All Implemented Interfaces:

ComponentWrapper.ComponentServiceBackend

public class ComponentCache
extends java.lang.Object
implements ComponentWrapper.ComponentServiceBackend

This class orchestrates component loading and caching of component objects. It also can scan all loaded plugins to discover all available frameworks and instances. In all cases, each plugin is visited only once -- to scan the same plugin again (perhaps because the JAR contents have changed), create another object of this class.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LOG_RATE

Constructor Summary

Constructors

Constructor and Description
ComponentCache()
ComponentCache(ComponentWrapper.ComponentServiceBackend backend, MaskingLogService.MaskingLogServiceConfig maskingLogServiceConfigIn)

Method Summary

Modifier and Type	Method and Description
void	cleanup() Clean up all component instances know to the cache.
ComponentWrapper	createComponentInstance(java.lang.String instanceName) This method creates an instance of an algorithm known to the cache.
ComponentWrapper	createComponentInstance(java.lang.String instanceName, boolean isTracked) This method creates an instance of an algorithm known to the cache.
MaskingComponent	createRawComponentInstance(java.lang.String pluginName, java.lang.String pluginJarPath, java.lang.String className, boolean builtIn) Create an anonymous component instance of the specified class without configuring or calling setup.
java.util.Set<MaskingComponent>	discoverFrameworks(java.lang.String pluginName) Discover all algorithm framework classes provided by a plugin.
java.util.Map<java.lang.String,ComponentWrapper.ComponentInstanceDetails>	discoverInstanceDetails(java.lang.String pluginName) Discover all algorithm component instances provided by a plugin.
ComponentWrapper.ComponentInstanceDetails	getAlgorithmComponentDetail(java.lang.String algorithmCd)
byte[]	getAlgorithmKey(java.lang.String algorithmCd)
java.util.List<java.lang.String>	getInstanceNames() Returns a list of component instance names.
java.util.List<java.lang.String>	getInstanceNames(java.lang.String frameworkName) Returns list of algorithm instances for given algorithm framework.
PluginLoader	getOrCreatePluginLoader(java.lang.String pluginName, java.lang.String pluginPath, boolean isBuiltIn) Create a new plugin loader and add it to the component cache.
boolean	knowsComponentInstance(java.lang.String instanceName) Check whether a particular component instance name is known to the component cache.
void	loadInstances(java.lang.String pluginName, java.lang.String algoInstanceFile) Read a file containing a set of algorithm instance descriptions and add each instance's configuration to the internal cache of instance configurations,
void	newInstance(java.lang.String instanceName, ComponentWrapper.ComponentInstanceDetails details, boolean update) Add the configuration for a component instance to the cache.
java.io.InputStream	openFile(java.lang.String instanceName, java.lang.String fileURI)
void	setRandomKey(boolean randomKey) Controls how the internal backend provider generates keys for algorithms.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOG_RATE

public static final int DEFAULT_LOG_RATE

See Also:

Constant Field Values

Constructor Detail

ComponentCache

public ComponentCache()

ComponentCache

public ComponentCache(ComponentWrapper.ComponentServiceBackend backend,
                      MaskingLogService.MaskingLogServiceConfig maskingLogServiceConfigIn)

Method Detail

getOrCreatePluginLoader

public PluginLoader getOrCreatePluginLoader(java.lang.String pluginName,
                                            java.lang.String pluginPath,
                                            boolean isBuiltIn)

Create a new plugin loader and add it to the component cache. If a loader already exists for this plugin, it is reused.

Parameters:

pluginName - The name of the plugin

pluginPath - The path to the plugin's JAR

isBuiltIn - Whether the plugin is builtin

Returns:

The new or existing plugin loader

newInstance

public void newInstance(java.lang.String instanceName,
                        ComponentWrapper.ComponentInstanceDetails details,
                        boolean update)

Add the configuration for a component instance to the cache.

Parameters:

instanceName - The name of the component instance. This must be unique.

details - The values specifying the type and configuration of the new instance.

update - Whether this operation should update an existing component instance if one exists.

getInstanceNames

public java.util.List<java.lang.String> getInstanceNames()

Returns a list of component instance names.

Returns:

The list of names.

getInstanceNames

public java.util.List<java.lang.String> getInstanceNames(java.lang.String frameworkName)

Returns list of algorithm instances for given algorithm framework.

Parameters:

frameworkName - The name of the algorithm.

Returns:

List of instance names for the given class.

createComponentInstance

public ComponentWrapper createComponentInstance(java.lang.String instanceName)

This method creates an instance of an algorithm known to the cache.

Parameters:

instanceName - The name of the algorithm instance to create or return.

Returns:

The wrapped masking component

createComponentInstance

public ComponentWrapper createComponentInstance(java.lang.String instanceName,
                                                boolean isTracked)

This method creates an instance of an algorithm known to the cache.

Parameters:

instanceName - The name of the algorithm instance to create or return.

isTracked - Whether the cache should track the component for cleanup

Returns:

The wrapped masking component

createRawComponentInstance

public MaskingComponent createRawComponentInstance(java.lang.String pluginName,
                                                   java.lang.String pluginJarPath,
                                                   java.lang.String className,
                                                   boolean builtIn)

Create an anonymous component instance of the specified class without configuring or calling setup. The details of this instance are not added to the internal cache or dependency graph.

Parameters:

pluginName - The name of the plugin that provides the framework class.

pluginJarPath - The path to the plugin JAR file.

className - The framework class of the component to create. The returned object will be of this class.

builtIn - Whether the referenced plugin should be considered built-in.

Returns:

The raw component instance.

cleanup

public void cleanup()

Clean up all component instances know to the cache.

discoverFrameworks

public java.util.Set<MaskingComponent> discoverFrameworks(java.lang.String pluginName)

Discover all algorithm framework classes provided by a plugin.

Parameters:

pluginName - The name of the plugin.

Returns:

A set of objects for each class that is a component framework and implements the MaskingAlgorithm class.

discoverInstanceDetails

public java.util.Map<java.lang.String,ComponentWrapper.ComponentInstanceDetails> discoverInstanceDetails(java.lang.String pluginName)

Discover all algorithm component instances provided by a plugin.

Parameters:

pluginName - The name of the plugin from which the instances are to be constructed.

Returns:

A map of instance names to detailed component configuration objects.

loadInstances

public void loadInstances(java.lang.String pluginName,
                          java.lang.String algoInstanceFile)
                   throws java.io.IOException

Read a file containing a set of algorithm instance descriptions and add each instance's configuration to the internal cache of instance configurations,

Parameters:

pluginName - The name of the plugin from which the instances are to be constructed.

algoInstanceFile - The file containing algorithm instance descriptions.

Throws:

java.io.IOException - When problems occur reading the instance file.

setRandomKey

public void setRandomKey(boolean randomKey)

Controls how the internal backend provider generates keys for algorithms. If true, a new key is computed randomly each time an algorithm instance is created. If false, each algorithm key is derived by hashing the algorithm's instance name, and will remain consistent so long as the algorithm has the same name.

Parameters:

randomKey - Whether algorithms keys are generated randomly.

knowsComponentInstance

public boolean knowsComponentInstance(java.lang.String instanceName)

Check whether a particular component instance name is known to the component cache.

Parameters:

instanceName - The name of to check

Returns:

Whether the cache has a component instance of the provided name

getAlgorithmComponentDetail

public ComponentWrapper.ComponentInstanceDetails getAlgorithmComponentDetail(java.lang.String algorithmCd)

Specified by:

getAlgorithmComponentDetail in interface ComponentWrapper.ComponentServiceBackend

openFile

public java.io.InputStream openFile(java.lang.String instanceName,
                                    java.lang.String fileURI)

Specified by:

openFile in interface ComponentWrapper.ComponentServiceBackend

getAlgorithmKey

public byte[] getAlgorithmKey(java.lang.String algorithmCd)

Specified by:

getAlgorithmKey in interface ComponentWrapper.ComponentServiceBackend