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)
void	delete(String policyDefinitionId)
io.apiman.manager.api.beans.policies.PolicyDefinitionBean	get(String policyDefinitionId)
List<io.apiman.manager.api.beans.summary.PolicyDefinitionSummaryBean>	list()
void	update(String policyDefinitionId, io.apiman.manager.api.beans.policies.PolicyDefinitionBean bean)

Method Detail

list

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

Throws:

NotAuthorizedException

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

Throws:

PolicyDefinitionAlreadyExistsException

NotAuthorizedException

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

Throws:

PolicyDefinitionNotFoundException

NotAuthorizedException

update

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

Throws:

PolicyDefinitionNotFoundException

NotAuthorizedException

delete

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

Throws:

PolicyDefinitionNotFoundException

NotAuthorizedException