com.google.gerrit.server.plugins

Class PluginsCollection

java.lang.Object

com.google.gerrit.server.plugins.PluginsCollection

All Implemented Interfaces:

AcceptsCreate<TopLevelResource>, RestCollection<TopLevelResource,PluginResource>

public class PluginsCollection
extends java.lang.Object
implements RestCollection<TopLevelResource,PluginResource>, AcceptsCreate<TopLevelResource>

Method Summary

Modifier and Type	Method and Description
InstallPlugin	create(TopLevelResource parent, IdString id) Handle creation of a child resource.
RestView<TopLevelResource>	list() Create a view to list the contents of the collection.
PluginResource	parse(java.lang.String id)
PluginResource	parse(TopLevelResource parent, IdString id) Parse a path component into a resource handle.
DynamicMap<RestView<PluginResource>>	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<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,PluginResource>

Returns:

view to list the collection.

Throws:

ResourceNotFoundException - if the collection cannot be listed.

parse

public PluginResource parse(TopLevelResource parent,
                            IdString id)
                     throws ResourceNotFoundException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<TopLevelResource,PluginResource>

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.

parse

public PluginResource parse(java.lang.String id)
                     throws ResourceNotFoundException

Throws:

ResourceNotFoundException

create

public InstallPlugin create(TopLevelResource parent,
                            IdString id)
                     throws ResourceNotFoundException,
                            MethodNotAllowedException

Description copied from interface: AcceptsCreate

Handle creation of a child resource.

Specified by:

create in interface AcceptsCreate<TopLevelResource>

Parameters:

parent - parent collection handle.

id - id of the resource being created.

Returns:

a view to perform the creation. The create method must embed the id into the newly returned view object, as it will not be passed.

Throws:

ResourceNotFoundException

MethodNotAllowedException

views

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

Returns:

map of views.