View Javadoc

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.Session;
20  import com.atlassian.util.concurrent.Promise;
21  
22  /**
23   * Client handling the current user session
24   *
25   * @since v2.0.0
26   */
27  public interface SessionRestClient {
28  
29      /**
30       * @return information about current session
31       * @throws RestClientException in case of problems (connectivity, malformed messages, etc.)
32       */
33      Promise<Session> getCurrentSession() throws RestClientException;
34  }