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;
18
19 /**
20 * Main access point to REST client.
21 * As there are many types resources exposed by JIRA REST API, various resources are grouped into clusters
22 * and then handled by different specialized *RestClient classes.
23 *
24 * @since v0.1
25 */
26 public interface JiraRestClient {
27 /**
28 *
29 * @return client for performing operations on selected issue
30 */
31 IssueRestClient getIssueClient();
32
33 /**
34 * @return the client handling session information
35 */
36 SessionRestClient getSessionClient();
37
38 /**
39 * @return the client handling full user information
40 */
41 UserRestClient getUserClient();
42
43 /**
44 * @return the client handling project metadata
45 */
46 ProjectRestClient getProjectClient();
47
48 /**
49 * @return the client handling components
50 */
51 ComponentRestClient getComponentClient();
52
53 /**
54 * @return the client handling basic meta-data (data dictionaries defined in JIRA - like resolutions, statuses,
55 * priorities)
56 */
57 MetadataRestClient getMetadataClient();
58
59 /**
60 * @return the client handling search (e.g. JQL)
61 */
62 SearchRestClient getSearchClient();
63
64 /**
65 * @return the client handling project versions
66 */
67 VersionRestClient getVersionRestClient();
68 }