com.urswolfer.gerrit.client.rest.http.groups

Class GroupApiRestClient

java.lang.Object

com.google.gerrit.extensions.api.groups.GroupApi.NotImplemented

com.urswolfer.gerrit.client.rest.http.groups.GroupApiRestClient

All Implemented Interfaces:

GroupApi

public class GroupApiRestClient
extends GroupApi.NotImplemented
implements GroupApi

Author:

Shawn Stafford

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.gerrit.extensions.api.groups.GroupApi

GroupApi.NotImplemented

Constructor Summary

Constructors

Constructor and Description
GroupApiRestClient(GerritRestClient gerritRestClient, GroupsParser groupsParser, String id)

Method Summary

Modifier and Type	Method and Description
void	addGroups(String... groups) Adds subgroups to this group.
void	addMembers(String... members) Add members to a group.
String	description()
void	description(String description) Set group decsription.
GroupInfo	detail()
GroupInfo	get()
static String	getBaseRequestPath()
protected String	getRequestPath()
static String	getRequestPath(String id)
List<GroupInfo>	includedGroups() Lists the subgroups of this group.
List<AccountInfo>	members() List group members, non-recursively.
List<AccountInfo>	members(boolean recursive) List group members.
String	name()
void	name(String name) Set group name.
GroupInfo	owner()
void	owner(String owner) Set group owner.
void	removeGroups(String... groups) Removes subgroups from this group.
void	removeMembers(String... members) Remove members from a group.

Methods inherited from class com.google.gerrit.extensions.api.groups.GroupApi.NotImplemented

auditLog, index, options, options

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gerrit.extensions.api.groups.GroupApi

auditLog, index, options, options

Constructor Detail

GroupApiRestClient

public GroupApiRestClient(GerritRestClient gerritRestClient,
                          GroupsParser groupsParser,
                          String id)

Method Detail

getBaseRequestPath

public static String getBaseRequestPath()

getRequestPath

public static String getRequestPath(String id)

getRequestPath

protected String getRequestPath()

get

public GroupInfo get()
              throws RestApiException

Specified by:

get in interface GroupApi

Overrides:

get in class GroupApi.NotImplemented

Returns:

group info with no ListGroupsOptions set.

Throws:

RestApiException

detail

public GroupInfo detail()
                 throws RestApiException

Specified by:

detail in interface GroupApi

Overrides:

detail in class GroupApi.NotImplemented

Returns:

group info with all ListGroupsOptions set.

Throws:

RestApiException

name

public String name()
            throws RestApiException

Specified by:

name in interface GroupApi

Overrides:

name in class GroupApi.NotImplemented

Returns:

group name.

Throws:

RestApiException

name

public void name(String name)
          throws RestApiException

Description copied from interface: GroupApi

Set group name.

Specified by:

name in interface GroupApi

Overrides:

name in class GroupApi.NotImplemented

Parameters:

name - new name.

Throws:

RestApiException

owner

public GroupInfo owner()
                throws RestApiException

Specified by:

owner in interface GroupApi

Overrides:

owner in class GroupApi.NotImplemented

Returns:

owning group info.

Throws:

RestApiException

owner

public void owner(String owner)
           throws RestApiException

Description copied from interface: GroupApi

Set group owner.

Specified by:

owner in interface GroupApi

Overrides:

owner in class GroupApi.NotImplemented

Parameters:

owner - identifier of new group owner.

Throws:

RestApiException

description

public String description()
                   throws RestApiException

Specified by:

description in interface GroupApi

Overrides:

description in class GroupApi.NotImplemented

Returns:

group description.

Throws:

RestApiException

description

public void description(String description)
                 throws RestApiException

Description copied from interface: GroupApi

Set group decsription.

Specified by:

description in interface GroupApi

Overrides:

description in class GroupApi.NotImplemented

Parameters:

description - new description.

Throws:

RestApiException

members

public List<AccountInfo> members()
                          throws RestApiException

Description copied from interface: GroupApi

List group members, non-recursively.

Specified by:

members in interface GroupApi

Overrides:

members in class GroupApi.NotImplemented

Returns:

group members.

Throws:

RestApiException

members

public List<AccountInfo> members(boolean recursive)
                          throws RestApiException

Description copied from interface: GroupApi

List group members.

Specified by:

members in interface GroupApi

Overrides:

members in class GroupApi.NotImplemented

Parameters:

recursive - whether to recursively included groups.

Returns:

group members.

Throws:

RestApiException

addMembers

public void addMembers(String... members)
                throws RestApiException

Description copied from interface: GroupApi

Add members to a group.

Specified by:

addMembers in interface GroupApi

Overrides:

addMembers in class GroupApi.NotImplemented

Parameters:

members - list of member identifiers, in any format accepted by Accounts.id(String)

Throws:

RestApiException

includedGroups

public List<GroupInfo> includedGroups()
                               throws RestApiException

Description copied from interface: GroupApi

Lists the subgroups of this group.

Specified by:

includedGroups in interface GroupApi

Overrides:

includedGroups in class GroupApi.NotImplemented

Returns:

the found subgroups

Throws:

RestApiException

addGroups

public void addGroups(String... groups)
               throws RestApiException

Description copied from interface: GroupApi

Adds subgroups to this group.

Specified by:

addGroups in interface GroupApi

Overrides:

addGroups in class GroupApi.NotImplemented

Parameters:

groups - list of group identifiers, in any format accepted by Groups.id(String)

Throws:

RestApiException

removeGroups

public void removeGroups(String... groups)
                  throws RestApiException

Description copied from interface: GroupApi

Removes subgroups from this group.

Specified by:

removeGroups in interface GroupApi

Overrides:

removeGroups in class GroupApi.NotImplemented

Parameters:

groups - list of group identifiers, in any format accepted by Groups.id(String)

Throws:

RestApiException

removeMembers

public void removeMembers(String... members)
                   throws RestApiException

Description copied from interface: GroupApi

Remove members from a group.

Specified by:

removeMembers in interface GroupApi

Overrides:

removeMembers in class GroupApi.NotImplemented

Parameters:

members - list of member identifiers, in any format accepted by Accounts.id(String)

Throws:

RestApiException