1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22 package org.opencastproject.security.api;
23
24 import org.apache.http.HttpResponse;
25 import org.apache.http.client.methods.HttpUriRequest;
26
27 import java.io.IOException;
28
29 /**
30 * Provides secured http client components to access to protected resources.
31 */
32 public interface TrustedHttpClient {
33
34 /**
35 * Executes an HttpRequest using a secure, but not necessarily encrypted, http connection.
36 *
37 * @param httpUriRequest
38 * The http request
39 * @return the http response returned by the server
40 */
41 HttpResponse execute(HttpUriRequest httpUriRequest) throws TrustedHttpClientException;
42
43 /**
44 * Executes an HttpRequest using a secure, but not necessarily encrypted, http connection, waiting for the specified
45 * timeouts.
46 *
47 * @param httpUriRequest
48 * The http request
49 * @param connectionTimeout
50 * the wait time in milliseconds at which a connection attempt will throw
51 * @param socketTimeout
52 * the maximum time in milliseconds allowed between packets before this method will throw
53 * @return the http response returned by the server
54 */
55 HttpResponse execute(HttpUriRequest httpUriRequest, int connectionTimeout, int socketTimeout)
56 throws TrustedHttpClientException;
57
58 /**
59 * Closes this response. The caller must call close() once finished reading the response.
60 *
61 * @param response
62 * The response to close
63 */
64 void close(HttpResponse response) throws IOException;
65 }