Package net.storm.api.plugins

Class PluginMetaData

java.lang.Object

net.storm.api.plugins.PluginMetaData

public final class PluginMetaData
extends Object

Contains metadata about a plugin, including identification and version information.

PluginMetaData is attached to plugins to provide information about their source, version, and subscription status. This is particularly useful for SDN (Storm Developer Network) plugins where tracking versioning and subscriptions is important.

The metadata can be accessed through

invalid reference

Plugin#getPluginMetaData()

.

See Also:

• Plugin

Constructor Summary

Constructors

Constructor	Description
PluginMetaData(String pluginId, String pluginName, String version, Long subscriptionId, String commitHash)	Creates a new PluginMetaData instance.

Method Summary

Modifier and Type	Method	Description
Long	getId()	Gets the plugin ID as a Long value.

Methods inherited from class java.lang.Object

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

Constructor Details

PluginMetaData

public PluginMetaData(String pluginId,
 String pluginName,
 String version,
 Long subscriptionId,
 String commitHash)

Creates a new PluginMetaData instance.

Parameters:

pluginId - the unique plugin identifier

pluginName - the display name of the plugin

version - the version string

subscriptionId - the subscription ID, or null if not subscription-based

commitHash - the git commit hash of the build

Method Details

getId

public Long getId()

Gets the plugin ID as a Long value.

Note: This method will throw a NumberFormatException if the pluginId is not a valid numeric string.

Returns:

the plugin ID as a Long

Throws:

NumberFormatException - if pluginId is not numeric