org.apache.syncope.common.services

Interface RoleService

All Superinterfaces:

JAXRSService

@Path(value="roles")
public interface RoleService
extends JAXRSService

REST operations for roles.

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
BulkActionResult	bulk(BulkAction bulkAction) Executes the provided bulk action.
javax.ws.rs.core.Response	bulkAssociation(Long roleId, ResourceAssociationActionType type, List<ResourceName> resourceNames) Executes resource-related operations on given role.
javax.ws.rs.core.Response	bulkDeassociation(Long roleId, ResourceDeassociationActionType type, List<ResourceName> resourceNames) Executes resource-related operations on given role.
TaskExecTO	bulkDeprovisionMembers(Long roleId) Deprovision all members of the given role from all the resources associated to it.
TaskExecTO	bulkProvisionMembers(Long roleId) Provision all members of the given role onto all the resources associated to it.
List<RoleTO>	children(Long roleId) Returns children roles of given role.
javax.ws.rs.core.Response	create(RoleTO roleTO) Creates a new role.
javax.ws.rs.core.Response	delete(Long roleId) Deletes role matching provided roleId.
PagedResult<RoleTO>	list() Returns a paged list of existing roles.
PagedResult<RoleTO>	list(Integer page, Integer size) Returns a paged list of existing roles matching page/size conditions.
PagedResult<RoleTO>	list(Integer page, Integer size, String orderBy, boolean details) Returns a paged list of existing roles matching page/size conditions.
PagedResult<RoleTO>	list(String orderBy) Returns a paged list of existing roles.
RoleTO	parent(Long roleId) Returns parent role of the given role (or null if no parent exists).
RoleTO	read(Long roleId) Reads the role matching the provided roleId.
RoleTO	readSelf(Long roleId) This method is similar to read(Long), but uses different authentication handling to ensure that a user can read his own roles.
PagedResult<RoleTO>	search(String fiql) Returns a paged list of roles matching the provided FIQL search condition.
PagedResult<RoleTO>	search(String fiql, Integer page, Integer size) Returns a paged list of roles matching the provided FIQL search condition.
PagedResult<RoleTO>	search(String fiql, Integer page, Integer size, String orderBy, boolean details) Returns a paged list of roles matching the provided FIQL search condition.
PagedResult<RoleTO>	search(String fiql, String orderBy) Returns a paged list of roles matching the provided FIQL search condition.
javax.ws.rs.core.Response	update(Long roleId, RoleMod roleMod) Updates role matching the provided roleId.

Method Detail

children

@GET
@Path(value="{roleId}/children")
@Produces(value={"application/xml","application/json"})
List<RoleTO> children(@NotNull@PathParam(value="roleId")
                                      Long roleId)

Returns children roles of given role.

Parameters:

roleId - id of role to get children from

Returns:

children roles of given role

parent

@GET
@Path(value="{roleId}/parent")
@Produces(value={"application/xml","application/json"})
RoleTO parent(@NotNull@PathParam(value="roleId")
                              Long roleId)

Returns parent role of the given role (or null if no parent exists).

Parameters:

roleId - id of role to get parent role from

Returns:

parent role of the given role (or null if no parent exists)

read

@GET
@Path(value="{roleId}")
@Produces(value={"application/xml","application/json"})
RoleTO read(@NotNull@PathParam(value="roleId")
                            Long roleId)

Reads the role matching the provided roleId.

Parameters:

roleId - id of role to be read

Returns:

role with matching id

readSelf

@GET
@Path(value="{roleId}/own")
@Produces(value={"application/xml","application/json"})
RoleTO readSelf(@NotNull@PathParam(value="roleId")
                                Long roleId)

This method is similar to read(Long), but uses different authentication handling to ensure that a user can read his own roles.

Parameters:

roleId - id of role to be read

Returns:

role with matching id

list

@GET
@Produces(value={"application/xml","application/json"})
PagedResult<RoleTO> list()

Returns a paged list of existing roles.

Returns:

paged list of all existing roles

list

@GET
@Produces(value={"application/xml","application/json"})
PagedResult<RoleTO> list(@QueryParam(value="orderby")
                                    String orderBy)

Returns a paged list of existing roles.

Parameters:

orderBy - list of ordering clauses, separated by comma

Returns:

paged list of all existing roles

list

@GET
@Produces(value={"application/xml","application/json"})
PagedResult<RoleTO> list(@NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
                                    Integer page,
                                    @NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
                                    Integer size)

Returns a paged list of existing roles matching page/size conditions.

Parameters:

page - result page number

size - number of entries per page

Returns:

paged list of existing roles matching page/size conditions

list

@GET
@Produces(value={"application/xml","application/json"})
PagedResult<RoleTO> list(@NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
                                    Integer page,
                                    @NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
                                    Integer size,
                                    @QueryParam(value="orderby")
                                    String orderBy,
                                    @QueryParam(value="details")@DefaultValue(value="true")
                                    boolean details)

Returns a paged list of existing roles matching page/size conditions.

Parameters:

page - result page number

size - number of entries per page

orderBy - list of ordering clauses, separated by comma

details - whether include all details or not, defaults to true

Returns:

paged list of existing roles matching page/size conditions

search

@GET
@Path(value="search")
@Produces(value={"application/xml","application/json"})
PagedResult<RoleTO> search(@NotNull@QueryParam(value="fiql")
                                           String fiql)

Returns a paged list of roles matching the provided FIQL search condition.

Parameters:

fiql - FIQL search expression

Returns:

paged list of roles matching the provided FIQL search condition

search

@GET
@Path(value="search")
@Produces(value={"application/xml","application/json"})
PagedResult<RoleTO> search(@NotNull@QueryParam(value="fiql")
                                           String fiql,
                                           @QueryParam(value="orderby")
                                           String orderBy)

Returns a paged list of roles matching the provided FIQL search condition.

Parameters:

fiql - FIQL search expression

orderBy - list of ordering clauses, separated by comma

Returns:

paged list of roles matching the provided FIQL search condition

search

@GET
@Path(value="search")
@Produces(value={"application/xml","application/json"})
PagedResult<RoleTO> search(@QueryParam(value="fiql")
                                           String fiql,
                                           @NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
                                           Integer page,
                                           @NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
                                           Integer size)

Returns a paged list of roles matching the provided FIQL search condition.

Parameters:

fiql - FIQL search expression

page - result page number

size - number of entries per page

Returns:

paged list of roles matching the provided FIQL search condition

search

@GET
@Path(value="search")
@Produces(value={"application/xml","application/json"})
PagedResult<RoleTO> search(@QueryParam(value="fiql")
                                           String fiql,
                                           @NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
                                           Integer page,
                                           @NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
                                           Integer size,
                                           @QueryParam(value="orderby")
                                           String orderBy,
                                           @QueryParam(value="details")@DefaultValue(value="true")
                                           boolean details)

Returns a paged list of roles matching the provided FIQL search condition.

Parameters:

fiql - FIQL search expression

page - result page number

size - number of entries per page

orderBy - list of ordering clauses, separated by comma

details - whether include all details or not, defaults to true

Returns:

paged list of roles matching the provided FIQL search condition

create

@POST
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response create(@NotNull
                                                      RoleTO roleTO)

Creates a new role.

Parameters:

roleTO - role to be created

Returns:

Response object featuring Location header of created role as well as the role itself enriched with propagation status information - RoleTO as Entity

update

@POST
@Path(value="{roleId}")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response update(@NotNull@PathParam(value="roleId")
                                                           Long roleId,
                                                           @NotNull
                                                           RoleMod roleMod)

Updates role matching the provided roleId.

Parameters:

roleId - id of role to be updated

roleMod - modification to be applied to role matching the provided roleId

Returns:

Response object featuring the updated role enriched with propagation status information - RoleTO as Entity

delete

@DELETE
@Path(value="{roleId}")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response delete(@NotNull@PathParam(value="roleId")
                                                             Long roleId)

Deletes role matching provided roleId.

Parameters:

roleId - id of role to be deleted

Returns:

Response object featuring the deleted role enriched with propagation status information - RoleTO as Entity

bulkDeassociation

@POST
@Path(value="{roleId}/deassociate/{type}")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response bulkDeassociation(@NotNull@PathParam(value="roleId")
                                                                      Long roleId,
                                                                      @NotNull@PathParam(value="type")
                                                                      ResourceDeassociationActionType type,
                                                                      @NotNull
                                                                      List<ResourceName> resourceNames)

Executes resource-related operations on given role.

Parameters:

roleId - role id.

type - resource association action type

resourceNames - external resources to be used for propagation-related operations

Returns:

Response object featuring BulkActionResult as Entity

bulkAssociation

@POST
@Path(value="{roleId}/associate/{type}")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response bulkAssociation(@NotNull@PathParam(value="roleId")
                                                                    Long roleId,
                                                                    @NotNull@PathParam(value="type")
                                                                    ResourceAssociationActionType type,
                                                                    @NotNull
                                                                    List<ResourceName> resourceNames)

Executes resource-related operations on given role.

Parameters:

roleId - role id.

type - resource association action type

resourceNames - external resources to be used for propagation-related operations

Returns:

Response object featuring BulkActionResult as Entity

bulkProvisionMembers

@POST
@Path(value="{roleId}/associate/PROVISION/members")
TaskExecTO bulkProvisionMembers(@NotNull@PathParam(value="roleId")
                                        Long roleId)

Provision all members of the given role onto all the resources associated to it.

Parameters:

roleId - role id.

Returns:

Response object featuring BulkActionResult as Entity

bulkDeprovisionMembers

@POST
@Path(value="{roleId}/associate/PROVISION/members")
TaskExecTO bulkDeprovisionMembers(@NotNull@PathParam(value="roleId")
                                          Long roleId)

Deprovision all members of the given role from all the resources associated to it.

Parameters:

roleId - role id.

Returns:

Response object featuring BulkActionResult as Entity

bulk

@POST
@Path(value="bulk")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
BulkActionResult bulk(@NotNull
                                                BulkAction bulkAction)

Executes the provided bulk action.

Parameters:

bulkAction - list of role ids against which the bulk action will be performed.

Returns:

Bulk action result