io.apiman.manager.api.rest.contract

Interface IPluginResource

@Path(value="plugins")
public interface IPluginResource

The Plugin API.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
io.apiman.manager.api.beans.plugins.PluginBean	create(io.apiman.manager.api.beans.plugins.NewPluginBean bean) Use this endpoint to add a plugin to apiman.
void	delete(Long pluginId) Call this endpoint to delete a plugin.
io.apiman.manager.api.beans.plugins.PluginBean	get(Long pluginId) This endpoint can be used to access the full information about an apiman plugin.
List<io.apiman.manager.api.beans.summary.PolicyDefinitionSummaryBean>	getPolicyDefs(Long pluginId) Use this endpoint to get a list of all policy definitions contributed by the plugin.
String	getPolicyForm(Long pluginId, String policyDefId) Use this endpoint to retrieve the form associated with a particular policy definition.
List<io.apiman.manager.api.beans.summary.PluginSummaryBean>	list() This endpoint returns a list of all plugins that have been added to the system.

Method Detail

list

@GET
@Produces(value="application/json")
List<io.apiman.manager.api.beans.summary.PluginSummaryBean> list()
                                                                 throws NotAuthorizedException

This endpoint returns a list of all plugins that have been added to the system.

Returns:

A list of plugins.

Throws:

NotAuthorizedException - when not authorized to invoke this method

create

@POST
@Consumes(value="application/json")
@Produces(value="application/json")
io.apiman.manager.api.beans.plugins.PluginBean create(io.apiman.manager.api.beans.plugins.NewPluginBean bean)
                                                      throws PluginAlreadyExistsException,
                                                             PluginNotFoundException,
                                                             NotAuthorizedException

Use this endpoint to add a plugin to apiman. A plugin consists of the maven coordinates of an artifact deployed to a remote maven repository (e.g. maven central).

Parameters:

bean - The plugin to add.

Returns:

Full details about the plugin that was added.

Throws:

PluginAlreadyExistsException - when attempting to create a plugin that already exists

PluginNotFoundException - when specified plugin not found

NotAuthorizedException - when not authorized to invoke this method

get

@GET
@Path(value="{pluginId}")
@Produces(value="application/json")
io.apiman.manager.api.beans.plugins.PluginBean get(@PathParam(value="pluginId")
                                                                   Long pluginId)
                                                   throws PluginNotFoundException,
                                                          NotAuthorizedException

This endpoint can be used to access the full information about an apiman plugin. The plugin is retrieved using the ID it was given when it was added. The ID information can be retrieved by listing all plugins or remembered when a plugin is first added.

Parameters:

pluginId - the plugin id

Returns:

An apiman plugin.

Throws:

PluginNotFoundException - when specified plugin not found

NotAuthorizedException - when not authorized to invoke this method

delete

@DELETE
@Path(value="{pluginId}")
void delete(@PathParam(value="pluginId")
                      Long pluginId)
            throws PluginNotFoundException,
                   NotAuthorizedException

Call this endpoint to delete a plugin.

Parameters:

pluginId - the plugin id The plugin's ID.

Throws:

PluginNotFoundException - when specified plugin not found

NotAuthorizedException - when not authorized to invoke this method

getPolicyDefs

@GET
@Path(value="{pluginId}/policyDefs")
@Produces(value="application/json")
List<io.apiman.manager.api.beans.summary.PolicyDefinitionSummaryBean> getPolicyDefs(@PathParam(value="pluginId")
                                                                                                    Long pluginId)
                                                                                    throws PluginNotFoundException

Use this endpoint to get a list of all policy definitions contributed by the plugin.

Parameters:

pluginId - the plugin id The plugin ID.

Returns:

A list of policy definitions.

Throws:

PluginNotFoundException - when specified plugin not found

getPolicyForm

@GET
@Path(value="{pluginId}/policyDefs/{policyDefId}/form")
@Produces(value="application/json")
String getPolicyForm(@PathParam(value="pluginId")
                                     Long pluginId,
                                     @PathParam(value="policyDefId")
                                     String policyDefId)
                     throws PluginNotFoundException,
                            PolicyDefinitionNotFoundException,
                            PluginResourceNotFoundException

Use this endpoint to retrieve the form associated with a particular policy definition. Plugins may contribute policy definitions to apiman. Part of that contribution *may* include a form for the UI to display when configuring an instance of the policy. This endpoint returns this form.

Parameters:

pluginId - the plugin id The plugin ID.

policyDefId - The policy definition ID.

Returns:

A policy configuration form.

Throws:

PluginNotFoundException - when specified plugin not found

PolicyDefinitionNotFoundException - when trying to get, update, or delete a policy definition that does not exist

PluginResourceNotFoundException - when plugin resource not found