Package com.google.api.client.http
Class HttpRequestFactory
- java.lang.Object
-
- com.google.api.client.http.HttpRequestFactory
-
public final class HttpRequestFactory extends java.lang.Object
Thread-safe light-weight HTTP request factory layer on top of the HTTP transport that has an optionalHTTP request initializer
for initializing requests.For example, to use a particular authorization header across all requests, use:
public static HttpRequestFactory createRequestFactory(HttpTransport transport) { return transport.createRequestFactory(new HttpRequestInitializer() { public void initialize(HttpRequest request) throws IOException { request.getHeaders().setAuthorization("..."); } }); }
- Since:
- 1.4
-
-
Field Summary
Fields Modifier and Type Field Description private HttpRequestInitializer
initializer
HTTP request initializer ornull
for none.private HttpTransport
transport
HTTP transport.
-
Constructor Summary
Constructors Constructor Description HttpRequestFactory(HttpTransport transport, HttpRequestInitializer initializer)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description HttpRequest
buildDeleteRequest(GenericUrl url)
Builds aDELETE
request for the given URL.HttpRequest
buildGetRequest(GenericUrl url)
Builds aGET
request for the given URL.HttpRequest
buildHeadRequest(GenericUrl url)
Builds aHEAD
request for the given URL.HttpRequest
buildPatchRequest(GenericUrl url, HttpContent content)
Builds aPATCH
request for the given URL and content.HttpRequest
buildPostRequest(GenericUrl url, HttpContent content)
Builds aPOST
request for the given URL and content.HttpRequest
buildPutRequest(GenericUrl url, HttpContent content)
Builds aPUT
request for the given URL and content.HttpRequest
buildRequest(java.lang.String requestMethod, GenericUrl url, HttpContent content)
Builds a request for the given HTTP method, URL, and content.HttpRequestInitializer
getInitializer()
Returns the HTTP request initializer ornull
for none.HttpTransport
getTransport()
Returns the HTTP transport.
-
-
-
Field Detail
-
transport
private final HttpTransport transport
HTTP transport.
-
initializer
private final HttpRequestInitializer initializer
HTTP request initializer ornull
for none.
-
-
Constructor Detail
-
HttpRequestFactory
HttpRequestFactory(HttpTransport transport, HttpRequestInitializer initializer)
- Parameters:
transport
- HTTP transportinitializer
- HTTP request initializer ornull
for none
-
-
Method Detail
-
getTransport
public HttpTransport getTransport()
Returns the HTTP transport.- Since:
- 1.5
-
getInitializer
public HttpRequestInitializer getInitializer()
Returns the HTTP request initializer ornull
for none.This initializer is invoked before setting its method, URL, or content.
- Since:
- 1.5
-
buildRequest
public HttpRequest buildRequest(java.lang.String requestMethod, GenericUrl url, HttpContent content) throws java.io.IOException
Builds a request for the given HTTP method, URL, and content.- Parameters:
requestMethod
- HTTP request methodurl
- HTTP request URL ornull
for nonecontent
- HTTP request content ornull
for none- Returns:
- new HTTP request
- Throws:
java.io.IOException
- Since:
- 1.12
-
buildDeleteRequest
public HttpRequest buildDeleteRequest(GenericUrl url) throws java.io.IOException
Builds aDELETE
request for the given URL.- Parameters:
url
- HTTP request URL ornull
for none- Returns:
- new HTTP request
- Throws:
java.io.IOException
-
buildGetRequest
public HttpRequest buildGetRequest(GenericUrl url) throws java.io.IOException
Builds aGET
request for the given URL.- Parameters:
url
- HTTP request URL ornull
for none- Returns:
- new HTTP request
- Throws:
java.io.IOException
-
buildPostRequest
public HttpRequest buildPostRequest(GenericUrl url, HttpContent content) throws java.io.IOException
Builds aPOST
request for the given URL and content.- Parameters:
url
- HTTP request URL ornull
for nonecontent
- HTTP request content ornull
for none- Returns:
- new HTTP request
- Throws:
java.io.IOException
-
buildPutRequest
public HttpRequest buildPutRequest(GenericUrl url, HttpContent content) throws java.io.IOException
Builds aPUT
request for the given URL and content.- Parameters:
url
- HTTP request URL ornull
for nonecontent
- HTTP request content ornull
for none- Returns:
- new HTTP request
- Throws:
java.io.IOException
-
buildPatchRequest
public HttpRequest buildPatchRequest(GenericUrl url, HttpContent content) throws java.io.IOException
Builds aPATCH
request for the given URL and content.- Parameters:
url
- HTTP request URL ornull
for nonecontent
- HTTP request content ornull
for none- Returns:
- new HTTP request
- Throws:
java.io.IOException
-
buildHeadRequest
public HttpRequest buildHeadRequest(GenericUrl url) throws java.io.IOException
Builds aHEAD
request for the given URL.- Parameters:
url
- HTTP request URL ornull
for none- Returns:
- new HTTP request
- Throws:
java.io.IOException
-
-