com.atlassian.jira.rest.client
Interface UserRestClient


public interface UserRestClient

The client handling user resources.

Since:
v0.1

Method Summary
 User getUser(String username, ProgressMonitor progressMonitor)
          Retrieves detailed information about selected user.
 User getUser(URI userUri, ProgressMonitor progressMonitor)
          Retrieves detailed information about selected user.
 

Method Detail

getUser

User getUser(String username,
             ProgressMonitor progressMonitor)
Retrieves detailed information about selected user. Try to use getUser(URI, ProgressMonitor) instead as that method is more RESTful (well connected)

Parameters:
username - JIRA username/login
progressMonitor - progress monitor
Returns:
complete information about given user
Throws:
RestClientException - in case of problems (connectivity, malformed messages, etc.)

getUser

User getUser(URI userUri,
             ProgressMonitor progressMonitor)
Retrieves detailed information about selected user. This method is preferred over getUser(String, ProgressMonitor) as it's more RESTful (well connected)

Parameters:
userUri - URI of user resource
progressMonitor - progress monitor
Returns:
complete information about given user
Throws:
RestClientException - in case of problems (connectivity, malformed messages, etc.)


Copyright © 2011 Atlassian Pty Ltd. All Rights Reserved.