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

Class GetSshKeys

java.lang.Object

com.google.gerrit.server.restapi.account.GetSshKeys

All Implemented Interfaces:

RestReadView<AccountResource>, RestView<AccountResource>

public class GetSshKeys
extends Object
implements RestReadView<AccountResource>

REST endpoint to list the SSH keys of an account.

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

Method Summary

Modifier and Type	Method	Description
Response<List<SshKeyInfo>>	apply(AccountResource rsrc)	Process the view operation by reading from the resource.
List<SshKeyInfo>	apply(IdentifiedUser user)
static SshKeyInfo	newSshKeyInfo(AccountSshKey sshKey)

Methods inherited from class java.lang.Object

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

Method Details

apply

public Response<List<SshKeyInfo>> apply(AccountResource rsrc)
                                 throws AuthException,
IOException,
org.eclipse.jgit.errors.ConfigInvalidException,
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.

IOException

org.eclipse.jgit.errors.ConfigInvalidException

PermissionBackendException

apply

public List<SshKeyInfo> apply(IdentifiedUser user)
                       throws org.eclipse.jgit.errors.RepositoryNotFoundException,
IOException,
org.eclipse.jgit.errors.ConfigInvalidException

Throws:

org.eclipse.jgit.errors.RepositoryNotFoundException

IOException

org.eclipse.jgit.errors.ConfigInvalidException

newSshKeyInfo

public static SshKeyInfo newSshKeyInfo(AccountSshKey sshKey)