Package com.google.gerrit.server.restapi.project

Class ListProjectsImpl

java.lang.Object

com.google.gerrit.server.restapi.project.AbstractListProjects

com.google.gerrit.server.restapi.project.ListProjectsImpl

All Implemented Interfaces:

RestReadView<TopLevelResource>, RestView<TopLevelResource>, ListProjects

public class ListProjectsImpl
extends AbstractListProjects

List projects visible to the calling user.

Implement GET /projects/, without a query= parameter.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.gerrit.server.restapi.project.ListProjects

ListProjects.FilterType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ListProjectsImpl(CurrentUser currentUser, ProjectCache projectCache, GroupResolver groupResolver, GroupControl.Factory groupControlFactory, GitRepositoryManager repoManager, PermissionBackend permissionBackend, ProjectNode.Factory projectNodeFactory, WebLinks webLinks, com.google.inject.Provider<QueryProjects> queryProjectsProvider, org.eclipse.jgit.lib.Config config, com.google.gerrit.index.project.ProjectIndexCollection projectIndexes)

Method Summary

Modifier and Type	Method	Description
void	addShowBranch(String branch)
SortedMap<String,ProjectInfo>	apply()
Response<Object>	apply(TopLevelResource resource)	Process the view operation by reading from the resource.
SortedMap<String,ProjectInfo>	display(PrintWriter stdout)
void	displayToStream(OutputStream displayOutputStream)
com.google.gerrit.json.OutputFormat	getFormat()
List<String>	getShowBranch()
boolean	isShowDescription()
boolean	isShowTree()
void	setAll(boolean all)
void	setFilterType(ListProjects.FilterType type)
void	setFormat(com.google.gerrit.json.OutputFormat fmt)
void	setGroupUuid(AccountGroup.UUID groupUuid)
void	setLimit(int limit)
void	setMatchPrefix(String matchPrefix)
void	setMatchRegex(String matchRegex)
void	setMatchSubstring(String matchSubstring)
void	setShowDescription(boolean showDescription)
void	setShowTree(boolean showTree)
void	setStart(int start)
void	setState(ProjectState state)

Methods inherited from class java.lang.Object

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

Constructor Details

ListProjectsImpl

@Inject
protected ListProjectsImpl(CurrentUser currentUser,
 ProjectCache projectCache,
 GroupResolver groupResolver,
 GroupControl.Factory groupControlFactory,
 GitRepositoryManager repoManager,
 PermissionBackend permissionBackend,
 ProjectNode.Factory projectNodeFactory,
 WebLinks webLinks,
 com.google.inject.Provider<QueryProjects> queryProjectsProvider,
 org.eclipse.jgit.lib.Config config,
 com.google.gerrit.index.project.ProjectIndexCollection projectIndexes)

Method Details

setFormat

public void setFormat(com.google.gerrit.json.OutputFormat fmt)

Specified by:

setFormat in interface ListProjects

Specified by:

setFormat in class AbstractListProjects

addShowBranch

public void addShowBranch(String branch)

Specified by:

addShowBranch in interface ListProjects

Specified by:

addShowBranch in class AbstractListProjects

setShowTree

public void setShowTree(boolean showTree)

Specified by:

setShowTree in interface ListProjects

Specified by:

setShowTree in class AbstractListProjects

setFilterType

public void setFilterType(ListProjects.FilterType type)

Specified by:

setFilterType in interface ListProjects

Specified by:

setFilterType in class AbstractListProjects

setShowDescription

public void setShowDescription(boolean showDescription)

Specified by:

setShowDescription in interface ListProjects

Specified by:

setShowDescription in class AbstractListProjects

setAll

public void setAll(boolean all)

Specified by:

setAll in interface ListProjects

Specified by:

setAll in class AbstractListProjects

setState

public void setState(ProjectState state)

Specified by:

setState in interface ListProjects

Specified by:

setState in class AbstractListProjects

setLimit

public void setLimit(int limit)

Specified by:

setLimit in interface ListProjects

Specified by:

setLimit in class AbstractListProjects

setStart

public void setStart(int start)

Specified by:

setStart in interface ListProjects

Specified by:

setStart in class AbstractListProjects

setMatchPrefix

public void setMatchPrefix(String matchPrefix)

Specified by:

setMatchPrefix in interface ListProjects

Specified by:

setMatchPrefix in class AbstractListProjects

setMatchSubstring

public void setMatchSubstring(String matchSubstring)

Specified by:

setMatchSubstring in interface ListProjects

Specified by:

setMatchSubstring in class AbstractListProjects

setMatchRegex

public void setMatchRegex(String matchRegex)

Specified by:

setMatchRegex in interface ListProjects

Specified by:

setMatchRegex in class AbstractListProjects

setGroupUuid

public void setGroupUuid(AccountGroup.UUID groupUuid)

Specified by:

setGroupUuid in interface ListProjects

Specified by:

setGroupUuid in class AbstractListProjects

getShowBranch

public List<String> getShowBranch()

isShowTree

public boolean isShowTree()

isShowDescription

public boolean isShowDescription()

getFormat

public com.google.gerrit.json.OutputFormat getFormat()

apply

public Response<Object> apply(TopLevelResource resource)
                       throws BadRequestException,
PermissionBackendException

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 ListProjects

Specified by:

apply in interface RestReadView<TopLevelResource>

Overrides:

apply in class AbstractListProjects

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.

PermissionBackendException

apply

public SortedMap<String,ProjectInfo> apply()
                                    throws BadRequestException,
PermissionBackendException

Throws:

BadRequestException

PermissionBackendException

displayToStream

public void displayToStream(OutputStream displayOutputStream)
                     throws BadRequestException,
PermissionBackendException

Throws:

BadRequestException

PermissionBackendException

display

@CanIgnoreReturnValue
public SortedMap<String,ProjectInfo> display(PrintWriter stdout)
                                      throws BadRequestException,
PermissionBackendException

Throws:

BadRequestException

PermissionBackendException