com.atlassian.jira.rest.client.api

Interface UserRestClient

public interface UserRestClient

The com.atlassian.jira.rest.client.api handling user resources.

Since:

v0.1

Method Summary

Methods

Modifier and Type	Method and Description
com.atlassian.util.concurrent.Promise<User>	getUser(java.lang.String username) Retrieves detailed information about selected user.
com.atlassian.util.concurrent.Promise<User>	getUser(java.net.URI userUri) Retrieves detailed information about selected user.

Method Detail

getUser

com.atlassian.util.concurrent.Promise<User> getUser(java.lang.String username)

Retrieves detailed information about selected user. Try to use getUser(URI) instead as that method is more RESTful (well connected)

Parameters:

username - JIRA username/login

Returns:

complete information about given user

Throws:

RestClientException - in case of problems (connectivity, malformed messages, etc.)

getUser

com.atlassian.util.concurrent.Promise<User> getUser(java.net.URI userUri)

Retrieves detailed information about selected user. This method is preferred over getUser(String) as com.atlassian.jira.rest.it's more RESTful (well connected)

Parameters:

userUri - URI of user resource

Returns:

complete information about given user

Throws:

RestClientException - in case of problems (connectivity, malformed messages, etc.)