com.delphix.masking.api.plugin

Interface MaskingComponent

All Superinterfaces:

JsonConfigurable, PluginComponent

All Known Subinterfaces:

MaskingAlgorithm<T>

public interface MaskingComponent
extends PluginComponent, JsonConfigurable

This is the interface is encompasses the notions of:

. A Json configurable plugin component

. Automatic default instance creation

. The ability to prohibit additional instances from being created

This interface is only used for masking algorithms. It allows a zero-configuration mapplet like experience when a plugin is installed. Embedded instance definitions have proven to add significant implementation complexity, so this interface should not be used for future types of extensibility.

Field Summary

Fields

Modifier and Type	Field and Description
static char	IDENTIFIER_SCOPING_SEPARATOR The separator used to create fully scoped names of components, as pluginName + separator + componentName.

Method Summary

Modifier and Type	Method and Description
default boolean	getAllowFurtherInstances() Returns true if additional instances of this component may be created beyond those enumerated by getDefaultInstances().
default java.util.Collection<MaskingComponent>	getDefaultInstances() Return a collection of objects that describe the default set of instances that should be created for this component at plugin installation time.
default void	setup(ComponentService serviceProvider) Prepare this object for use.
default void	tearDown() Relinquish any resources this algorithm has acquired during its operation.

Methods inherited from interface com.delphix.masking.api.plugin.PluginComponent

getDescription, getDocumentation, getName

Methods inherited from interface com.delphix.masking.api.plugin.JsonConfigurable

validate

Field Detail

IDENTIFIER_SCOPING_SEPARATOR

static final char IDENTIFIER_SCOPING_SEPARATOR

The separator used to create fully scoped names of components, as pluginName + separator + componentName. The values returned by component's getName methods should never contain this character.

See Also:

Constant Field Values

Method Detail

getDefaultInstances

default java.util.Collection<MaskingComponent> getDefaultInstances()

Return a collection of objects that describe the default set of instances that should be created for this component at plugin installation time. Additional instances may be created later as long as getAllowFurtherInstances() returns true.

Returns:

A collection of objects that are the instances of this component to be created.

getAllowFurtherInstances

default boolean getAllowFurtherInstances()

Returns true if additional instances of this component may be created beyond those enumerated by getDefaultInstances(). Components for which this method returns true and that implement a MaskingAlgorithm interface are treated as Algorithm Frameworks by the masking engine.

Returns:

The boolean value indicating whether additional instances may be created

setup

default void setup(@Nonnull
                   ComponentService serviceProvider)

Prepare this object for use. This includes acquiring any required external resources, such as files or other components, using the passed serviceProvider. The component object's JSON configuration is always injected before this method is called.
While the serviceProvider object is guaranteed to remain valid fof the life of this component, some methods accessed through the serviceProvider may only be invoked during setup. Please consult the documentation for the ComponentService provider interface for details.

Parameters:

serviceProvider - The service provider object

tearDown

default void tearDown()

Relinquish any resources this algorithm has acquired during its operation. Typically, this means closing all network or database connections initiated by the algorithm. It is not necessary to close any resources acquired through the ComponentService provider. This is also a convenient opportunity to log any final details about the activity of the algorithm.