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

Class PutActive

java.lang.Object
com.google.gerrit.server.restapi.account.PutActive
All Implemented Interfaces:
RestModifyView<AccountResource,Input>, RestView<AccountResource>
public class PutActive extends Object implements RestModifyView<AccountResource,Input>
REST endpoint to mark an account as active.

This REST endpoint handles PUT /accounts/<account-identifier>/active requests.

Only active accounts can login into Gerrit, or are suggested as reviewers.

Marking an account as inactive is handled by DeleteActive.

  • Method Details

    • apply

      public Response<String> apply(AccountResource rsrc, Input input) throws RestApiException, 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<AccountResource,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
      org.eclipse.jgit.errors.ConfigInvalidException