public class

DocsService

extends MediaService

java.lang.Object
↳	com.google.gdata.client.Service
	↳	com.google.gdata.client.GoogleService
		↳	com.google.gdata.client.media.MediaService
			↳	com.google.gdata.client.docs.DocsService

Class Overview

Extends the basic MediaService abstraction to define a service that is preconfigured for access to the Google Documents List Data API.

Summary

Nested Classes
class	DocsService.Versions	GData versions supported by the Google Documents List Data API.

Constants
String	DOCS_SERVICE	The abbreviated name of Google Documents List Data API recognized by Google.

[Expand]

Inherited Constants

From class com.google.gdata.client.media.MediaService

Fields
public static final Version	DEFAULT_VERSION	Default GData version used by the Google Documents List Data API.
public static final String	DOCS_SERVICE_VERSION	The version ID of the service.

[Expand]

Inherited Fields

From class com.google.gdata.client.media.MediaService

From class com.google.gdata.client.GoogleService

From class com.google.gdata.client.Service

Public Constructors
	DocsService(String applicationName) Constructs an instance connecting to the Google Documents List Data API for an application with the name `applicationName`.
	DocsService(String applicationName, Service.GDataRequestFactory requestFactory, AuthTokenFactory authTokenFactory) Constructs an instance connecting to the Google Documents List Data API for an application with the name `applicationName` and the given `GDataRequestFactory` and `AuthTokenFactory`.
	DocsService(String applicationName, String protocol, String domainName) Constructs an instance connecting to the Google Documents List Data API with name `serviceName` for an application with the name `applicationName`.

Public Methods
void	addExtensions() Adds the Google Docs extensions.
void	delete(URL aclFeedUrl, AclScope scope) Deletes an existing AclEntry from the specified feed URL.
String	getServiceVersion() Returns information about the service version.
static Version	getVersion() Returns the current GData version used by the Google Documents List Data API.
AclEntry	insert(URL aclFeedUrl, AclScope scope, AclRole role) Inserts a new `AclEntry` into a feed associated with the target service.
DocumentExportEntry	insert(URL exportFeedUrl, List<QueryParameter> params) Start a new request to download the documents that match all search criteria as a zip file.
AclEntry	update(URL aclFeedUrl, AclScope scope, AclRole role) Updates an existing `AclEntry` by writing it to the specified feed URL.

[Expand]

Inherited Methods

From class com.google.gdata.client.media.MediaService

static AltRegistry	getDefaultAltRegistry() Returns an `AltRegistry` instance that is configured with the default parser/generator configuration for a media service.
MediaSource	getMedia(IMediaContent mediaContent, DateTime ifModifiedSince) Returns a `MediaSource` that can be used to read the external media content of an entry.
MediaSource	getMedia(IMediaContent mediaContent) Returns a `MediaSource` that can be used to read the external media content of an entry.
<E extends IEntry> E	insert(URL feedUrl, E entry) Inserts a new `Entry` into a feed associated with the target service.
<E extends IEntry> E	insert(URL feedUrl, Class<E> entryClass, MediaSource media) Inserts a new media resource read from `MediaSource` into a media feed associated with the target service.
void	setChunkedMediaUpload(int chunkSizeInBytes) Configures the service to use chunked streaming mode for media write requests.
<E extends IEntry> E	update(URL url, E entry) Updates an existing entry metadata by writing it to the specified edit URL.
<E extends IEntry> E	updateMedia(URL mediaUrl, Class<E> entryClass, MediaSource media) Updates an existing media resource with data read from the `MediaSource` by writing it it to the specified media edit URL.
<E extends IEntry> E	updateMedia(URL mediaUrl, E entry) Updates an existing entry and associated media resource by writing it to the specified media edit URL.

From class com.google.gdata.client.GoogleService

void	addCookie(GoogleGDataRequest.GoogleCookie cookie) Adds a new GoogleCookie instance to the cache.
<F extends IFeed> F	batch(URL feedUrl, F inputFeed) Executes several operations (insert, update or delete) on the entries that are part of the input `IFeed`.
Service.GDataRequest	createRequest(Service.GDataRequest.RequestType type, URL requestUrl, ContentType contentType) Creates a new GDataRequest for use by the service.
Service.GDataRequest	createRequest(Query query, ContentType contentType) Creates a new GDataRequest for querying the service.
void	delete(URL entryUrl, String etag) Deletes an existing entry (and associated media content, if any) using the specified edit URL.
void	delete(URL entryUrl) Deletes an existing entry (and associated media content, if any) using the specified edit URL.
String	getAuthToken(String username, String password, String captchaToken, String captchaAnswer, String serviceName, String applicationName) Retrieves the authentication token for the provided set of credentials.
AuthTokenFactory	getAuthTokenFactory() Returns the `AuthTokenFactory` currently associated with the service.
CookieManager	getCookieManager() Returns the `CookieManager` currently associated with the service.
Set<GoogleGDataRequest.GoogleCookie>	getCookies() Returns the set of associated cookies returned by previous requests.
<E extends IEntry> E	getEntry(URL entryUrl, Class<E> entryClass, String etag) Returns an Atom entry instance given the URL of the entry, if its current entity tag is different than the provided value.
<E extends IEntry> E	getEntry(URL entryUrl, Class<E> entryClass, DateTime ifModifiedSince) Returns an Atom entry instance, given the URL of the entry and an if-modified-since date.
<F extends IFeed> F	getFeed(URL feedUrl, Class<F> feedClass, DateTime ifModifiedSince) Returns the Feed associated with a particular feed URL, if it's been modified since the specified date.
<F extends IFeed> F	getFeed(Query query, Class<F> feedClass, DateTime ifModifiedSince) Returns the Feed resulting from executing a query, if it's been modified since the specified date.
<F extends IFeed> F	getFeed(Query query, Class<F> feedClass, String etag) Returns the Feed resulting from query execution, if if the entity tag associated with it has changed.
<F extends IFeed> F	getFeed(URL feedUrl, Class<F> feedClass, String etag) Returns the Feed associated with a particular feed URL if the entity tag associated with it has changed.
URL	handleRedirectException(RedirectRequiredException redirect) Handles a redirect exception by generating the new URL to use for the redirect.
void	handleSessionExpiredException(GoogleService.SessionExpiredException e) Delegates session expired exception to `AuthTokenFactory`.
boolean	handlesCookies() Returns `true` if the GoogleService is handling cookies.
<E extends IEntry> E	insert(URL feedUrl, E entry) Inserts a new `IEntry` into a feed associated with the target service.
static String	makePostRequest(URL url, Map<String, String> parameters) Makes a HTTP POST request to the provided `url` given the provided `parameters`.
void	setAuthSubToken(String token) Sets the AuthSub token to be used to authenticate a user.
void	setAuthSubToken(String token, PrivateKey key) Sets the AuthSub token to be used to authenticate a user.
void	setAuthTokenFactory(AuthTokenFactory authTokenFactory) Sets the `AuthTokenFactory` currently associated with the service.
void	setCookieManager(CookieManager cookieManager) Sets the `CookieManager` currently associated with the service.
void	setHandlesCookies(boolean handlesCookies) Enables or disables cookie handling.
void	setOAuth2Credentials(Credential credential) Sets the OAuth 2.0 credentials used to generate the authorization header.
void	setOAuthCredentials(OAuthParameters parameters, OAuthSigner signer) Sets the OAuth credentials used to generate the authorization header.
void	setUserCredentials(String username, String password, String captchaToken, String captchaAnswer) Sets the credentials of the user to authenticate requests to the server.
void	setUserCredentials(String username, String password) Sets the credentials of the user to authenticate requests to the server.
void	setUserCredentials(String username, String password, String captchaToken, String captchaAnswer, ClientLoginAccountType accountType) Sets the credentials of the user to authenticate requests to the server.
void	setUserCredentials(String username, String password, ClientLoginAccountType accountType) Sets the credentials of the user to authenticate requests to the server.
void	setUserToken(String token) Sets the AuthToken that should be used to authenticate requests to the server.
void	tokenChanged(AuthTokenFactory.AuthToken newToken)
<E extends IEntry> E	update(URL entryUrl, E entry) Updates an existing `IEntry` by writing it to the specified entry edit URL.

From class com.google.gdata.client.Service

<F extends IFeed> F	batch(URL feedUrl, F inputFeed) Executes several operations (insert, update or delete) on the entries that are part of the input `IFeed`.
<T> Class<T>	classOf(T object)
Service.GDataRequest	createBatchRequest(URL feedUrl) Creates a new GDataRequest that can be used to execute several insert/update/delete operations in one request by writing a feed into the request stream to read a feed containing the result of the batch operations from the response stream.
Service.GDataRequest	createDeleteRequest(URL entryUrl) Creates a new GDataRequest that can be used to delete an Atom entry.
Service.GDataRequest	createEntryRequest(URL entryUrl) Returns a GDataRequest instance that can be used to access an entry's contents as a stream, given the URL of the entry.
Service.GDataRequest	createFeedRequest(URL feedUrl) Executes a GData feed request against the target service and returns the resulting feed results via an input stream.
Service.GDataRequest	createFeedRequest(Query query) Executes a GData query request against the target service and returns the resulting feed results via an input stream.
Service.GDataRequest	createInsertRequest(URL feedUrl) Creates a new GDataRequest that can be used to insert a new entry into a feed using the request stream and to read the resulting entry content from the response stream.
Service.GDataRequest	createLinkQueryRequest(ILink link) Returns a query (GET) request that targets the provided link.
Service.GDataRequest	createPatchRequest(URL entryUrl) Creates a new GDataRequest that can be used to update an existing Atom entry.
Service.GDataRequest	createRequest(Service.GDataRequest.RequestType type, URL requestUrl, ContentType inputType) Creates a new GDataRequest for use by the service.
Service.GDataRequest	createRequest(Query query, ContentType inputType) Creates a new GDataRequest for querying the service.
Service.GDataRequest	createUpdateRequest(URL entryUrl) Creates a new GDataRequest that can be used to update an existing Atom entry.
void	delete(URL resourceUrl, String etag) Deletes an existing entry (and associated media content, if any) using the specified edit URL.
void	delete(URL resourceUrl) Deletes an existing entry (and associated media content, if any) using the specified edit URL.
void	delete(URI resourceUri, String etag) Deletes an existing entry (and associated media content, if any) using the specified edit URI.
void	delete(URI resourceUri) Deletes an existing entry (and associated media content, if any) using the specified edit URI.
void	endVersionScope()
AltRegistry	getAltRegistry() Returns the alternate registration registry that describes representations that may be parsed from or generated to the remote GData service.
ContentType	getContentType() Returns the default ContentType for data associated with this GData service.
static AltRegistry	getDefaultAltRegistry() Returns an `AltRegistry` instance that is configured with the default parser/generator configuration for a media service.
<E extends IEntry> E	getEntry(URL entryUrl, Class<E> entryClass, String etag) Returns an Atom entry instance given the URL of the entry, if its current entity tag is different than the provided value.
<E extends IEntry> E	getEntry(URL entryUrl, Class<E> entryClass) Returns an Atom entry instance, given the URL of the entry.
<E extends IEntry> E	getEntry(URL entryUrl, Class<E> entryClass, DateTime ifModifiedSince) Returns an Atom entry instance, given the URL of the entry and an if-modified-since date.
ExtensionProfile	getExtensionProfile() Returns the `ExtensionProfile` that defines any expected extensions to the base RSS/Atom content model.
<F extends IFeed> F	getFeed(URL feedUrl, Class<F> feedClass) Returns the Feed associated with a particular feed URL.
<F extends IFeed> F	getFeed(URL feedUrl, Class<F> feedClass, DateTime ifModifiedSince) Returns the Feed associated with a particular feed URL, if it's been modified since the specified date.
<F extends IFeed> F	getFeed(Query query, Class<F> feedClass, DateTime ifModifiedSince) Returns the Feed resulting from executing a query, if it's been modified since the specified date.
<F extends IFeed> F	getFeed(URL feedUrl, Class<F> feedClass, String etag) Returns the Feed associated with a particular feed URL if the entity tag associated with it has changed.
<F extends IFeed> F	getFeed(Query query, Class<F> feedClass) Returns the feed resulting from execution of a query.
<F extends IFeed> F	getFeed(Query query, Class<F> feedClass, String etag) Returns the Feed resulting from query execution, if if the entity tag associated with it has changed.
MetadataRegistry	getMetadataRegistry() Returns the `MetadataRegistry` that defines the expected metadata.
Version	getProtocolVersion() Returns the service protocol version that will be used for requests generated by this service.
Service.GDataRequestFactory	getRequestFactory() Returns the GDataRequestFactory currently associated with the service.
Schema	getSchema() Returns the `Schema` that contains the metadata about element types parsed or generated by this service.
String	getServiceVersion() Returns information about the service version.
InputStream	getStreamFromLink(ILink link) This method is deprecated. Use `createLinkQueryRequest(ILink)` instead.
boolean	getStrictValidation() Returns `true` if strict validation is enabled for this service.
static Version	getVersion() Returns the current `Version` of the GData core protocol.
static Version	initServiceVersion(Class<? extends Service> serviceClass, Version defaultVersion) Initializes the version information for a specific service type.
<E extends IEntry> E	insert(URL feedUrl, E entry) Inserts a new `IEntry` into a feed associated with the target service.
<S extends IServiceDocument> S	introspect(URL feedUrl, Class<S> serviceClass) Returns the Atom introspection Service Document associated with a particular feed URL.
<E> E	parseResponseData(Service.GDataRequest req, Class<E> resultType) Parses the response stream for a request based upon request properties and an expected result type.
<E> E	parseResponseData(ParseSource source, ContentType responseType, Class<E> resultType) Parses the response stream for a request based upon response content type and an expected result type.
<E extends IEntry> E	patch(URL entryUrl, String fields, E entry) Patches an existing `IEntry` by removing a set of selected fields and then merging a partial entry representation into the resource at the specified entry edit URL.
<E extends IEntry> E	patch(URL entryUrl, String fields, E entry, String etag) Patches an existing `IEntry` by removing a set of selected fields and then merging a partial entry representation into the resource at the specified entry edit URL.
<F extends IFeed> F	query(Query query, Class<F> feedClass, String etag) Executes a GData query against the target service and returns the `IFeed` containing entries that match the query result if the etag for the target feed does not match the provided value.
<F extends IFeed> F	query(Query query, Class<F> feedClass, DateTime ifModifiedSince) Executes a GData query against the target service and returns the `IFeed` containing entries that match the query result, if it's been modified since the specified date.
<F extends IFeed> F	query(Query query, Class<F> feedClass) Executes a GData query against the target service and returns the `IFeed` containing entries that match the query result.
void	setAcceptLanguage(String acceptedLanguages) Defines the languages accepted by the application.
void	setAltRegistry(AltRegistry altRegistry)
void	setConnectTimeout(int timeout) Sets the default wait timeout (in milliseconds) for a connection to the remote GData service.
void	setContentType(ContentType contentType) Sets the default ContentType for writing data to the GData service.
void	setExtensionProfile(ExtensionProfile v) Sets the `ExtensionProfile` that defines any expected extensions to the base RSS/Atom content model.
void	setHeader(String header, String value) Set a header that will be included in all requests.
void	setOAuthProxyHeaders(Map<String, String> headers) Adds OAuth Proxy-related headers to the request.
void	setPrivateHeader(String header, String value) Set a header that will be included in all requests and do not log the value.
void	setProtocolVersion(Version v) Sets the service protocol version that will be used for requests associated with this service.
void	setReadTimeout(int timeout) Sets the default wait timeout (in milliseconds) for a response from the remote GData service.
void	setRequestFactory(Service.GDataRequestFactory requestFactory) Sets the GDataRequestFactory currently associated with the service.
void	setStrictValidation(boolean strictValidation) Enables or disables strict validation.
void	setTimeouts(Service.GDataRequest request) Sets timeout value for GDataRequest.
void	startVersionScope()
<E extends IEntry> E	update(URL entryUrl, E entry) Updates an existing `IEntry` by writing it to the specified entry edit URL.
<E extends IEntry> E	update(URL entryUrl, E entry, String etag) Updates an existing `IEntry` by writing it to the specified entry edit URL.
void	useSsl() Sets the HttpGDataRequest.Factory associate with the service to use secure connections.
void	writeRequestData(Service.GDataRequest req, Service.ClientOutputProperties outProps, Object source) Writes the request body to the target service based upon requested output properties and the source object.
void	writeRequestData(Service.GDataRequest req, Object source) Writes the request body to the target service based upon the attributes of the request and the source object.

From class java.lang.Object

From interface com.google.gdata.client.AuthTokenFactory.TokenListener

Constants

public static final String DOCS_SERVICE

The abbreviated name of Google Documents List Data API recognized by Google. The service name is used when requesting an authentication token.

Constant Value: "writely"

Fields

public static final Version DEFAULT_VERSION

Default GData version used by the Google Documents List Data API.

public static final String DOCS_SERVICE_VERSION

The version ID of the service.

Public Constructors

public DocsService (String applicationName)

Constructs an instance connecting to the Google Documents List Data API for an application with the name applicationName.

Parameters

applicationName	The name of the client application accessing the service. Application names should preferably have the format [company-id]-[app-name]-[app-version]. The name will be used by the Google servers to monitor the source of authentication.

public DocsService (String applicationName, Service.GDataRequestFactory requestFactory, AuthTokenFactory authTokenFactory)

Constructs an instance connecting to the Google Documents List Data API for an application with the name applicationName and the given GDataRequestFactory and AuthTokenFactory. Use this constructor to override the default factories.

Parameters

applicationName	The name of the client application accessing the service. Application names should preferably have the format [company-id]-[app-name]-[app-version]. The name will be used by the Google servers to monitor the source of authentication.
requestFactory	The request factory that generates gdata request objects
authTokenFactory	The factory that creates auth tokens

public DocsService (String applicationName, String protocol, String domainName)

Constructs an instance connecting to the Google Documents List Data API with name serviceName for an application with the name applicationName. The service will authenticate at the provided domainName.

Parameters

applicationName	The name of the client application accessing the service. Application names should preferably have the format [company-id]-[app-name]-[app-version]. The name will be used by the Google servers to monitor the source of authentication.
protocol	Name of protocol to use for authentication ("http"/"https")
domainName	The name of the domain hosting the login handler

Public Methods

public void addExtensions ()

Adds the Google Docs extensions.

public void delete (URL aclFeedUrl, AclScope scope)

Deletes an existing AclEntry from the specified feed URL. specified edit URL.

This is a convenience method. It constructs the entry edit URL from the feed URL and scope.

Parameters

aclFeedUrl	The POST URI associated with the target acl feed
scope	The scope of the to-be-deleted acl

Throws

IOException	an ill-formed URI, internal error. See makeEntryUrl
ServiceException	delete request failed due to lack of permissions, unsupported role or scope, system error, etc

public String getServiceVersion ()

Returns information about the service version.

public static Version getVersion ()

Returns the current GData version used by the Google Documents List Data API.

public AclEntry insert (URL aclFeedUrl, AclScope scope, AclRole role)

Inserts a new AclEntry into a feed associated with the target service. It will return the inserted AclEntry, including any additional attributes or extensions set by the GData server.

This is a convenience method. It constructs the AclEntry from the specified AclScope and AclRole.

Parameters

aclFeedUrl	The POST URL associated with the target acl feed
scope	The scope of the new acl
role	The desired role for scope

Returns

the newly inserted AclEntry returned by the service

Throws

IOException	an ill-formed URI, internal error. See makeEntryUrl
ServiceException	insert request failed due to lack of permissions, scope already defined on this feed, unsupported role or scope, system error, etc

public DocumentExportEntry insert (URL exportFeedUrl, List<QueryParameter> params)

Start a new request to download the documents that match all search criteria as a zip file.

Parameters

exportFeedUrl	The POST URL associated with the target export feed.
params	The search criteria.

Returns

the newly inserted DocumentExportEntry returned by the service.

Throws

IOException	an ill-formed URI, internal error.
ServiceException	insert request failed due to lack of permissions, scope already defined on this feed, unsupported role or scope, system error, etc.

public AclEntry update (URL aclFeedUrl, AclScope scope, AclRole role)

Updates an existing AclEntry by writing it to the specified feed URL. The resulting AclEntry (after update) will be returned.

This is a convenience method. It constructs the entry edit URL from the feed URL and scope, and also constructs the AclEntry.

Parameters

aclFeedUrl	The POST URL associated with the target acl feed
scope	The scope of the to-be-updated acl
role	The desired role for scope

Returns

the updated entry returned by the service

Throws

IOException	an ill-formed URI, internal error. See makeEntryUrl
ServiceException	update request failed due to lack of permissions, unsupported role or scope, system error, etc

Classes

DocsService

Class Overview

Summary

Constants

public static final String DOCS_SERVICE

Fields

public static final Version DEFAULT_VERSION

public static final String DOCS_SERVICE_VERSION

Public Constructors

public DocsService (String applicationName)

Parameters

public DocsService (String applicationName, Service.GDataRequestFactory requestFactory, AuthTokenFactory authTokenFactory)

Parameters

public DocsService (String applicationName, String protocol, String domainName)

Parameters

Public Methods

public void addExtensions ()

public void delete (URL aclFeedUrl, AclScope scope)

Parameters

Throws

public String getServiceVersion ()

public static Version getVersion ()

public AclEntry insert (URL aclFeedUrl, AclScope scope, AclRole role)

Parameters

Returns

Throws

public DocumentExportEntry insert (URL exportFeedUrl, List<QueryParameter> params)

Parameters

Returns

Throws

public AclEntry update (URL aclFeedUrl, AclScope scope, AclRole role)

Parameters

Returns

Throws