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

Class GetPreferences

java.lang.Object

com.google.gerrit.server.restapi.account.GetPreferences

All Implemented Interfaces:

RestReadView<AccountResource>, RestView<AccountResource>

public class GetPreferences
extends Object
implements RestReadView<AccountResource>

REST endpoint to get the general preferences of an account.

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

Diff preferences can be retrieved by GetDiffPreferences and edit preferences can be retrieved by GetEditPreferences.

Default general preferences that apply for all accounts can be retrieved by GetPreferences.

Method Summary

Modifier and Type	Method	Description
Response<GeneralPreferencesInfo>	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<GeneralPreferencesInfo> apply(AccountResource rsrc)
                                       throws RestApiException,
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:

rsrc - resource to read

Returns:

response to return to the client

Throws:

AuthException - the caller is not permitted to access this view.

BadRequestException - the request was incorrectly specified and cannot be handled by this view.

ResourceConflictException - the resource state does not permit this view to make the changes at this time.

RestApiException

PermissionBackendException