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

Class SshKeys

java.lang.Object

com.google.gerrit.server.restapi.account.SshKeys

All Implemented Interfaces:

ChildCollection<AccountResource,AccountResource.SshKey>, RestCollection<AccountResource,AccountResource.SshKey>, RestView<AccountResource>

public class SshKeys
extends Object
implements ChildCollection<AccountResource,AccountResource.SshKey>

Method Summary

Modifier and Type	Method	Description
RestView<AccountResource>	list()	Create a view to list the contents of the collection.
AccountResource.SshKey	parse(AccountResource rsrc, IdString id)	Parse a path component into a resource handle.
AccountResource.SshKey	parse(IdentifiedUser user, IdString id)
DynamicMap<RestView<AccountResource.SshKey>>	views()	Get the views that support this collection.

Methods inherited from class java.lang.Object

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

Method Detail

list

public RestView<AccountResource> list()

Description copied from interface: RestCollection

Create a view to list the contents of the collection.

The returned view should accept the parent type to scope the search, and may want to take a "q" parameter option to narrow the results.

Specified by:

list in interface RestCollection<AccountResource,AccountResource.SshKey>

Returns:

view to list the collection.

parse

public AccountResource.SshKey parse(AccountResource rsrc,
                                    IdString id)
                             throws ResourceNotFoundException,
                                    IOException,
                                    org.eclipse.jgit.errors.ConfigInvalidException,
                                    PermissionBackendException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<AccountResource,AccountResource.SshKey>

Parameters:

rsrc - the handle to the collection.

id - string identifier supplied by the client. In a URL such as /changes/1234/abandon this string is "1234".

Returns:

a resource handle for the identified object.

Throws:

ResourceNotFoundException - the object does not exist, or the caller is not permitted to know if the resource exists.

IOException

org.eclipse.jgit.errors.ConfigInvalidException

PermissionBackendException

parse

public AccountResource.SshKey parse(IdentifiedUser user,
                                    IdString id)
                             throws ResourceNotFoundException,
                                    IOException,
                                    org.eclipse.jgit.errors.ConfigInvalidException

Throws:

ResourceNotFoundException

IOException

org.eclipse.jgit.errors.ConfigInvalidException

views

public DynamicMap<RestView<AccountResource.SshKey>> views()

Description copied from interface: RestCollection

Get the views that support this collection.

Within a resource the views are accessed as RESOURCE/plugin~view.

Specified by:

views in interface RestCollection<AccountResource,AccountResource.SshKey>

Returns:

map of views.