com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client
Class UserClient

java.lang.Object
  extended by com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient<UserClient>
      extended by com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.UserClient

public class UserClient
extends RestApiClient<UserClient>

Client for the user resource.

Since:
v4.3

Nested Class Summary
 
Nested classes/interfaces inherited from class com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient
RestApiClient.Method
 
Field Summary
 
Fields inherited from class com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient
REST_VERSION
 
Constructor Summary
UserClient(JIRAEnvironmentData environmentData)
          Constructs a new UserClient for a JIRA instance.
 
Method Summary
 User get(String username, User.Expand... expand)
          GETs the user with the given username.
 com.sun.jersey.api.client.WebResource getMultiProjectSearchAssignableResource(String query, String projectKeys, String startAt, String maxResults)
           
 Response getResponse(com.sun.jersey.api.client.WebResource resource)
           
 com.sun.jersey.api.client.WebResource getSearchAssignableResource(String query, String issueKey, String startAt, String maxResults)
           
 com.sun.jersey.api.client.WebResource getSearchResource(String query, String startAt, String maxResults)
           
 com.sun.jersey.api.client.WebResource getSearchViewableIssueResource(String query, String issueKey, String startAt, String maxResults)
           
 Response getUserResponse(String username)
          GETs the user with the given username, returning a Response object.
 List<User> multiProjectSearchAssignable(String query, String projectKeys, String startAt, String maxResults)
           
 List<User> search(String query, String startAt, String maxResults)
           
 List<User> searchAssignable(String query, String issueKey, String startAt, String maxResults)
           
 List<User> searchViewableIssue(String query, String issueKey, String startAt, String maxResults)
           
 
Methods inherited from class com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient
anonymous, createResource, errorResponse, expanded, loginAs, loginAs, percentEncode, resourceRoot, setOf, toResponse, toResponse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserClient

public UserClient(JIRAEnvironmentData environmentData)
Constructs a new UserClient for a JIRA instance.

Parameters:
environmentData - The JIRA environment data
Method Detail

get

public User get(String username,
                User.Expand... expand)
GETs the user with the given username.

Parameters:
username - a String containing the username
expand - a set of attributes to expand
Returns:
a User

searchAssignable

public List<User> searchAssignable(String query,
                                   String issueKey,
                                   String startAt,
                                   String maxResults)

multiProjectSearchAssignable

public List<User> multiProjectSearchAssignable(String query,
                                               String projectKeys,
                                               String startAt,
                                               String maxResults)

searchViewableIssue

public List<User> searchViewableIssue(String query,
                                      String issueKey,
                                      String startAt,
                                      String maxResults)

search

public List<User> search(String query,
                         String startAt,
                         String maxResults)

getSearchAssignableResource

public com.sun.jersey.api.client.WebResource getSearchAssignableResource(String query,
                                                                         String issueKey,
                                                                         String startAt,
                                                                         String maxResults)

getMultiProjectSearchAssignableResource

public com.sun.jersey.api.client.WebResource getMultiProjectSearchAssignableResource(String query,
                                                                                     String projectKeys,
                                                                                     String startAt,
                                                                                     String maxResults)

getSearchViewableIssueResource

public com.sun.jersey.api.client.WebResource getSearchViewableIssueResource(String query,
                                                                            String issueKey,
                                                                            String startAt,
                                                                            String maxResults)

getSearchResource

public com.sun.jersey.api.client.WebResource getSearchResource(String query,
                                                               String startAt,
                                                               String maxResults)

getUserResponse

public Response getUserResponse(String username)
GETs the user with the given username, returning a Response object.

Parameters:
username - a String containing the username
Returns:
a Response

getResponse

public Response getResponse(com.sun.jersey.api.client.WebResource resource)


Copyright © 2002-2012 Atlassian. All Rights Reserved.