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

Class DeleteSshKey

java.lang.Object
com.google.gerrit.server.restapi.account.DeleteSshKey
All Implemented Interfaces:
RestModifyView<AccountResource.SshKey,Input>, RestView<AccountResource.SshKey>
public class DeleteSshKey extends Object implements RestModifyView<AccountResource.SshKey,Input>
REST endpoint to delete an SSH key of an account.

This REST endpoint handles DELETE /accounts/<account-identifier>/sshkeys/<ssh-key-identifier> requests.

  • Method Details

    • apply

      public Response<?> apply(AccountResource.SshKey rsrc, Input input) throws AuthException, org.eclipse.jgit.errors.RepositoryNotFoundException, IOException, org.eclipse.jgit.errors.ConfigInvalidException, PermissionBackendException
      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.SshKey,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.
      org.eclipse.jgit.errors.RepositoryNotFoundException
      IOException
      org.eclipse.jgit.errors.ConfigInvalidException
      PermissionBackendException

    • apply

      public Response<?> apply(IdentifiedUser user, AccountSshKey sshKey) throws org.eclipse.jgit.errors.RepositoryNotFoundException, IOException, org.eclipse.jgit.errors.ConfigInvalidException
      Throws:
      org.eclipse.jgit.errors.RepositoryNotFoundException
      IOException
      org.eclipse.jgit.errors.ConfigInvalidException