@Path(value="policyDefs")
public interface IPolicyDefinitionResource
| 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.
|
@GET @Produces(value="application/json") List<io.apiman.manager.api.beans.summary.PolicyDefinitionSummaryBean> list() throws NotAuthorizedException
NotAuthorizedException - when not authorized to invoke this method@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
bean - The policy definition to add.PolicyDefinitionAlreadyExistsException - when trying to create a Policy Definition that already existsNotAuthorizedException - when not authorized to invoke this method@GET
@Path(value="{policyDefinitionId}")
@Produces(value="application/json")
io.apiman.manager.api.beans.policies.PolicyDefinitionBean get(@PathParam(value="policyDefinitionId")
String policyDefinitionId)
throws PolicyDefinitionNotFoundException,
NotAuthorizedException
policyDefinitionId - The ID of the policy definition.PolicyDefinitionNotFoundException - when trying to get, update, or delete a policy definition that does not existNotAuthorizedException - when not authorized to invoke this method@PUT
@Path(value="{policyDefinitionId}")
void update(@PathParam(value="policyDefinitionId")
String policyDefinitionId,
io.apiman.manager.api.beans.policies.UpdatePolicyDefinitionBean bean)
throws PolicyDefinitionNotFoundException,
NotAuthorizedException
policyDefinitionId - The policy definition ID.bean - New meta-data for the policy definition.PolicyDefinitionNotFoundException - when trying to get, update, or delete a policy definition that does not existNotAuthorizedException - when not authorized to invoke this method@DELETE
@Path(value="{policyDefinitionId}")
void delete(@PathParam(value="policyDefinitionId")
String policyDefinitionId)
throws PolicyDefinitionNotFoundException,
NotAuthorizedException
policyDefinitionId - The policy definition ID.PolicyDefinitionNotFoundException - when trying to get, update, or delete a policy definition that does not existNotAuthorizedException - when not authorized to invoke this methodCopyright © 2015 JBoss, a division of Red Hat. All rights reserved.