org.apache.syncope.common.services

Interface PolicyService

All Superinterfaces:

JAXRSService

@Path(value="policies")
public interface PolicyService
extends JAXRSService

REST operations for policies.

Field Summary

Fields inherited from interface org.apache.syncope.common.services.JAXRSService

DEFAULT_PARAM_PAGE, DEFAULT_PARAM_PAGE_VALUE, DEFAULT_PARAM_SIZE, DEFAULT_PARAM_SIZE_VALUE, PARAM_DETAILS, PARAM_FIQL, PARAM_ORDERBY, PARAM_PAGE, PARAM_SIZE

Method Summary

Methods

Modifier and Type	Method and Description
<T extends AbstractPolicyTO> javax.ws.rs.core.Response	create(T policyTO) Create a new policy.
<T extends AbstractPolicyTO> void	delete(Long policyId) Delete policy matching the given id.
List<CorrelationRuleClass>	getSyncCorrelationRuleClasses() Returns a list of classes to be used as correlation rules.
<T extends AbstractPolicyTO> List<T>	list(PolicyType type) Returns a list of policies of the matching type.
<T extends AbstractPolicyTO> T	read(Long policyId) Returns the policy matching the given id.
<T extends AbstractPolicyTO> T	readGlobal(PolicyType type) Returns the global policy for the given type.
<T extends AbstractPolicyTO> void	update(Long policyId, T policyTO) Updates policy matching the given id.

Method Detail

getSyncCorrelationRuleClasses

@GET
@Path(value="syncCorrelationRuleClasses")
@Produces(value={"application/xml","application/json"})
List<CorrelationRuleClass> getSyncCorrelationRuleClasses()

Returns a list of classes to be used as correlation rules.

Returns:

list of classes to be used as correlation rules

read

@GET
@Path(value="{policyId}")
@Produces(value={"application/xml","application/json"})
<T extends AbstractPolicyTO> T read(@NotNull@PathParam(value="policyId")
                                                    Long policyId)

Returns the policy matching the given id.

Type Parameters:

T - response type (extending PolicyTO)

Parameters:

policyId - id of requested policy

Returns:

policy with matching id

readGlobal

@GET
@Path(value="global")
@Produces(value={"application/xml","application/json"})
<T extends AbstractPolicyTO> T readGlobal(@NotNull@MatrixParam(value="type")
                                                          PolicyType type)

Returns the global policy for the given type.

Type Parameters:

T - response type (extending PolicyTO)

Parameters:

type - PolicyType to read global policy from

Returns:

global policy for matching type

list

@GET
@Produces(value={"application/xml","application/json"})
<T extends AbstractPolicyTO> List<T> list(@NotNull@MatrixParam(value="type")
                                                     PolicyType type)

Returns a list of policies of the matching type.

Type Parameters:

T - response type (extending PolicyTO)

Parameters:

type - Type selector for requested policies

Returns:

list of policies with matching type

create

@POST
@Consumes(value={"application/xml","application/json"})
<T extends AbstractPolicyTO> javax.ws.rs.core.Response create(@NotNull
                                                                          T policyTO)

Create a new policy.

Type Parameters:

T - response type (extending PolicyTO)

Parameters:

policyTO - Policy to be created (needs to match type)

Returns:

Response object featuring Location header of created policy

update

@PUT
@Path(value="{policyId}")
@Consumes(value={"application/xml","application/json"})
<T extends AbstractPolicyTO> void update(@NotNull@PathParam(value="policyId")
                                                         Long policyId,
                                                         @NotNull
                                                         T policyTO)

Updates policy matching the given id.

Type Parameters:

T - response type (extending PolicyTO)

Parameters:

policyId - id of policy to be updated

policyTO - Policy to replace existing policy

delete

@DELETE
@Path(value="{policyId}")
<T extends AbstractPolicyTO> void delete(@NotNull@PathParam(value="policyId")
                                                   Long policyId)

Delete policy matching the given id.

Type Parameters:

T - response type (extending PolicyTO)

Parameters:

policyId - id of policy to be deleted