com.google.gerrit.server.restapi.group

Class GroupsCollection

java.lang.Object

com.google.gerrit.server.restapi.group.GroupsCollection

All Implemented Interfaces:

NeedsParams, RestCollection<TopLevelResource,GroupResource>

public class GroupsCollection
extends java.lang.Object
implements RestCollection<TopLevelResource,GroupResource>, NeedsParams

Constructor Summary

Constructors

Constructor and Description
GroupsCollection(DynamicMap<RestView<GroupResource>> views, com.google.inject.Provider<ListGroups> list, com.google.inject.Provider<QueryGroups> queryGroups, GroupControl.Factory groupControlFactory, GroupResolver groupResolver, com.google.inject.Provider<CurrentUser> self)

Method Summary

Modifier and Type	Method and Description
RestView<TopLevelResource>	list() Create a view to list the contents of the collection.
GroupResource	parse(TopLevelResource parent, IdString id) Parse a path component into a resource handle.
void	setParams(com.google.common.collect.ListMultimap<java.lang.String,java.lang.String> params) Sets the request parameter.
DynamicMap<RestView<GroupResource>>	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

GroupsCollection

@Inject
public GroupsCollection(DynamicMap<RestView<GroupResource>> views,
                                com.google.inject.Provider<ListGroups> list,
                                com.google.inject.Provider<QueryGroups> queryGroups,
                                GroupControl.Factory groupControlFactory,
                                GroupResolver groupResolver,
                                com.google.inject.Provider<CurrentUser> self)

Method Detail

setParams

public void setParams(com.google.common.collect.ListMultimap<java.lang.String,java.lang.String> params)
               throws BadRequestException

Description copied from interface: NeedsParams

Sets the request parameter.

Specified by:

setParams in interface NeedsParams

Parameters:

params - the request parameter

Throws:

BadRequestException

list

public RestView<TopLevelResource> list()
                                throws ResourceNotFoundException,
                                       AuthException

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,GroupResource>

Returns:

view to list the collection.

Throws:

ResourceNotFoundException - if the collection doesn't support listing.

AuthException - if the collection requires authentication.

parse

public GroupResource parse(TopLevelResource parent,
                           IdString id)
                    throws AuthException,
                           ResourceNotFoundException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<TopLevelResource,GroupResource>

Parameters:

parent - 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

views

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

Returns:

map of views.