com.delphix.masking.api.plugin.utils

Class PluginMetadata

java.lang.Object

com.delphix.masking.api.plugin.utils.PluginMetadata

public final class PluginMetadata
extends java.lang.Object

This class supports discovery of metadata embedded in plugin JAR files, as well as serving as the transport object fort that data.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALGORITHM_API_VERSION_KEY
static java.lang.String	AUTHOR_NAME_KEY
static java.lang.String	PLUGIN_NAME_KEY
static java.lang.String	PLUGIN_VERSION_KEY

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiVersion()
java.lang.String	getAuthorName()
java.lang.String	getPluginName()
java.lang.String	getPluginVersion()
static java.lang.String	jarPathToPluginName(java.nio.file.Path jarPath) Convert a JAR path to the default plugin name for that JAR.
static PluginMetadata	readManifest(java.nio.file.Path jarFile) Read relevant attributes from the plugin JAR's manifest.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_NAME_KEY

public static final java.lang.String PLUGIN_NAME_KEY

See Also:

Constant Field Values

AUTHOR_NAME_KEY

public static final java.lang.String AUTHOR_NAME_KEY

See Also:

Constant Field Values

PLUGIN_VERSION_KEY

public static final java.lang.String PLUGIN_VERSION_KEY

See Also:

Constant Field Values

ALGORITHM_API_VERSION_KEY

public static final java.lang.String ALGORITHM_API_VERSION_KEY

See Also:

Constant Field Values

Method Detail

readManifest

public static PluginMetadata readManifest(java.nio.file.Path jarFile)

Read relevant attributes from the plugin JAR's manifest. This method is also responsible for trimming values to the maximum allowed field lengths by the Delphix engine.

Parameters:

jarFile - The plugin JAR file

Returns:

An object containing the value of all relevant attributes

jarPathToPluginName

public static java.lang.String jarPathToPluginName(java.nio.file.Path jarPath)

Convert a JAR path to the default plugin name for that JAR. The result will always be a legal plugin name but may conflict with an existing plugin name.

Parameters:

jarPath - The JAR path

Returns:

The default plugin name based on JAR path

getPluginName

public java.lang.String getPluginName()

getAuthorName

public java.lang.String getAuthorName()

getPluginVersion

public java.lang.String getPluginVersion()

getApiVersion

public java.lang.String getApiVersion()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object