com.delphix.masking.api.plugin.utils

Class PluginLoader

java.lang.Object

com.delphix.masking.api.plugin.utils.PluginLoader

public class PluginLoader
extends java.lang.Object

This class wraps a single plugin JAR, providing access to components, as well as jar discovery functions. It also serves to ensure that the correct, per-jar child-first classloader is used in all cases.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginLoader.JarMetadata

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_SCOPE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
PluginLoader(java.lang.String jarFile, boolean builtIn) Constructs a algorithm loader object with the location of the jar files.
PluginLoader(java.net.URL jarFile, boolean builtIn) Constructs a algorithm loader object with the location of the jar files.

Method Summary

Modifier and Type	Method and Description
java.util.Set<MaskingComponent>	discoverAlgorithms() Discovers the MaskingAlgorithm classes in the jar file location.
MaskingComponent	instantiateComponent(java.lang.String className)
boolean	isBuiltIn()

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_SCOPE_SEPARATOR

public static final java.lang.String COMPONENT_SCOPE_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

PluginLoader

public PluginLoader(java.lang.String jarFile,
                    boolean builtIn)
             throws java.io.IOException

Constructs a algorithm loader object with the location of the jar files.

Parameters:

jarFile - String file name of the JAR file, or directory containing exactly one JAR file.

builtIn - Whether the plugin is buildIn, granting it extra privileges

Throws:

java.io.IOException - Throws exception if there is any error in reading the jar file.

PluginLoader

public PluginLoader(java.net.URL jarFile,
                    boolean builtIn)
             throws java.io.IOException

Constructs a algorithm loader object with the location of the jar files.

Parameters:

jarFile - URL of the jar file.

builtIn - Whether the plugin is buildIn, granting it extra privileges

Throws:

java.io.IOException - Throws exception if there is any error in reading the jar file.

Method Detail

instantiateComponent

public MaskingComponent instantiateComponent(java.lang.String className)
                                      throws java.lang.ClassNotFoundException,
                                             java.lang.IllegalAccessException,
                                             java.lang.InstantiationException

Throws:

java.lang.ClassNotFoundException

java.lang.IllegalAccessException

java.lang.InstantiationException

discoverAlgorithms

public java.util.Set<MaskingComponent> discoverAlgorithms()

Discovers the MaskingAlgorithm classes in the jar file location. The jar file location is scanned for all the jar files and classes stored in those jar file are tested for masking algorithm classes. A list of these algorithm classes are returned.

Returns:

Returns the list of objects of discovered Algorithm classes.

Throws:

DuplicateComponentNameException - if two algorithms in the jar have same name.

isBuiltIn

public boolean isBuiltIn()