Package org.graylog2.rest.resources.roles

Class RolesResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.rest.resources.roles.RolesResource

@RequiresAuthentication
@Path("/roles")
@Consumes("application/json")
@Produces("application/json")
public class RolesResource
extends RestResource

Field Summary

Fields inherited from class org.graylog2.shared.rest.resources.RestResource

configuration, userService

Constructor Summary

Constructors

Constructor	Description
RolesResource(RoleService roleService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addMember(String rolename, String username, String body)
javax.ws.rs.core.Response	create(@Valid @NotNull RoleResponse roleResponse)
void	delete(String name)
RoleMembershipResponse	getMembers(String name)
RolesResponse	listAll()
RoleResponse	read(String name)
javax.ws.rs.core.Response	removeMember(String rolename, String username)
RoleResponse	update(String name, RoleResponse roleRepresentation)

Methods inherited from class org.graylog2.shared.rest.resources.RestResource

checkAnyPermission, checkPermission, checkPermission, getCurrentUser, getIndexSet, getSubject, getUriBuilderToSelf, isAnyPermitted, isAnyPermitted, isPermitted, isPermitted, setPrettyPrint

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RolesResource

@Inject
public RolesResource(RoleService roleService)

Method Details

listAll

@GET
@RequiresPermissions("roles:read")
public RolesResponse listAll()
                      throws NotFoundException

Throws:

NotFoundException

read

@GET
@Path("{rolename}")
public RoleResponse read(@PathParam("rolename")
 String name)
                  throws NotFoundException

Throws:

NotFoundException

create

@POST
@RequiresPermissions("roles:create")
public javax.ws.rs.core.Response create(@Valid @NotNull
 @Valid @NotNull RoleResponse roleResponse)

update

@PUT
@Path("{rolename}")
public RoleResponse update(@PathParam("rolename")
 String name,
 RoleResponse roleRepresentation)
                    throws NotFoundException

Throws:

NotFoundException

delete

@DELETE
@Path("{rolename}")
public void delete(@PathParam("rolename")
 String name)
            throws NotFoundException

Throws:

NotFoundException

getMembers

@GET
@Path("{rolename}/members")
@RequiresPermissions({"users:list","roles:read"})
public RoleMembershipResponse getMembers(@PathParam("rolename")
 String name)
                                  throws NotFoundException

Throws:

NotFoundException

addMember

@PUT
@Path("{rolename}/members/{username}")
public javax.ws.rs.core.Response addMember(@PathParam("rolename")
 String rolename,
 @PathParam("username")
 String username,
 String body)
                                    throws NotFoundException

Throws:

NotFoundException

removeMember

@DELETE
@Path("{rolename}/members/{username}")
public javax.ws.rs.core.Response removeMember(@PathParam("rolename")
 String rolename,
 @PathParam("username")
 String username)
                                       throws NotFoundException

Throws:

NotFoundException