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

Class GetState

java.lang.Object

com.google.gerrit.server.restapi.account.GetState

All Implemented Interfaces:

RestReadView<AccountResource>, RestView<AccountResource>

public class GetState
extends Object
implements RestReadView<AccountResource>

REST endpoint to retrieve the superset of all information related to an account. This information is useful to inspect issues with the account and its permissions.

Users can only get the own account state. Getting the account state of other users is not allowed.

Method Summary

Modifier and Type	Method	Description
Response<AccountStateInfo>	apply(AccountResource rsrc)	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 Details

apply

public Response<AccountStateInfo> apply(AccountResource rsrc)
                                 throws RestApiException,
PermissionBackendException,
IOException

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:

rsrc - resource to read

Returns:

response to return to the client

Throws:

RestApiException

PermissionBackendException

IOException