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

Class PutPreferred

java.lang.Object

com.google.gerrit.server.restapi.account.PutPreferred

All Implemented Interfaces:

RestModifyView<AccountResource.Email,Input>, RestView<AccountResource.Email>

public class PutPreferred
extends Object
implements RestModifyView<AccountResource.Email,Input>

REST endpoint to set an email address as preferred email address for an account.

This REST endpoint handles PUT /accounts/<account-identifier>/emails/<email-identifier>/preferred requests.

Users can only set an email address as preferred that is assigned to their account as external ID.

Method Summary

Modifier and Type	Method	Description
Response<String>	apply(AccountResource.Email rsrc, Input input)	Process the view operation by altering the resource.
Response<String>	apply(IdentifiedUser user, String preferredEmail)

Methods inherited from class java.lang.Object

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

Method Detail

apply

public Response<String> apply(AccountResource.Email rsrc,
                              Input input)
                       throws RestApiException,
                              IOException,
                              PermissionBackendException,
                              org.eclipse.jgit.errors.ConfigInvalidException

Description copied from interface: RestModifyView

Process the view operation by altering 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 RestModifyViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. 202 Accepted if a background task was scheduled, 204 No Content if no content is returned, 302 Found for a redirect).

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 RestModifyView<AccountResource.Email,Input>

Parameters:

rsrc - resource to modify

input - input after parsing from request

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

IOException

PermissionBackendException

org.eclipse.jgit.errors.ConfigInvalidException

apply

public Response<String> apply(IdentifiedUser user,
                              String preferredEmail)
                       throws RestApiException,
                              IOException,
                              org.eclipse.jgit.errors.ConfigInvalidException

Throws:

RestApiException

IOException

org.eclipse.jgit.errors.ConfigInvalidException