public class

GoogleGDataRequest

extends HttpGDataRequest

java.lang.Object
↳	com.google.gdata.client.http.HttpGDataRequest
	↳	com.google.gdata.client.http.GoogleGDataRequest

Class Overview

The GoogleGDataRequest class provides a basic implementation of an interface to connect with a Google-GData server.

Summary

Nested Classes
class	GoogleGDataRequest.Factory	The GoogleGDataRequest.Factory class is a factory class for constructing new GoogleGDataRequest instances.
class	GoogleGDataRequest.GoogleCookie	Google cookie.

Constants
String	DISABLE_COOKIE_HANDLER_PROPERTY	If set, this System property will globally disable interception and handling of cookies for all GData services.

[Expand]

Inherited Constants

From class com.google.gdata.client.http.HttpGDataRequest

Fields
private static final ThreadLocal<GoogleService>	activeService	Holds the GoogleService that is executing requests for the current execution thread.
private static final GoogleGDataRequest.GoogleCookieHandler	googleCookieHandler	The global CookieHandler instance for GData services.
private static final Logger	logger
private Version	responseVersion	The version associated with the response.
private GoogleService	service	The GoogleService instance that constructed the request.

[Expand]

Inherited Fields

From class com.google.gdata.client.http.HttpGDataRequest

protected final HttpAuthToken	authToken	The auth token used for this request, may be `null`.
protected int	connectTimeout	The connection timeout for this request.
protected final HttpUrlConnectionSource	connectionSource	Source of HttpURLConnection instances.
protected boolean	executed	Indicates whether request execution has taken place.
protected boolean	expectsInput	True if the request type expects input from the client.
protected boolean	hasOutput	True if the request type returns output to the client.
protected HttpURLConnection	httpConn	Underlying HTTP connection to the GData service.
private InputStream	inputStream	The input stream from which HTTP response data may be read or `null` if no response stream or not opened yet via `getResponseStream()`.
protected ContentType	inputType	Contains the content type of the request data
static final Logger	logger
protected int	readTimeout	The read timeout for this request.
protected URL	requestUrl	The request URL provided by the client.
protected Service.GDataRequest.RequestType	type	The GData request type.

Protected Constructors
	GoogleGDataRequest(Service.GDataRequest.RequestType type, URL requestUrl, ContentType contentType, HttpAuthToken authToken, Map<String, String> headerMap, Map<String, String> privateHeaderMap, HttpUrlConnectionSource connectionSource) Constructs a new GoogleGDataRequest instance of the specified RequestType, targeting the specified URL with the specified authentication token.

Public Methods
void	execute() Executes the GData service request.
Version	getRequestVersion() Returns the `Version` that will be used to execute the request on the target service or `null` if the service is not versioned.
Version	getResponseVersion() Returns the `Version` that was used by the target service to execute the request or `null` if the service is not versioned.
void	setService(GoogleService service) Sets the GoogleService associated with the request.

Protected Methods
void	handleErrorResponse() Handles an error response received while executing a GData service request.

[Expand]

Inherited Methods

From class com.google.gdata.client.http.HttpGDataRequest

void	checkResponse() Called after a request is executed to process the response and generate an appropriate exception (on failure).
void	end() Ends all processing associated with this request and releases any transient resources (such as open data streams) required for execution.
void	execute() Executes the GData service request.
HttpURLConnection	getConnection() Returns the URLConnection instance that represents the underlying connection to the GData service that will be used by this request.
ParseSource	getParseSource() Returns a parse source that can be used to read response data from the GData service.
HttpURLConnection	getRequestConnection(URL requestUrl) Obtains a connection to the GData service.
ContentType	getRequestContentType() Returns the `ContentType` of the data that will be written to the service by this request or `null` if no data is written to the server by the request.
OutputStream	getRequestStream() Returns a stream that can be used to write request data to the GData service.
URL	getRequestUrl() Returns the URL that is the target of the GData request
XmlWriter	getRequestWriter()
ContentType	getResponseContentType() Returns the content type of the GData response.
DateTime	getResponseDateHeader(String headerName) Returns the value of a header containing a header or `null` if no response header of this type exists or it could not be parsed as a valid date.
String	getResponseHeader(String headerName) Returns the value of the specified response header name or `null` if no response header of this type exists.
InputStream	getResponseStream() Returns an input stream that can be used to read response data from the GData service.
void	handleErrorResponse() Handles an error response received while executing a GData service request.
void	setConnectTimeout(int timeout) Sets the number of milliseconds to wait for a connection to the remote GData service before timing out.
void	setEtag(String etag) Sets the entity tag value that will be used to conditionalize the request if not `null`.
void	setHeader(String name, String value) Sets a request header (and logs it, if logging is enabled)
void	setIfModifiedSince(DateTime conditionDate) Sets the If-Modified-Since date precondition to be applied to the request.
void	setMethod(String method)
void	setPrivateHeader(String name, String value) Sets request header (and log just the name but not the value, if logging is enabled)
void	setReadTimeout(int timeout) Sets the number of milliseconds to wait for a response from the remote GData service before timing out.

From class java.lang.Object

From interface com.google.gdata.client.Service.GDataRequest

abstract void	end() Ends all processing associated with this request and releases any transient resources (such as open data streams) required for execution.
abstract void	execute() Executes the GData service request.
abstract ParseSource	getParseSource() Returns a parse source that can be used to read response data from the GData service.
abstract ContentType	getRequestContentType() Returns the `ContentType` of the data that will be written to the service by this request or `null` if no data is written to the server by the request.
abstract OutputStream	getRequestStream() Returns a stream that can be used to write request data to the GData service.
abstract URL	getRequestUrl() Returns the URL that is the target of the GData request
abstract ContentType	getResponseContentType() Returns the content type of the GData response.
abstract DateTime	getResponseDateHeader(String headerName) Returns the value of a header containing a header or `null` if no response header of this type exists or it could not be parsed as a valid date.
abstract String	getResponseHeader(String headerName) Returns the value of the specified response header name or `null` if no response header of this type exists.
abstract InputStream	getResponseStream() Returns an input stream that can be used to read response data from the GData service.
abstract void	setConnectTimeout(int timeout) Sets the number of milliseconds to wait for a connection to the remote GData service before timing out.
abstract void	setEtag(String etag) Sets the entity tag value that will be used to conditionalize the request if not `null`.
abstract void	setHeader(String name, String value) Sets a request header (and logs it, if logging is enabled)
abstract void	setIfModifiedSince(DateTime conditionDate) Sets the If-Modified-Since date precondition to be applied to the request.
abstract void	setPrivateHeader(String name, String value) Sets request header (and log just the name but not the value, if logging is enabled)
abstract void	setReadTimeout(int timeout) Sets the number of milliseconds to wait for a response from the remote GData service before timing out.

Constants

public static final String DISABLE_COOKIE_HANDLER_PROPERTY

If set, this System property will globally disable interception and handling of cookies for all GData services.

Constant Value: "com.google.gdata.DisableCookieHandler"

Fields

private static final ThreadLocal<GoogleService> activeService

Holds the GoogleService that is executing requests for the current execution thread.

private static final GoogleGDataRequest.GoogleCookieHandler googleCookieHandler

The global CookieHandler instance for GData services.

private static final Logger logger

private Version responseVersion

The version associated with the response.

private GoogleService service

The GoogleService instance that constructed the request.

Protected Constructors

protected GoogleGDataRequest (Service.GDataRequest.RequestType type, URL requestUrl, ContentType contentType, HttpAuthToken authToken, Map<String, String> headerMap, Map<String, String> privateHeaderMap, HttpUrlConnectionSource connectionSource)

Constructs a new GoogleGDataRequest instance of the specified RequestType, targeting the specified URL with the specified authentication token.

Parameters

type	Type of GDataRequest
requestUrl	Request target URL
contentType
authToken	Token authenticating request to server
headerMap	Map containing additional headers to set
privateHeaderMap	Map containing additional headers to set that should not be logged (eg. authentication info)
connectionSource

Throws

IOException	on error initializing service connection

Public Methods

public void execute ()

Executes the GData service request.

Throws

IOException
ServiceException

public Version getRequestVersion ()

Returns the Version that will be used to execute the request on the target service or null if the service is not versioned.

Returns

version sent with the request or null.

public Version getResponseVersion ()

Returns the Version that was used by the target service to execute the request or null if the service is not versioned.

Returns

version returned with the response or null.

public void setService (GoogleService service)

Sets the GoogleService associated with the request.

Parameters

service

Protected Methods

protected void handleErrorResponse ()

Handles an error response received while executing a GData service request. Throws a ServiceException or one of its subclasses, depending on the failure conditions.

Throws

IOException
ServiceException

Interfaces

Classes

GoogleGDataRequest

Class Overview

Summary

Constants

public static final String DISABLE_COOKIE_HANDLER_PROPERTY

Fields

private static final ThreadLocal<GoogleService> activeService

private static final GoogleGDataRequest.GoogleCookieHandler googleCookieHandler

private static final Logger logger

private Version responseVersion

private GoogleService service

Protected Constructors

protected GoogleGDataRequest (Service.GDataRequest.RequestType type, URL requestUrl, ContentType contentType, HttpAuthToken authToken, Map<String, String> headerMap, Map<String, String> privateHeaderMap, HttpUrlConnectionSource connectionSource)

Parameters

Throws

Public Methods

public void execute ()

Throws

public Version getRequestVersion ()

Returns

public Version getResponseVersion ()

Returns

public void setService (GoogleService service)

Parameters

Protected Methods

protected void handleErrorResponse ()

Throws