com.delphix.masking.api.provider

Interface ComponentService

All Known Implementing Classes:

ComponentWrapper

public interface ComponentService

This is the interface provided to masking components at setup time through which the component may acquire references to other objects and services.
Several methods in this interface consume resource references derived from the GenericReference class. These references must be publicly visible properties of the MaskingComponent object using this service provider, or methods consuming them will fail with InvalidDependencyException. This requirement exists in order to allow the masking engine to discover the dependencies of any MaskingComponent via reflection.

Method Summary

Modifier and Type	Method and Description
<U> MaskingAlgorithm<U>	getAlgorithmByName(AlgorithmInstanceReference reference, MaskingAlgorithm.MaskingType type) 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.
LogService	getLogService() Get a Logger object that can be used to log messages.
java.io.InputStream	openInputFile(FileReference fileReference) Method to open a file resource by URI.

Method Detail

getInstanceName

java.lang.String getInstanceName()

Get the name of this component instance.

Returns:

The component instance name.

openInputFile

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

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.

Parameters:

fileReference - A reference to the file to be opened.

Returns:

An InputStream for the desired file

getAlgorithmByName

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

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.

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

getCryptoService

CryptoService getCryptoService(KeyReference reference)

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.

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.

getLogService

LogService getLogService()

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.

Returns:

The MaskingLogService object.