Package com.google.gerrit.server.restapi.account

Class GetGroups

java.lang.Object

com.google.gerrit.server.restapi.account.GetGroups

All Implemented Interfaces:

RestReadView<AccountResource>, RestView<AccountResource>

public class GetGroups
extends Object
implements RestReadView<AccountResource>

REST endpoint to get all known groups of an account (groups that contain the account as member).

This REST endpoint handles GET /accounts/<account-identifier>/groups requests.

The response may not contain all groups of the account as not all groups may be known (see GroupMembership.getKnownGroups()). In addition groups that are not visible to the calling user are filtered out.

Method Summary

Modifier and Type	Method	Description
Response<List<GroupInfo>>	apply(AccountResource resource)	Process the view operation by reading from the resource.

Methods inherited from class java.lang.Object

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

Method Detail

apply

public Response<List<GroupInfo>> apply(AccountResource resource)
                                throws PermissionBackendException

Description copied from interface: RestReadView

Process the view operation by reading from the resource.

The value of the returned response is automatically converted to JSON unless it is a BinaryResult.

The returned response defines the status code that is returned to the client. For RestReadViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. Response.Redirect can be returned for 302 Found).

Throwing a subclass of RestApiException results in a 4XX response to the client. For any other exception the client will get a 500 Internal Server Error response.

Specified by:

apply in interface RestReadView<AccountResource>

Parameters:

resource - resource to read

Returns:

response to return to the client

Throws:

PermissionBackendException