Package 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.BackdoorLoggingFilter, com.atlassian.jira.testkit.client.RestApiClient.JsonMediaTypeFilter, com.atlassian.jira.testkit.client.RestApiClient.RestCall, com.atlassian.jira.testkit.client.RestApiClient.SessionlessConsistencyFilter

  • Field Summary

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

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

    REST_VERSION

  • Constructor Summary

    Constructors
    Constructor
    Description
    GroupClient(JIRAEnvironmentData environmentData)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    addUserToGroup(String group, String user)
     
    void
    close()
     
    jakarta.ws.rs.core.Response
    createGroup(String groupName)
    Create a group
    jakarta.ws.rs.core.Response
    deleteGroup(String group)
     
    jakarta.ws.rs.core.Response
    getGroup(String group)
    Get a group
    UsersPageBean
    getNextPage(UsersPageBean usersPageBean)
     
    UsersPageBean
    getPaginatedUsersForGroup(String group, Boolean includeInactiveUsers, Long startAt, Long maxResults)
     
    jakarta.ws.rs.core.Response
    removeUserFromGroup(String group, String user)
     

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

    anonymous, authenticate, authoriseWithOAuth2, authoriseWithOAuth2, cleanUp, client, createResource, createResource, createResourceGadget, createResourceInternal, errorResponse, expanded, getCredentialsProvider, getEnvironmentData, loginAs, loginAs, registerResponse, resourceRoot, resourceRoot, setOf, toResponse, toResponse, toResponse, withCredentialsProvider

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

  • Method Details

    • createGroup

      public jakarta.ws.rs.core.Response createGroup(String groupName)
      Create a group
      Parameters:
      groupName - the group name
      Returns:
      the raw response

    • getGroup

      public jakarta.ws.rs.core.Response getGroup(String group)
      Get a group
      Parameters:
      group - name
      Returns:
      the response

    • deleteGroup

      public jakarta.ws.rs.core.Response deleteGroup(String group)

    • addUserToGroup

      public jakarta.ws.rs.core.Response addUserToGroup(String group, String user)

    • removeUserFromGroup

      public jakarta.ws.rs.core.Response 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()