com.google.api.client.googleapis.json

Class GoogleJsonRpcHttpTransport

java.lang.Object

com.google.api.client.googleapis.json.GoogleJsonRpcHttpTransport

public final class GoogleJsonRpcHttpTransport
extends Object

JSON-RPC 2.0 HTTP transport for RPC requests for Google API's, including both singleton and batched requests.

This implementation is thread-safe.

Warning: this is based on an undocumented experimental Google functionality that may stop working or change in behavior at any time. Beware of this risk if running this in production code.

Since:

1.3

Author:

Yaniv Inbar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GoogleJsonRpcHttpTransport.Builder GoogleJsonRpcHttpTransport Builder.

Constructor Summary

Constructors

Modifier	Constructor and Description
	GoogleJsonRpcHttpTransport(com.google.api.client.http.HttpTransport httpTransport, com.google.api.client.json.JsonFactory jsonFactory) Creates a new GoogleJsonRpcHttpTransport with default values for RPC server, and Content type and Accept headers.
protected	GoogleJsonRpcHttpTransport(com.google.api.client.http.HttpTransport httpTransport, com.google.api.client.json.JsonFactory jsonFactory, String rpcServerUrl, String mimeType, String accept) Creates a new GoogleJsonRpcHttpTransport.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildPostRequest(com.google.api.client.json.rpc2.JsonRpcRequest request) Builds a POST HTTP request for the JSON-RPC requests objects specified in the given JSON-RPC request object.
com.google.api.client.http.HttpRequest	buildPostRequest(List<com.google.api.client.json.rpc2.JsonRpcRequest> requests) Builds a POST HTTP request for the JSON-RPC requests objects specified in the given JSON-RPC request objects.
String	getAccept() Returns the Accept header used for requests.
com.google.api.client.http.HttpTransport	getHttpTransport() Returns the HTTP transport used for building requests.
com.google.api.client.json.JsonFactory	getJsonFactory() Returns the JSON factory used for building requests.
String	getMimeType() Returns the MIME type header used for requests.
String	getRpcServerUrl() Returns the RPC server URL.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GoogleJsonRpcHttpTransport

public GoogleJsonRpcHttpTransport(com.google.api.client.http.HttpTransport httpTransport,
                          com.google.api.client.json.JsonFactory jsonFactory)

Creates a new GoogleJsonRpcHttpTransport with default values for RPC server, and Content type and Accept headers.

Parameters:

httpTransport - HTTP transport required for building requests.

jsonFactory - JSON factory to use for building requests.

Since:

1.9

GoogleJsonRpcHttpTransport

protected GoogleJsonRpcHttpTransport(com.google.api.client.http.HttpTransport httpTransport,
                          com.google.api.client.json.JsonFactory jsonFactory,
                          String rpcServerUrl,
                          String mimeType,
                          String accept)

Creates a new GoogleJsonRpcHttpTransport.

Parameters:

httpTransport - HTTP transport required for building requests.

jsonFactory - JSON factory to use for building requests.

rpcServerUrl - RPC server URL.

mimeType - Content type header to use for requests.

accept - Accept header to use for requests.

Since:

1.9

Method Detail

getHttpTransport

public final com.google.api.client.http.HttpTransport getHttpTransport()

Returns the HTTP transport used for building requests.

Since:

1.9

getJsonFactory

public final com.google.api.client.json.JsonFactory getJsonFactory()

Returns the JSON factory used for building requests.

Since:

1.9

getRpcServerUrl

public final String getRpcServerUrl()

Returns the RPC server URL.

Since:

1.9

getMimeType

public final String getMimeType()

Returns the MIME type header used for requests.

Since:

1.10

getAccept

public final String getAccept()

Returns the Accept header used for requests.

Since:

1.9

buildPostRequest

public com.google.api.client.http.HttpRequest buildPostRequest(com.google.api.client.json.rpc2.JsonRpcRequest request)
                                                        throws IOException

Builds a POST HTTP request for the JSON-RPC requests objects specified in the given JSON-RPC request object.

You may use JsonFactory.createJsonParser(java.io.InputStream) to get the JsonParser, and JsonParser.parseAndClose(Class, CustomizeJsonParser).

Parameters:

request - JSON-RPC request object

Returns:

HTTP request

Throws:

IOException

buildPostRequest

public com.google.api.client.http.HttpRequest buildPostRequest(List<com.google.api.client.json.rpc2.JsonRpcRequest> requests)
                                                        throws IOException

Builds a POST HTTP request for the JSON-RPC requests objects specified in the given JSON-RPC request objects.

Note that the request will always use batching -- i.e. JSON array of requests -- even if there is only one request. You may use JsonFactory.createJsonParser(java.io.InputStream) to get the JsonParser, and JsonParser.parseArrayAndClose(Collection, Class, CustomizeJsonParser) .

Parameters:

requests - JSON-RPC request objects

Returns:

HTTP request

Throws:

IOException