com.tplan.robot.plugin

Class PluginInfo

java.lang.Object

com.tplan.robot.plugin.PluginInfo

All Implemented Interfaces:

Plugin, Comparable<PluginInfo>

public class PluginInfo
extends Object
implements Plugin, Comparable<PluginInfo>

Wrapper around Plugin attributes which is often used instead of real plugins to avoid unnecessary plugin instantiation. It also defines a few extra methods which deliver some functionality of the plugin framework.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_EXTERNAL External plugin type.
static int	TYPE_INTERNAL Internal plugin type.

Method Summary

Modifier and Type	Method and Description
void	checkDependencies(PluginManager manager) Check whether the current product installation contains all dependencies (other plugins) required to install this plugin.
int	compareTo(PluginInfo o) Returns 1 if version of this plugin is higher, -1 if lower and 0 if the versions are equal.
boolean	equals(Object o)
static PluginInfo	fromDescriptor(PluginDescriptor desc)
String	getCode() Get plugin code.
Date	getDate() Get plugin release date.
String	getDescription() Get plugin description to be displayed in the GUI.
PluginDescriptor	getDescriptor()
String	getDisplayName() Get short plugin name to be displayed in the GUI.
String	getGroupName()
Class	getImplementedInterface() Get Class of the exposed functional interface that this plugin implements.
String	getLibraryUrl()
int[]	getLowestSupportedVersion() Get the lowest required version of T-Plan Robot Enterprise.
String	getMessageAfterInstall() Get text of a message to be displayed after installation of this plugin.
String	getMessageBeforeInstall() Get text of a message to be displayed before installation of this plugin.
Class	getPluginClass()
Plugin	getPluginInstance()
String	getSupportContact() Get support contact.
int	getType() Get the plugin type, either TYPE_INTERNAL or TYPE_EXTERNAL.
String	getUniqueId() Get unique ID associated with the plugin.
String	getVendorHomePage() Get the vendor home page.
String	getVendorName() Get vendor (provider) name to be displayed in the GUI.
int[]	getVersion() Get plugin version in form of an integer array.
String	getVersionString()
static String	getVersionString(int[] version)
boolean	isBuiltIn()
boolean	isConfigurable()
boolean	isEnabled()
boolean	isRestartRequired()
boolean	isSupported()
boolean	requiresRestart() Indicate whether installation of this plugin requires application restart.
void	setDescriptor(PluginDescriptor descriptor)
void	setType(int type) Set the plugin type, either TYPE_INTERNAL or TYPE_EXTERNAL.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_INTERNAL

public static final int TYPE_INTERNAL

Internal plugin type. It is the old style plugin consisting typically of a JAR file which gets loaded and searched for plugin classes on the startup. The plugin meta data such as the unique ID (code), name, description etc. are being loaded from the plugin class.

Since:

7.0

See Also:

Constant Field Values

TYPE_EXTERNAL

public static final int TYPE_EXTERNAL

External plugin type. It was introduced in release 7. It is a ZIP file which gets extracted to the Robot install folder. The plugin always contains the JSON descriptor as plugins/[uniqueId].json which provides the metadata.

Since:

7.0

See Also:

Constant Field Values

Method Detail

fromDescriptor

public static PluginInfo fromDescriptor(PluginDescriptor desc)

getPluginClass

public Class getPluginClass()

Returns:

the pluginClass

isEnabled

public boolean isEnabled()

Returns:

the enabled

getGroupName

public String getGroupName()

Returns:

the groupName

isBuiltIn

public boolean isBuiltIn()

Returns:

the builtIn

compareTo

public int compareTo(PluginInfo o)

Returns 1 if version of this plugin is higher, -1 if lower and 0 if the versions are equal.

Specified by:

compareTo in interface Comparable<PluginInfo>

Parameters:

o - another plugin info instance to compare to

isSupported

public boolean isSupported()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getLibraryUrl

public String getLibraryUrl()

Returns:

the libraryUrl

getPluginInstance

public Plugin getPluginInstance()
                         throws ClassNotFoundException,
                                InstantiationException,
                                IllegalAccessException,
                                NoSuchMethodException,
                                IllegalArgumentException,
                                InvocationTargetException

Throws:

ClassNotFoundException

InstantiationException

IllegalAccessException

NoSuchMethodException

IllegalArgumentException

InvocationTargetException

getImplementedInterface

public Class getImplementedInterface()

Description copied from interface: Plugin

Get Class of the exposed functional interface that this plugin implements. For example remote desktop clients return com.tplan.robot.remoteclient.RemoteDesktopClient.class.

Specified by:

getImplementedInterface in interface Plugin

Returns:

the implementedInterface

getCode

public String getCode()

Description copied from interface: Plugin

Get plugin code. This string serves as an identifier of the functionality delivered by the plugin. For example, desktop client plugins return protocol name like "RFB" or "RDP" as their code.

Plugin code is used by pluggable instance factories to identify a particular plugin. It may be used to replace internal plugins with third party code. For example if you develop a class which implements this and the com.tplan.robot.remoteclient.RemoteDesktop interfaces and the getCode() method returns "RFB", it will replace the internal implementation of the RFB (VNC) client.

Specified by:

getCode in interface Plugin

Returns:

the name

getDisplayName

public String getDisplayName()

Description copied from interface: Plugin

Get short plugin name to be displayed in the GUI.

Specified by:

getDisplayName in interface Plugin

Returns:

the displayName

getVendorName

public String getVendorName()

Description copied from interface: Plugin

Get vendor (provider) name to be displayed in the GUI.

Specified by:

getVendorName in interface Plugin

Returns:

the vendorName

getVendorHomePage

public String getVendorHomePage()

Description copied from interface: Plugin

Get the vendor home page. If the contact is a valid HTTP link like "http://<link>", the application may follow it with appropriate program (typically web browser).

Specified by:

getVendorHomePage in interface Plugin

Returns:

the vendorHomePage

getVersion

public int[] getVersion()

Description copied from interface: Plugin

Get plugin version in form of an integer array. Major version numbers are first. For example, version 1.2.3 should be represented as new int[] { 1, 2, 3 }.

Specified by:

getVersion in interface Plugin

Returns:

the version

getSupportContact

public String getSupportContact()

Description copied from interface: Plugin

Get support contact. If the contact is a valid mail link like "mailto:<mailaddress>" or an HTTP link like "http://<link>", the application may follow it with appropriate program (mail client or web browser).

Specified by:

getSupportContact in interface Plugin

Returns:

the supportContact

getDate

public Date getDate()

Description copied from interface: Plugin

Get plugin release date.

Specified by:

getDate in interface Plugin

Returns:

the date

isRestartRequired

public boolean isRestartRequired()

Returns:

the restartRequired

getDescription

public String getDescription()

Description copied from interface: Plugin

Get plugin description to be displayed in the GUI.

Specified by:

getDescription in interface Plugin

Returns:

plugin description. May be null.

requiresRestart

public boolean requiresRestart()

Description copied from interface: Plugin

Indicate whether installation of this plugin requires application restart. If it returns true, users are asked to restart after plugin installation via GUI.

Specified by:

requiresRestart in interface Plugin

Returns:

true if installation of the plugin requires application restart, false otherwise.

getUniqueId

public String getUniqueId()

Description copied from interface: Plugin

Get unique ID associated with the plugin. The plugin manager uses the ID together with the version string to identify whether a plugin is already installed and whether a newer version of the same plugin is available.

The unique ID in fact identifies a particular plugin delivered by a particular vendor. Plugin developers are recommended to choose an ID and keep it constant for all versions of one particular plugin. The ID is never displayed in the GUI so it doesn't have to be a readable text. To avoid conflicts with other vendors it is recommended to elaborate vendor or author name and feature description into the ID, for example "custom RFB client implemented by John Doe".

Specified by:

getUniqueId in interface Plugin

Returns:

unique plugin ID.

getLowestSupportedVersion

public int[] getLowestSupportedVersion()

Description copied from interface: Plugin

Get the lowest required version of T-Plan Robot Enterprise. If user attempts to install the plugin on a lower version, an error is reported.

Specified by:

getLowestSupportedVersion in interface Plugin

Returns:

the lowest T-Plan Robot Enterprise version supported by this plugin.

getMessageBeforeInstall

public String getMessageBeforeInstall()

Description copied from interface: Plugin

Get text of a message to be displayed before installation of this plugin. It may contain any relevant user information.

Specified by:

getMessageBeforeInstall in interface Plugin

Returns:

message to be displayed before installation.

getMessageAfterInstall

public String getMessageAfterInstall()

Description copied from interface: Plugin

Get text of a message to be displayed after installation of this plugin. It may contain any relevant user information.

Specified by:

getMessageAfterInstall in interface Plugin

Returns:

message to be displayed after installation.

getVersionString

public String getVersionString()

getVersionString

public static String getVersionString(int[] version)

isConfigurable

public boolean isConfigurable()

Returns:

the configurable

checkDependencies

public void checkDependencies(PluginManager manager)
                       throws DependencyMissingException

Description copied from interface: Plugin

Check whether the current product installation contains all dependencies (other plugins) required to install this plugin. This method is called before the plugin is installed and it should throw a DependencyMissingException if one or more dependencies are missing.

Specified by:

checkDependencies in interface Plugin

Parameters:

manager - shared instance of the plugin manager.

Throws:

DependencyMissingException - when one or more dependencies requested by this plugin is missing.

getType

public int getType()

Get the plugin type, either TYPE_INTERNAL or TYPE_EXTERNAL.

Returns:

the plugin type.

Since:

7.0

setType

public void setType(int type)

Set the plugin type, either TYPE_INTERNAL or TYPE_EXTERNAL.

Parameters:

type - the plugin type constant.

Since:

7.0

getDescriptor

public PluginDescriptor getDescriptor()

Returns:

the descriptor

setDescriptor

public void setDescriptor(PluginDescriptor descriptor)

Parameters:

descriptor - the descriptor to set