Package com.google.gerrit.server.restapi.config

Class ConfirmEmail

java.lang.Object

com.google.gerrit.server.restapi.config.ConfirmEmail

All Implemented Interfaces:

RestModifyView<ConfigResource,ConfirmEmail.Input>, RestView<ConfigResource>

public class ConfirmEmail
extends Object
implements RestModifyView<ConfigResource,ConfirmEmail.Input>

REST endpoint to confirm an email address for an account.

This REST endpoint handles PUT /config/server/email.confirm requests.

When a user registers a new email address for their account (see CreateEmail) an email with a confirmation link is sent to that address. When the receiver confirms the email by clicking on the confirmation link, this REST endpoint is invoked and the email address is added to the account. Confirming an email address for an account creates an external ID that links the email address to the account. An email address can only be added to an account if it is not assigned to any other account yet.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfirmEmail.Input

Constructor Summary

Constructors

Constructor	Description
ConfirmEmail(com.google.inject.Provider<CurrentUser> self, EmailTokenVerifier emailTokenVerifier, AccountManager accountManager)

Method Summary

Modifier and Type	Method	Description
Response<?>	apply(ConfigResource rsrc, ConfirmEmail.Input input)	Process the view operation by altering the resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfirmEmail

@Inject
public ConfirmEmail(com.google.inject.Provider<CurrentUser> self,
                    EmailTokenVerifier emailTokenVerifier,
                    AccountManager accountManager)

Method Detail

apply

public Response<?> apply(ConfigResource rsrc,
                         ConfirmEmail.Input input)
                  throws AuthException,
                         UnprocessableEntityException,
                         IOException,
                         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<ConfigResource,ConfirmEmail.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.

UnprocessableEntityException

IOException

org.eclipse.jgit.errors.ConfigInvalidException