Package com.illumon.iris.db.v2.permissions.rs

Class MemberResource

java.lang.Object

com.illumon.iris.db.v2.permissions.rs.MemberResource

@Path("/members")
@Consumes("application/json")
@Produces("application/json")
public class MemberResource
extends Object

This is the Acl Member resource, defines all REST operations supported for /acl/members uri. Produces and consumes MediaType.APPLICATION_JSON

Constructor Summary

Constructors

Constructor	Description
MemberResource()

Method Summary

Modifier and Type	Method	Description
io.deephaven.shadow.resteasy.javax.ws.rs.core.Response	addMember(Member member)	Adds a user to a list of groups
io.deephaven.shadow.resteasy.javax.ws.rs.core.Response	removeMember(String userId, String[] groups)	Deletes a user from a list of groups

Methods inherited from class java.lang.Object

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

Constructor Details

MemberResource

public MemberResource()

Method Details

addMember

@POST
public io.deephaven.shadow.resteasy.javax.ws.rs.core.Response addMember(@NotNull
 Member member)
                                                                 throws DbAclCheckedException

Adds a user to a list of groups

Parameters:

member - The member entity passed in the request

Returns:

Response with status code of Response.Status.CREATED

Throws:

DbAclCheckedException - upon failure to add member

removeMember

@DELETE
@Path("/{userId}")
public io.deephaven.shadow.resteasy.javax.ws.rs.core.Response removeMember(@PathParam("userId")
 String userId,
 @QueryParam("groups")
 String[] groups)
                                                                    throws DbAclCheckedException

Deletes a user from a list of groups

Parameters:

userId - The path param attribute that identifies the user whose user to group mappings should be removed

groups - The array of groups from whom the user needs to be removed as a member

Returns:

Response with status code of Response.Status.NO_CONTENT

Throws:

DbAclCheckedException - upon failure to remove member