com.opencloud.rhino.config.license

Interface LicenseManagementMBean

public interface LicenseManagementMBean

Allows installation, removal and query of licenses.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MBEAN_NAME The name of this MBean, equal to the string "Licensing".
static String	OBJECT_NAME The JMX Object Name of this MBean.

Method Summary

Methods

Modifier and Type	Method and Description
long	getLicensedCapacity(String function, String version) Get the licensed capacity for the specified product and function.
String[]	getLicensedFunctions() Get the currently licensed functions.
String[]	getLicensedHosts() Get the currently licensed hosts.
String[]	getLicensedVersions() Get the currently licensed versions.
ObjectName	getLicenseMBean(String serial) Get the MBean for the specified license.
TabularData	getLicenseOverview() Returns a table indicating the currently licensed capacity for each license component, along with the source of .
String[]	getLicenses() Get the currently installed licenses.
LicenseInfo[]	getLicenseSummary() Returns a summary of the current license status.
void	install(byte[] filedata) Install a license from a raw byte array
void	install(String url) Install a license from a URL
void	uninstall(String serial) Uninstalls the license with the specified serial ID.

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

The name of this MBean, equal to the string "Licensing".

See Also:

Constant Field Values

OBJECT_NAME

static final String OBJECT_NAME

The JMX Object Name of this MBean.

See Also:

Constant Field Values

Method Detail

install

void install(byte[] filedata)
             throws LicenseException,
                    LicenseAlreadyInstalledException,
                    ConfigurationException

Install a license from a raw byte array

Parameters:

filedata - a byte array containing the license data

Throws:

LicenseException

LicenseAlreadyInstalledException

ConfigurationException

install

void install(String url)
             throws LicenseException,
                    MalformedURLException,
                    LicenseAlreadyInstalledException,
                    ConfigurationException

Install a license from a URL

Parameters:

url - a String representing a URL

Throws:

LicenseException

MalformedURLException

LicenseAlreadyInstalledException

ConfigurationException

uninstall

void uninstall(String serial)
               throws UnrecognizedLicenseException,
                      ConfigurationException

Uninstalls the license with the specified serial ID.

Parameters:

serial - the serial ID of the license to be uninstalled.

Throws:

UnrecognizedLicenseException

ConfigurationException

getLicenses

String[] getLicenses()

Get the currently installed licenses.

Returns:

a String array containing the serial IDs of the installed licenses.

getLicensedFunctions

String[] getLicensedFunctions()
                              throws ConfigurationException

Get the currently licensed functions.

Returns:

a String array containing the currently licensed functions.

Throws:

ConfigurationException

getLicensedHosts

String[] getLicensedHosts()
                          throws ConfigurationException

Get the currently licensed hosts.

Returns:

a String array containing the currently licensed hosts.

Throws:

ConfigurationException

getLicensedVersions

String[] getLicensedVersions()
                             throws ConfigurationException

Get the currently licensed versions.

Returns:

a String array containing the currently licensed versions;

Throws:

ConfigurationException

getLicensedCapacity

long getLicensedCapacity(String function,
                       String version)

Get the licensed capacity for the specified product and function.

Parameters:

function - the function to query license capacity for

version - the product to query license capacity for

Returns:

the currently licensed capacity

getLicenseMBean

ObjectName getLicenseMBean(String serial)

Get the MBean for the specified license.

Parameters:

serial - the serial ID of the license to get a management interface for

Returns:

a JMX ObjectName for the management MBean

getLicenseSummary

LicenseInfo[] getLicenseSummary()
                                throws ConfigurationException

Returns a summary of the current license status.

Returns:

an array containing a summary of each license installed

Throws:

ConfigurationException

getLicenseOverview

TabularData getLicenseOverview()
                               throws ConfigurationException,
                                      ManagementException

Returns a table indicating the currently licensed capacity for each license component, along with the source of . The data returned is TabularData with the columns "function" (String), "version" (String), "capacity" (Long), "source" (String).

function	The function for which this data is relevant.
version	The version associated with the function.
capacity	The capacity this function/version is licensed for, or -1 if it is not licensed.
source	The source component that requires the license.

Throws:

ConfigurationException

ManagementException