com.eviware.soapui.plugins

Interface Plugin

All Known Subinterfaces:

UninstallablePlugin

All Known Implementing Classes:

PluginAdapter

public interface Plugin

Defines the interface of a SoapUI plugin. The easiest way to create such a class is to extend PluginAdapter. A class implementing this interface and annotated with PluginConfiguration will be automatically discovered when the plugin JAR is loaded.

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.

Method Detail

getInfo

PluginInfo getInfo()

isActive

boolean isActive()

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.

Returns:

true if and only if this plugin should be enabled

initialize

void initialize()

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.

getListeners

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

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.

Returns:

an ordered list of listener classes

getActions

List<? extends SoapUIAction> getActions()

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.

Returns:

an ordered list of action classes

getApiImporters

Collection<? extends ApiImporter> getApiImporters()

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.

Returns:

a collection of API importer classes

getFactories

Collection<? extends SoapUIFactory> getFactories()

Gets all the factories provided by this plugin.

Returns:

an unordered collection of factory objects

hasSameIdAs

boolean hasSameIdAs(Plugin otherPlugin)

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.

Parameters:

otherPlugin -

Returns: