Package com.google.gerrit.server.plugins

Class ListPlugins

java.lang.Object

com.google.gerrit.server.plugins.ListPlugins

All Implemented Interfaces:

RestReadView<TopLevelResource>, RestView<TopLevelResource>

public class ListPlugins
extends Object
implements RestReadView<TopLevelResource>

List the installed plugins.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ListPlugins(PluginLoader pluginLoader)

Method Summary

Modifier and Type	Method	Description
Response<SortedMap<String,PluginInfo>>	apply(TopLevelResource resource)	Process the view operation by reading from the resource.
ListPlugins	request(Plugins.ListRequest request)
void	setAll(boolean all)
void	setLimit(int limit)
void	setMatchPrefix(String matchPrefix)
void	setMatchRegex(String matchRegex)
void	setMatchSubstring(String matchSubstring)
void	setStart(int start)
static PluginInfo	toPluginInfo(Plugin p)

Methods inherited from class java.lang.Object

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

Constructor Details

ListPlugins

@Inject
protected ListPlugins(PluginLoader pluginLoader)

Method Details

setAll

public void setAll(boolean all)

setLimit

public void setLimit(int limit)

setStart

public void setStart(int start)

setMatchPrefix

public void setMatchPrefix(String matchPrefix)

setMatchSubstring

public void setMatchSubstring(String matchSubstring)

setMatchRegex

public void setMatchRegex(String matchRegex)

request

public ListPlugins request(Plugins.ListRequest request)

apply

public Response<SortedMap<String,PluginInfo>> apply(TopLevelResource resource)
                                             throws BadRequestException

Description copied from interface: RestReadView

Process the view operation by reading from the resource.

The value of the returned response is automatically converted to JSON unless it is a BinaryResult.

The returned response defines the status code that is returned to the client. For RestReadViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. Response.Redirect can be returned for 302 Found).

Throwing a subclass of RestApiException results in a 4XX response to the client. For any other exception the client will get a 500 Internal Server Error response.

Specified by:

apply in interface RestReadView<TopLevelResource>

Parameters:

resource - resource to read

Returns:

response to return to the client

Throws:

BadRequestException - the request was incorrectly specified and cannot be handled by this view.

toPluginInfo

public static PluginInfo toPluginInfo(Plugin p)