Package com.google.api.client.http
Class HttpRequestFactory
java.lang.Object
com.google.api.client.http.HttpRequestFactory
Thread-safe light-weight HTTP request factory layer on top of the HTTP transport that has an
optional
HTTP 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
FieldsModifier and TypeFieldDescriptionprivate final HttpRequestInitializer
HTTP request initializer ornull
for none.private final HttpTransport
HTTP transport. -
Constructor Summary
ConstructorsConstructorDescriptionHttpRequestFactory
(HttpTransport transport, HttpRequestInitializer initializer) -
Method Summary
Modifier and TypeMethodDescriptionBuilds aDELETE
request for the given URL.Builds aGET
request for the given URL.Builds aHEAD
request for the given URL.buildPatchRequest
(GenericUrl url, HttpContent content) Builds aPATCH
request for the given URL and content.buildPostRequest
(GenericUrl url, HttpContent content) Builds aPOST
request for the given URL and content.buildPutRequest
(GenericUrl url, HttpContent content) Builds aPUT
request for the given URL and content.buildRequest
(String requestMethod, GenericUrl url, HttpContent content) Builds a request for the given HTTP method, URL, and content.Returns the HTTP request initializer ornull
for none.Returns the HTTP transport.
-
Field Details
-
transport
HTTP transport. -
initializer
HTTP request initializer ornull
for none.
-
-
Constructor Details
-
HttpRequestFactory
HttpRequestFactory(HttpTransport transport, HttpRequestInitializer initializer) - Parameters:
transport
- HTTP transportinitializer
- HTTP request initializer ornull
for none
-
-
Method Details
-
getTransport
Returns the HTTP transport.- Since:
- 1.5
-
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(String requestMethod, GenericUrl url, HttpContent content) throws 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:
IOException
- Since:
- 1.12
-
buildDeleteRequest
Builds aDELETE
request for the given URL.- Parameters:
url
- HTTP request URL ornull
for none- Returns:
- new HTTP request
- Throws:
IOException
-
buildGetRequest
Builds aGET
request for the given URL.- Parameters:
url
- HTTP request URL ornull
for none- Returns:
- new HTTP request
- Throws:
IOException
-
buildPostRequest
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:
IOException
-
buildPutRequest
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:
IOException
-
buildPatchRequest
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:
IOException
-
buildHeadRequest
Builds aHEAD
request for the given URL.- Parameters:
url
- HTTP request URL ornull
for none- Returns:
- new HTTP request
- Throws:
IOException
-