com.eviware.soapui.plugins

Class PluginAdapter

java.lang.Object

com.eviware.soapui.plugins.PluginAdapter

All Implemented Interfaces:

Plugin

public class PluginAdapter
extends Object
implements Plugin

A helper class providing reasonable defaults for all methods in the Plugin interface.

Constructor Summary

Constructors

Constructor and Description
PluginAdapter()

Method Summary

Modifier and Type	Method and Description
List<? extends SoapUIAction>	getActions() Gets all the SoapUI actions provided by this plugin.
Collection<? extends ApiImporter>	getApiImporters() Gets all the API importers provided by this plugin.
Collection<? extends SoapUIFactory>	getFactories() Gets all the factories provided by this plugin.
PluginInfo	getInfo()
List<Class<? extends SoapUIListener>>	getListeners() Gets all the listeners provided by this plugin.
boolean	hasSameIdAs(Plugin otherPlugin) Returns true if and only if the plugin passed as a parameter is identified as the same plugin, i.e.
void	initialize() This method is invoked by SoapUI when the plugin is loaded and should ensure that the plugin is fully initialized.
boolean	isActive() Returns a boolean indicating whether this plugin should be activated when loaded.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginAdapter

public PluginAdapter()

Method Detail

isActive

public boolean isActive()

Description copied from interface: Plugin

Returns a boolean indicating whether this plugin should be activated when loaded. Implementations could e.g. check whether a certain system property is set to a specific value.

Specified by:

isActive in interface Plugin

Returns:

true if and only if this plugin should be enabled

getInfo

public PluginInfo getInfo()

Specified by:

getInfo in interface Plugin

initialize

public void initialize()

Description copied from interface: Plugin

This method is invoked by SoapUI when the plugin is loaded and should ensure that the plugin is fully initialized. If the plugin cannot be initialized properly, the method should indicate this by throwing an appropriate RuntimeException.

Specified by:

initialize in interface Plugin

getListeners

public List<Class<? extends SoapUIListener>> getListeners()

Description copied from interface: Plugin

Gets all the listeners provided by this plugin. SoapUI will use reflection to ensure that Classes can be annotated with ListenerConfiguration to provide additional information. The order of the list controls the order in which listeners are invoked.

Specified by:

getListeners in interface Plugin

Returns:

an ordered list of listener classes

getActions

public List<? extends SoapUIAction> getActions()

Description copied from interface: Plugin

Gets all the SoapUI actions provided by this plugin. Classes can be annotated with ActionConfiguration to provide additional information. The order of the list controls the order in which actions are added to menus.

Specified by:

getActions in interface Plugin

Returns:

an ordered list of action classes

getApiImporters

public Collection<? extends ApiImporter> getApiImporters()

Description copied from interface: Plugin

Gets all the API importers provided by this plugin. Classes can be annotated with PluginApiImporter to provide additional information. NOTE: this is currently not used by SoapUI Open Source and is only present to ensure binary compatibility between SoapUI OS and ReadyAPI.

Specified by:

getApiImporters in interface Plugin

Returns:

a collection of API importer classes

getFactories

public Collection<? extends SoapUIFactory> getFactories()

Description copied from interface: Plugin

Gets all the factories provided by this plugin.

Specified by:

getFactories in interface Plugin

Returns:

an unordered collection of factory objects

hasSameIdAs

public boolean hasSameIdAs(Plugin otherPlugin)

Description copied from interface: Plugin

Returns true if and only if the plugin passed as a parameter is identified as the same plugin, i.e. if the ID of this plugin matches this.

Specified by:

hasSameIdAs in interface Plugin

Returns: