@Path(value="roles") public interface RoleService extends JAXRSService
CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER
Modifier and Type | Method and 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.
|
@GET @Produces(value={"application/json","application/yaml","application/xml"}) List<RoleTO> list()
@GET @Path(value="{key}") @Produces(value={"application/json","application/yaml","application/xml"}) RoleTO read(@NotNull @PathParam(value="key") @NotNull String key)
key
- role key to be read@POST @Consumes(value={"application/json","application/yaml","application/xml"}) @Produces(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response create(@NotNull @NotNull RoleTO roleTO)
roleTO
- role to be created@PUT @Path(value="{key}") @Consumes(value={"application/json","application/yaml","application/xml"}) @Produces(value={"application/json","application/yaml","application/xml"}) void update(@NotNull @NotNull RoleTO roleTO)
roleTO
- role to be stored@DELETE @Path(value="{key}") @Produces(value={"application/json","application/yaml","application/xml"}) void delete(@NotNull @PathParam(value="key") @NotNull String key)
key
- role key to be deleted@GET @Path(value="{key}/anyLayout") @Produces(value="application/json") javax.ws.rs.core.Response getAnyLayout(@NotNull @PathParam(value="key") @NotNull String key)
key
- role key@PUT @Path(value="{key}/anyLayout") @Consumes(value="application/json") @Produces(value={"application/json","application/yaml","application/xml"}) void setAnyLayout(@NotNull @PathParam(value="key") @NotNull String key, InputStream anyLayoutIn)
key
- role keyanyLayoutIn
- console layout information to be set@DELETE @Path(value="{key}/anyLayout") @Produces(value={"application/json","application/yaml","application/xml"}) void removeAnyLayout(@NotNull @PathParam(value="key") @NotNull String key)
key
- role keyCopyright © 2010–2023 The Apache Software Foundation. All rights reserved.