1 /*
2 * Copyright (C) 2010 Atlassian
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package com.atlassian.jira.rest.client.api;
18
19 import com.atlassian.jira.rest.client.api.domain.User;
20 import com.atlassian.util.concurrent.Promise;
21
22 import java.net.URI;
23
24 /**
25 * The com.atlassian.jira.rest.client.api handling user resources.
26 *
27 * @since v0.1
28 */
29 public interface UserRestClient {
30 /**
31 * Retrieves detailed information about selected user.
32 * Try to use {@link #getUser(URI)} instead as that method is more RESTful (well connected)
33 *
34 * @param username JIRA username/login
35 * @return complete information about given user
36 * @throws RestClientException in case of problems (connectivity, malformed messages, etc.)
37 */
38 Promise<User> getUser(String username);
39
40 /**
41 * Retrieves detailed information about selected user.
42 * This method is preferred over {@link #getUser(String)} as com.atlassian.jira.rest.it's more RESTful (well connected)
43 *
44 * @param userUri URI of user resource
45 * @return complete information about given user
46 * @throws RestClientException in case of problems (connectivity, malformed messages, etc.)
47 */
48 Promise<User> getUser(URI userUri);
49 }