io.apiman.manager.api.rest.contract

Interface IPolicyDefinitionResource

@Path(value="policyDefs")
public interface IPolicyDefinitionResource

The Policy Definition API.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
io.apiman.manager.api.beans.policies.PolicyDefinitionBean	create(io.apiman.manager.api.beans.policies.PolicyDefinitionBean bean) Use this endpoint to add a policy definition to apiman.
void	delete(String policyDefinitionId) Use this endpoint to delete a policy definition by its ID.
io.apiman.manager.api.beans.policies.PolicyDefinitionBean	get(String policyDefinitionId) Use this endpoint to get a single policy definition by its ID.
List<io.apiman.manager.api.beans.summary.PolicyDefinitionSummaryBean>	list() This endpoint returns a list of all policy definitions that have been added to apiman.
void	update(String policyDefinitionId, io.apiman.manager.api.beans.policies.UpdatePolicyDefinitionBean bean) Update the meta information about a policy definition.

Method Detail

list

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

This endpoint returns a list of all policy definitions that have been added to apiman.

Returns:

A list of policy definitions.

Throws:

NotAuthorizedException - when not authorized to invoke this method

create

@POST
@Consumes(value="application/json")
@Produces(value="application/json")
io.apiman.manager.api.beans.policies.PolicyDefinitionBean create(io.apiman.manager.api.beans.policies.PolicyDefinitionBean bean)
                                                                 throws PolicyDefinitionAlreadyExistsException,
                                                                        NotAuthorizedException

Use this endpoint to add a policy definition to apiman. The policy definition can optionall include the 'id' property. If no 'id' is supplied, one will be generated based on the name.

Parameters:

bean - The policy definition to add.

Returns:

Details about the policy definition that was added.

Throws:

PolicyDefinitionAlreadyExistsException - when trying to create a Policy Definition that already exists

NotAuthorizedException - when not authorized to invoke this method

get

@GET
@Path(value="{policyDefinitionId}")
@Produces(value="application/json")
io.apiman.manager.api.beans.policies.PolicyDefinitionBean get(@PathParam(value="policyDefinitionId")
                                                                              String policyDefinitionId)
                                                              throws PolicyDefinitionNotFoundException,
                                                                     NotAuthorizedException

Use this endpoint to get a single policy definition by its ID.

Parameters:

policyDefinitionId - The ID of the policy definition.

Returns:

A policy definition if found.

Throws:

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

NotAuthorizedException - when not authorized to invoke this method

update

@PUT
@Path(value="{policyDefinitionId}")
void update(@PathParam(value="policyDefinitionId")
                   String policyDefinitionId,
                   io.apiman.manager.api.beans.policies.UpdatePolicyDefinitionBean bean)
            throws PolicyDefinitionNotFoundException,
                   NotAuthorizedException

Update the meta information about a policy definition.

Parameters:

policyDefinitionId - The policy definition ID.

bean - New meta-data for the policy definition.

Throws:

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

NotAuthorizedException - when not authorized to invoke this method

delete

@DELETE
@Path(value="{policyDefinitionId}")
void delete(@PathParam(value="policyDefinitionId")
                      String policyDefinitionId)
            throws PolicyDefinitionNotFoundException,
                   NotAuthorizedException

Use this endpoint to delete a policy definition by its ID. If the policy definition was added automatically from an installed plugin, this will fail. The only way to remove such policy definitions is to remove the plugin.

Parameters:

policyDefinitionId - The policy definition ID.

Throws:

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

NotAuthorizedException - when not authorized to invoke this method