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

Class AddSshKey

java.lang.Object

com.google.gerrit.server.restapi.account.AddSshKey

All Implemented Interfaces:

RestCollectionModifyView<AccountResource,AccountResource.SshKey,SshKeyInput>, RestCollectionView<AccountResource,AccountResource.SshKey,SshKeyInput>, RestView<AccountResource.SshKey>

public class AddSshKey
extends Object
implements RestCollectionModifyView<AccountResource,AccountResource.SshKey,SshKeyInput>

REST endpoint to add an SSH key for an account.

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

Method Summary

Modifier and Type	Method	Description
Response<SshKeyInfo>	apply(AccountResource rsrc, SshKeyInput input)	Process the modification on the collection resource.
Response<SshKeyInfo>	apply(IdentifiedUser user, SshKeyInput input)

Methods inherited from class java.lang.Object

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

Method Details

apply

public Response<SshKeyInfo> apply(AccountResource rsrc,
 SshKeyInput input)
                           throws AuthException,
BadRequestException,
IOException,
org.eclipse.jgit.errors.ConfigInvalidException,
PermissionBackendException

Description copied from interface: RestCollectionModifyView

Process the modification on the collection 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 RestCollectionModifyViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. 201 Created if a resource was created, 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 RestCollectionModifyView<AccountResource,AccountResource.SshKey,SshKeyInput>

Parameters:

rsrc - the collection resource on which the modification is done

Returns:

response to return to the client

Throws:

AuthException

BadRequestException

IOException

org.eclipse.jgit.errors.ConfigInvalidException

PermissionBackendException

apply

public Response<SshKeyInfo> apply(IdentifiedUser user,
 SshKeyInput input)
                           throws BadRequestException,
IOException,
org.eclipse.jgit.errors.ConfigInvalidException

Throws:

BadRequestException

IOException

org.eclipse.jgit.errors.ConfigInvalidException