Class AccessCollection
- java.lang.Object
-
- com.google.gerrit.server.restapi.access.AccessCollection
-
- All Implemented Interfaces:
RestCollection<TopLevelResource,AccessResource>
public class AccessCollection extends Object implements RestCollection<TopLevelResource,AccessResource>
REST collection that serves requests to/access/
.
-
-
Constructor Summary
Constructors Constructor Description AccessCollection(com.google.inject.Provider<ListAccess> list, DynamicMap<RestView<AccessResource>> views)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RestView<TopLevelResource>
list()
Create a view to list the contents of the collection.AccessResource
parse(TopLevelResource parent, IdString id)
Parse a path component into a resource handle.DynamicMap<RestView<AccessResource>>
views()
Get the views that support this collection.
-
-
-
Constructor Detail
-
AccessCollection
@Inject public AccessCollection(com.google.inject.Provider<ListAccess> list, DynamicMap<RestView<AccessResource>> views)
-
-
Method Detail
-
list
public RestView<TopLevelResource> 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 interfaceRestCollection<TopLevelResource,AccessResource>
- Returns:
- view to list the collection.
-
parse
public AccessResource parse(TopLevelResource parent, IdString id) throws ResourceNotFoundException
Description copied from interface:RestCollection
Parse a path component into a resource handle.- Specified by:
parse
in interfaceRestCollection<TopLevelResource,AccessResource>
- 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.
-
views
public DynamicMap<RestView<AccessResource>> 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 interfaceRestCollection<TopLevelResource,AccessResource>
- Returns:
- map of views.
-
-