com.google.gerrit.server.restapi.account

Class AccountsCollection

java.lang.Object

com.google.gerrit.server.restapi.account.AccountsCollection

All Implemented Interfaces:

RestCollection<TopLevelResource,AccountResource>

public class AccountsCollection
extends java.lang.Object
implements RestCollection<TopLevelResource,AccountResource>

Constructor Summary

Constructors

Constructor and Description
AccountsCollection(AccountResolver accountResolver, com.google.inject.Provider<QueryAccounts> list, DynamicMap<RestView<AccountResource>> views)

Method Summary

Modifier and Type	Method and Description
RestView<TopLevelResource>	list() Create a view to list the contents of the collection.
AccountResource	parse(TopLevelResource root, IdString id) Parse a path component into a resource handle.
DynamicMap<RestView<AccountResource>>	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

Constructor Detail

AccountsCollection

@Inject
public AccountsCollection(AccountResolver accountResolver,
                                  com.google.inject.Provider<QueryAccounts> list,
                                  DynamicMap<RestView<AccountResource>> views)

Method Detail

parse

public AccountResource parse(TopLevelResource root,
                             IdString id)
                      throws ResourceNotFoundException,
                             AuthException,
                             java.io.IOException,
                             org.eclipse.jgit.errors.ConfigInvalidException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<TopLevelResource,AccountResource>

Parameters:

root - 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.

AuthException

java.io.IOException

org.eclipse.jgit.errors.ConfigInvalidException

list

public RestView<TopLevelResource> list()
                                throws ResourceNotFoundException

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<TopLevelResource,AccountResource>

Returns:

view to list the collection.

Throws:

ResourceNotFoundException - if the collection doesn't support listing.

views

public DynamicMap<RestView<AccountResource>> 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<TopLevelResource,AccountResource>

Returns:

map of views.