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.
Type Params | Return Type | Name and description |
---|---|---|
|
java.util.List<? extends SoapUIAction> |
getActions() Gets all the SoapUI actions provided by this plugin. |
|
java.util.Collection<? extends ApiImporter> |
getApiImporters() Gets all the API importers provided by this plugin. |
|
java.util.Collection<? extends SoapUIFactory> |
getFactories() Gets all the factories provided by this plugin. |
|
PluginInfo |
getInfo() |
|
java.util.List<java.lang.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. if the ID of this plugin matches this. |
|
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. |
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.
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.
Gets all the factories provided by this 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.
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.
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.
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.
true
if and only if this plugin should be enabled