org.apache.syncope.common.rest.api.service

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.rest.api.service.JAXRSService

PARAM_ANYTYPE_KIND, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_RESOURCE, PARAM_SIZE

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(RoleTO roleTO) Creates a new role.
void	delete(String key) Deletes the role matching the provided key.
javax.ws.rs.core.Response	getConsoleLayoutInfo(String key) Gets the console layout information as JSON string for the role with the given key, if available.
List<RoleTO>	list() Returns a list of all roles.
RoleTO	read(String key) Returns role with matching key.
void	removeConsoleLayoutInfo(String key) Removes the console layout information for the role with the given key, if available.
void	setConsoleLayoutInfo(String key, InputStream consoleLayoutInfoIn) Sets the console layout information as JSON string for the role with the given key, if available.
void	update(RoleTO roleTO) Updates the role matching the provided key.

Method Detail

list

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

Returns a list of all roles.

Returns:

list of all roles.

read

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

Returns role with matching key.

Parameters:

key - role key to be read

Returns:

role with matching key

create

@POST
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
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

update

@PUT
 @Path(value="{key}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
void update(@NotNull
                                                                                                                                                                                               RoleTO roleTO)

Updates the role matching the provided key.

Parameters:

roleTO - role to be stored

delete

@DELETE
 @Path(value="{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
void delete(@NotNull @PathParam(value="key")
                                                                                                                      String key)

Deletes the role matching the provided key.

Parameters:

key - role key to be deleted

getConsoleLayoutInfo

@GET
 @Path(value="{key}/consoleLayout")
 @Produces(value="application/json")
javax.ws.rs.core.Response getConsoleLayoutInfo(@NotNull @PathParam(value="key")
                                                                                                                             String key)

Gets the console layout information as JSON string for the role with the given key, if available.

Parameters:

key - role key

Returns:

console layout information as JSON string for the role with the given key, if available

setConsoleLayoutInfo

@PUT
 @Path(value="{key}/consoleLayout")
 @Consumes(value="application/json")
 @Produces(value={"application/json","application/yaml","application/xml"})
void setConsoleLayoutInfo(@NotNull @PathParam(value="key")
                                                                                                                                                                                    String key,
                                                                                                                                                                                    InputStream consoleLayoutInfoIn)

Sets the console layout information as JSON string for the role with the given key, if available.

Parameters:

key - role key

consoleLayoutInfoIn - console layout information to be set

removeConsoleLayoutInfo

@DELETE
 @Path(value="{key}/consoleLayout")
 @Produces(value={"application/json","application/yaml","application/xml"})
void removeConsoleLayoutInfo(@NotNull @PathParam(value="key")
                                                                                                                                                     String key)

Removes the console layout information for the role with the given key, if available.

Parameters:

key - role key