All Superinterfaces:

JAXRSService

All Known Implementing Classes:

RoleServiceImpl
```
@Path("roles")
public interface RoleService
extends JAXRSService
```
REST operations for roles.

Field Summary
- Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService
  CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`javax.ws.rs.core.Response`	`create(@NotNull RoleTO roleTO)`	Creates a new role.
`void`	`delete(@NotNull String key)`	Deletes the role matching the provided key.
`javax.ws.rs.core.Response`	`getAnyLayout(@NotNull 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(@NotNull String key)`	Returns role with matching key.
`void`	`removeAnyLayout(@NotNull String key)`	Removes the console layout information for the role with the given key, if available.
`void`	`setAnyLayout(@NotNull String key, InputStream anyLayoutIn)`	Sets the console layout information as JSON string for the role with the given key, if available.
`void`	`update(@NotNull RoleTO roleTO)`	Updates the role matching the provided key.

Method Detail

list

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

Returns a list of all roles.

Returns:: list of all roles.

read

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

Returns role with matching key.

Parameters:: key - role key to be read
Returns:: role with matching key

create

@POST
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response create(@NotNull
                                 @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("{key}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
void update(@NotNull
            @NotNull RoleTO roleTO)

Updates the role matching the provided key.

Parameters:: roleTO - role to be stored

delete

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

Deletes the role matching the provided key.

Parameters:: key - role key to be deleted

getAnyLayout
```
@GET
@Path("{key}/anyLayout")
@Produces("application/json")
javax.ws.rs.core.Response getAnyLayout(@NotNull @PathParam("key")
                                       @NotNull 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

setAnyLayout

@PUT
@Path("{key}/anyLayout")
@Consumes("application/json")
@Produces({"application/json","application/yaml","application/xml"})
void setAnyLayout(@NotNull @PathParam("key")
                  @NotNull String key,
                  InputStream anyLayoutIn)

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

Parameters:: key - role key; anyLayoutIn - console layout information to be set

removeAnyLayout

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

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

Parameters:: key - role key

Interface RoleService

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService