Package com.google.gerrit.server.restapi.group

Class ListGroups

java.lang.Object

com.google.gerrit.server.restapi.group.ListGroups

All Implemented Interfaces:

RestReadView<TopLevelResource>, RestView<TopLevelResource>

public class ListGroups
extends Object
implements RestReadView<TopLevelResource>

List groups visible to the calling user.

Field Summary

Fields

Modifier and Type	Field	Description
protected GroupCache	groupCache

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ListGroups(GroupCache groupCache, GroupControl.Factory groupControlFactory, GroupControl.GenericFactory genericGroupControlFactory, com.google.inject.Provider<IdentifiedUser> identifiedUser, IdentifiedUser.GenericFactory userFactory, GetGroups accountGetGroups, GroupResolver groupResolver, GroupJson json, GroupBackend groupBackend, Groups groups)

Method Summary

Modifier and Type	Method	Description
void	addGroup(AccountGroup.UUID uuid)
void	addProject(ProjectState project)
SortedMap<String,GroupInfo>	apply(TopLevelResource resource)	Process the view operation by reading from the resource.
List<GroupInfo>	get()
List<ProjectState>	getProjects()
Account.Id	getUser()
void	setLimit(int limit)
void	setMatchRegex(String matchRegex)
void	setMatchSubstring(String matchSubstring)
void	setOptions(Set<ListGroupsOption> options)
void	setOwned(boolean owned)
void	setOwnedBy(String ownedBy)
void	setStart(int start)
void	setSuggest(String suggest)
void	setUser(Account.Id user)
void	setVisibleToAll(boolean visibleToAll)

Methods inherited from class java.lang.Object

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

Field Detail

groupCache

protected final GroupCache groupCache

Constructor Detail

ListGroups

@Inject
protected ListGroups(GroupCache groupCache,
                     GroupControl.Factory groupControlFactory,
                     GroupControl.GenericFactory genericGroupControlFactory,
                     com.google.inject.Provider<IdentifiedUser> identifiedUser,
                     IdentifiedUser.GenericFactory userFactory,
                     GetGroups accountGetGroups,
                     GroupResolver groupResolver,
                     GroupJson json,
                     GroupBackend groupBackend,
                     Groups groups)

Method Detail

addProject

public void addProject(ProjectState project)

setVisibleToAll

public void setVisibleToAll(boolean visibleToAll)

setUser

public void setUser(Account.Id user)

setOwned

public void setOwned(boolean owned)

addGroup

public void addGroup(AccountGroup.UUID uuid)

setLimit

public void setLimit(int limit)

setStart

public void setStart(int start)

setMatchSubstring

public void setMatchSubstring(String matchSubstring)

setMatchRegex

public void setMatchRegex(String matchRegex)

setSuggest

public void setSuggest(String suggest)

setOwnedBy

public void setOwnedBy(String ownedBy)

setOptions

public void setOptions(Set<ListGroupsOption> options)

getUser

public Account.Id getUser()

getProjects

public List<ProjectState> getProjects()

apply

public SortedMap<String,GroupInfo> apply(TopLevelResource resource)
                                        throws RestApiException,
                                               IOException,
                                               org.eclipse.jgit.errors.ConfigInvalidException,
                                               PermissionBackendException

Description copied from interface: RestReadView

Process the view operation by reading from the resource.

Specified by:

apply in interface RestReadView<TopLevelResource>

Parameters:

resource - resource to read.

Returns:

result to return to the client. Use BinaryResult to avoid automatic conversion to JSON.

Throws:

AuthException - the client is not permitted to access this view.

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

ResourceConflictException - the resource state does not permit this view to make the changes at this time.

RestApiException

IOException

org.eclipse.jgit.errors.ConfigInvalidException

PermissionBackendException

get

public List<GroupInfo> get()
                    throws RestApiException,
                           IOException,
                           org.eclipse.jgit.errors.ConfigInvalidException,
                           PermissionBackendException

Throws:

RestApiException

IOException

org.eclipse.jgit.errors.ConfigInvalidException

PermissionBackendException