/
HttpRequestInitializer.java
67 lines (63 loc) · 1.81 KB
/
HttpRequestInitializer.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/*
* Copyright (c) 2011 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.api.client.http;
import java.io.IOException;
/**
* HTTP request initializer.
*
* <p>For example, this might be used to disable request timeouts:
*
* <pre>
* public class DisableTimeout implements HttpRequestInitializer {
* public void initialize(HttpRequest request) {
* request.setConnectTimeout(0);
* request.setReadTimeout(0);
* }
* }
* </pre>
*
* <p>Sample usage with a request factory:
*
* <pre>
* public static HttpRequestFactory createRequestFactory(HttpTransport transport) {
* return transport.createRequestFactory(new DisableTimeout());
* }
* </pre>
*
* <p>More complex usage example:
*
* <pre>
* public static HttpRequestFactory createRequestFactory2(HttpTransport transport) {
* final DisableTimeout disableTimeout = new DisableTimeout();
* return transport.createRequestFactory(new HttpRequestInitializer() {
* public void initialize(HttpRequest request) {
* disableTimeout.initialize(request);
* }
* });
* }
* </pre>
*
* <p>Implementations should normally be thread-safe.
*
* @since 1.4
* @author Yaniv Inbar
*/
public interface HttpRequestInitializer {
/**
* Initializes a request.
*
* @param request HTTP request
*/
void initialize(HttpRequest request) throws IOException;
}