com.tplan.robot.scripting.report

Class DefaultReportProvider

java.lang.Object

com.tplan.robot.scripting.report.DefaultReportProvider

All Implemented Interfaces:

LocalizedPlugin, Plugin, Configurable, ConfigurationChangeListener, CommandListener, ReportProvider, ScriptListener, ActionListener, EventListener

public class DefaultReportProvider
extends Object
implements ActionListener, ConfigurationChangeListener, Configurable, ScriptListener, CommandListener, Plugin, LocalizedPlugin, ReportProvider

Default report provider generates an HTML report from script execution. It is compatible with the functionality provided by previous product versions.

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

Constructor Summary

Constructors

Constructor and Description
DefaultReportProvider()

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) Implementation of the ActionListener interface.
void	checkDependencies(PluginManager manager) Check whether all dependencies are installed.
void	commandEvent(CommandEvent e) This method is called when a command handler fires an event.
void	configurationChanged(ConfigurationChangeEvent evt) This method gets called when a configuration parameter is changed.
int	create(ScriptingContext repository, Map params) Create a report using the scripting context.
String	getCode() Get plugin code.
Date	getDate() Get plugin release date.
String	getDescription() Get plugin description to be displayed in the GUI.
String	getDisplayName() Get short plugin name to be displayed in the GUI.
String	getDisplayNameKey() Get the key to the plugin name in the resource bundle.
Class	getImplementedInterface() Get Class of the exposed functional interface that this plugin implements.
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.
List<Preference>	getPreferences() Get metadata of displayable/editable configurable parameters.
String	getSupportContact() Get support contact.
String[]	getSupportedFormats() Get formats supported by this particular provider.
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.
boolean	requiresRestart() Indicate whether installation of this plugin requires application restart.
void	scriptEvent(ScriptEvent event) Gets called when a script event is available.
void	setConfiguration(UserConfiguration cfg) If an object implementing this interface is a plugin (i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultReportProvider

public DefaultReportProvider()

Method Detail

create

public int create(ScriptingContext repository,
                  Map params)

Description copied from interface: ReportProvider

Create a report using the scripting context. This method is called just once right after an instance of this provider is created through the Report command or it's associated Java test script method. It is up to the implementing class whether it prefers to generate one-time report and finish or register as ScriptListener and/or CommandListener and stay alive refreshing the report with updates until the script execution finishes.

The context provides access to all necessary objects associated with the script and execution. Objects created by commands such as screen shots, step results etc. may be obtained from ScriptingContext.getOutputObjects().

Specified by:

create in interface ReportProvider

Parameters:

repository - scripting context of the currently executed script.

params - Report command parameters parsed from the command. They typically contain at least the output file name together with an optional description and scope. See the Report command specification for more information.

Returns:

exit code to be returned by the Report command - 0 means success, other value means failure.

commandEvent

public void commandEvent(CommandEvent e)

Description copied from interface: CommandListener

This method is called when a command handler fires an event.

Specified by:

commandEvent in interface CommandListener

Parameters:

e - a command event.

scriptEvent

public void scriptEvent(ScriptEvent event)

Description copied from interface: ScriptListener

Gets called when a script event is available.

Specified by:

scriptEvent in interface ScriptListener

Parameters:

event - a script event.

actionPerformed

public void actionPerformed(ActionEvent e)

Implementation of the ActionListener interface.

This method is at present used just by the state update timer which invokes this method at regular intervals. The method then creates a screenshot of the RFB buffer and saves it into a so called state image. A link to this image is then elaborated into the report as a view of the current state.

This class uses its own instance of the ScreenshotCommand class because we don't want the default ScreenshotCommand class to fire all the listeners which would make the report command to re-create the HTML report and even include the state image into the report body.

Specified by:

actionPerformed in interface ActionListener

Parameters:

e - an action event.

configurationChanged

public void configurationChanged(ConfigurationChangeEvent evt)

Description copied from interface: ConfigurationChangeListener

This method gets called when a configuration parameter is changed.

Specified by:

configurationChanged in interface ConfigurationChangeListener

Parameters:

evt - A ConfigurationChangeEvent object describing the event source and the parameter that has changed.

setConfiguration

public void setConfiguration(UserConfiguration cfg)

Description copied from interface: Configurable

If an object implementing this interface is a plugin (i.e. implements also the Plugin interface) and is instantiated through a supported plugin factory, the Plugin Manager calls this method right after an instance of this object is created.

Custom objects which do not already have their configuration parameters in the default configuration file should take advantage of this method to store their configuration into the shared User Configuration instance. It is recommended to call the UserConfiguration.saveConfiguration() method in the end to save the configuration to the hard drive.

Objects wishing to be notified of changes of configuration parameters should implement the ConfigurationChangeListener interface and register with the UserConfiguration instance through the addConfigurationChangeListener() method.

Specified by:

setConfiguration in interface Configurable

Parameters:

cfg - global shared instance of user configuration preloaded with parameters from the default and user configuration files.

getPreferences

public List<Preference> getPreferences()

Description copied from interface: Configurable

Get metadata of displayable/editable configurable parameters. This method should declare a list of metadata for all configurable parameters which may be editable in the GUI. If the returned list is not null and contains at least one parameter, it gets picked up by the Preferences dialog which creates a panel with GUI components allowing to edit the declared configuration parameters.

Specified by:

getPreferences in interface Configurable

Returns:

a list of metadata for all public editable configuration parameters.

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

Specified by:

getCode in interface ReportProvider

Returns:

plugin code (identifier). The name must not be null.

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:

short plugin name.

getDisplayNameKey

public String getDisplayNameKey()

Description copied from interface: LocalizedPlugin

Get the key to the plugin name in the resource bundle.

Specified by:

getDisplayNameKey in interface LocalizedPlugin

Returns:

the plugin name key.

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.

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.

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:

vendor name. May be null.

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:

support contact. May be null or a text to be displayed by the GUI or a valid URI.

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:

version number.

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:

class instance of the implemented functional interface.

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.

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:

vendor home page URL.

getDate

public Date getDate()

Description copied from interface: Plugin

Get plugin release date.

Specified by:

getDate in interface Plugin

Returns:

plugin release date.

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.

checkDependencies

public void checkDependencies(PluginManager manager)
                       throws DependencyMissingException

Check whether all dependencies are installed. As report providers are closely integrated with the Report command, the method throws a DependencyMissingException if the command handler is not installed.

Specified by:

checkDependencies in interface Plugin

Parameters:

manager - plugin manager instance.

Throws:

DependencyMissingException - when one or more required dependencies is not installed.

getSupportedFormats

public String[] getSupportedFormats()

Description copied from interface: ReportProvider

Get formats supported by this particular provider. The formats are not case sensitive and they must correspond to the supported file extensions. For example, a provider able to generate XML, HTML and Excel formats should return new String[] {"xml", "html", "htm", "xls"}.

The method is used by the calling Report instance to validate file name provided by the script command. If the file doesn't have one of the extensions supported by the selected provider, a syntax error is reported.

Specified by:

getSupportedFormats in interface ReportProvider

Returns:

array of supported formats (file extensions).