pluginService

Provides the ability to manage application plugins. Use this service to find, install, and uninstall plugins.

Method	Description
getPluginInfo	Returns a list of installed plugins.
installPlugin	Installs the specified plugin.
uninstallPlugin	Unistalls the specified plugin.

getPluginInfo

Returns a list of installed plugins.

GET http://domain:port/application_context/rpc/rest/pluginService/plugins

Response

Type	Description
List of WSPluginInfo	A list of installed plugins.

Response Template

<getPluginInfoResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of WSPluginInfo -->
    <return>
</getPluginInfoResponse>

Errors

Error	When Returned
Unauthorized	If the caller is not a system administrator.

installPlugin

Installs the specified plugin. The data should be the plugin.jar file.

POST http://domain:port/application_context/rpc/rest/pluginService/plugins

Arguments

Name	Type	Description
data	xs:base64Binary	The plugin.jar file containing the plugin to install.

Arguments Template

<installPlugin> 
    <!-- List of ... -->
    <data>xs:base64Binary</data>
</installPlugin>

Response

Type	Description
List of	Information about the installation's results.

Response Template

<installPluginResponse> 
    <!-- List of ... -->
    <return>xs:string</return>
</installPluginResponse>

Errors

Error	When Returned
java.io.IOException	If there is a problem generating the file.
com.jivesoftware.base.plugin.PluginException	If there is a problem installing the plugin.
Unauthorized	If the caller is not a system administrator.

uninstallPlugin

Unistalls the specified plugin.

DELETE http://domain:port/application_context/rpc/rest/pluginService/plugins/{pluginName}

Arguments

Name	Type	Description
pluginName	xs:string	The name of the plugin to uninstall.

Arguments Template

<uninstallPlugin> 
    <pluginName>xs:string</pluginName>
</uninstallPlugin>

Errors

Error	When Returned
Unauthorized	If the caller is not a system administrator.