com.atlassian.jira.webtests.ztests.user

Class GroupClient

java.lang.Object

com.atlassian.jira.testkit.client.RestApiClient<GroupClient>

com.atlassian.jira.webtests.ztests.user.GroupClient

public class GroupClient
extends com.atlassian.jira.testkit.client.RestApiClient<GroupClient>

Client for the REST group resource

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.testkit.client.RestApiClient

com.atlassian.jira.testkit.client.RestApiClient.Method

Field Summary

Fields

Modifier and Type	Field and Description
static String	GROUP_NAME
static String	GROUP_RESOURCE
static String	NAME
static String	USER_NAME

Fields inherited from class com.atlassian.jira.testkit.client.RestApiClient

loginAs, loginPassword, REST_VERSION

Constructor Summary

Constructors

Constructor and Description
GroupClient(JIRAEnvironmentData environmentData)

Method Summary

Modifier and Type	Method and Description
com.sun.jersey.api.client.ClientResponse	addUserToGroup(String group, String user)
void	close()
com.sun.jersey.api.client.ClientResponse	createGroup(String groupName) Create a group
com.sun.jersey.api.client.ClientResponse	deleteGroup(String group)
com.sun.jersey.api.client.ClientResponse	getGroup(String group) Get a group.
com.sun.jersey.api.client.ClientResponse	getGroup(String group, String expand) Get a group
GroupBean	getGroupBean(String group) Get a group and unwrap the GroupBean.
GroupBean	getGroupBean(String group, String expand) Get a group and unwrap the GroupBean.
UsersPageBean	getNextPage(UsersPageBean usersPageBean)
UsersPageBean	getPaginatedUsersForGroup(String group, Boolean includeInactiveUsers, Long startAt, Long maxResults)
com.sun.jersey.api.client.ClientResponse	removeUserFromGroup(String group, String user)
GroupBean	toGroupBean(com.sun.jersey.api.client.ClientResponse response) Unwrap the GroupBean body from the response

Methods inherited from class com.atlassian.jira.testkit.client.RestApiClient

anonymous, cleanUp, client, createResource, createResourceGadget, createResourceInternal, errorResponse, expanded, getEnvironmentData, loginAs, loginAs, percentEncode, registerResponse, resourceRoot, setOf, toResponse, toResponse, toResponse

Methods inherited from class java.lang.Object

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

Field Detail

GROUP_RESOURCE

public static final String GROUP_RESOURCE

See Also:

Constant Field Values

GROUP_NAME

public static final String GROUP_NAME

See Also:

Constant Field Values

USER_NAME

public static final String USER_NAME

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

GroupClient

public GroupClient(JIRAEnvironmentData environmentData)

Method Detail

toGroupBean

public GroupBean toGroupBean(com.sun.jersey.api.client.ClientResponse response)

Unwrap the GroupBean body from the response

Parameters:

response - the response

Returns:

the GroupBean

createGroup

public com.sun.jersey.api.client.ClientResponse createGroup(String groupName)

Create a group

Parameters:

groupName - the group name

Returns:

the raw response

getGroup

public com.sun.jersey.api.client.ClientResponse getGroup(String group,
                                                         @Nullable
                                                         String expand)

Get a group

Parameters:

group - name

expand - the expand parameter, e.g. users[0:50]

Returns:

the response

getGroup

public com.sun.jersey.api.client.ClientResponse getGroup(String group)

Get a group. No expansion of users.

Parameters:

group - the group

Returns:

the response

getGroupBean

public GroupBean getGroupBean(String group)

Get a group and unwrap the GroupBean. No expansion of users.

Parameters:

group - the group

Returns:

the response

getGroupBean

public GroupBean getGroupBean(String group,
                              String expand)

Get a group and unwrap the GroupBean. No expansion of users.

Parameters:

group - the group

expand - the expand parameter

Returns:

the response

deleteGroup

public com.sun.jersey.api.client.ClientResponse deleteGroup(String group)

addUserToGroup

public com.sun.jersey.api.client.ClientResponse addUserToGroup(String group,
                                                               String user)

removeUserFromGroup

public com.sun.jersey.api.client.ClientResponse removeUserFromGroup(String group,
                                                                    String user)

getPaginatedUsersForGroup

public UsersPageBean getPaginatedUsersForGroup(String group,
                                               Boolean includeInactiveUsers,
                                               Long startAt,
                                               Long maxResults)

getNextPage

public UsersPageBean getNextPage(UsersPageBean usersPageBean)

close

public void close()