public class

GoogleBaseService

extends MediaService

java.lang.Object
↳	com.google.gdata.client.Service
	↳	com.google.gdata.client.GoogleService
		↳	com.google.gdata.client.media.MediaService
			↳	com.google.api.gbase.client.GoogleBaseService

Class Overview

Creates a Google data service with extensions specific to Google Base. The methods returning Atom feeds and entries in this class default to returning instances of GoogleBaseFeed and GoogleBaseEntry.

Usage example

 GoogleBaseService service = new GoogleBaseService("mycompany-myapp-1.0");
 service.setUserCredentials(username, password);
 GoogleBaseQuery query = new GoogleBaseQuery(...);
 query.setGoogleBaseQuery(...);
 GoogleBaseFeed feed = service.query(query);

Summary

Nested Classes
class	GoogleBaseService.Versions	The Versions class contains all released versions of the Google Base API

Constants
String	GOOGLE_BASE_SERVICE	The official name of the service.

[Expand]

Inherited Constants

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

Fields
public static final Version	DEFAULT_VERSION	Version 1 is the current default version for GoogleBaseService.
public static final String	GOOGLE_BASE_SERVICE_VERSION	Version of this service.
protected String	application	Name of the application passed to the constructor.

[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
	GoogleBaseService(String applicationName) Creates a GoogleBaseService connecting to the default authentication domain (www.google.com) using the HTTPS.
	GoogleBaseService(String applicationName, String developerKey) Creates a GoogleBaseService connecting to the default authentication domain (www.google.com) using the HTTPS.
	GoogleBaseService(String applicationName, String protocol, String domainName) Creates a GoogleBaseService connecting to a specific authentication domain using a specific protocol.
	GoogleBaseService(String applicationName, String developerKey, String protocol, String domainName) Creates a GoogleBaseService connecting to a specific authentication domain using a specific protocol.

Public Methods
<F extends IFeed> F	batch(URL url, F f) Executes several operations (insert, update or delete) on the entries that are part of the input `IFeed`.
GoogleBaseEntry	getEntry(URL entryUrl) Returns an Google Base entry instance, given the URL of the entry.
GoogleBaseEntry	getEntry(URL entryUrl, DateTime ifModifiedSince) Returns an Google Base entry instance, given the URL of the entry and an if-modified-since date.
GoogleBaseFeed	getFeed(URL feedUrl) Returns the Google base feed associated with a particular feed URL.
GoogleBaseFeed	getFeed(URL feedUrl, DateTime ifModifiedSince) Returns the Google Base feed associated with a particular feed URL, if it's been modified since the specified date.
GoogleBaseMediaEntry	getMediaEntry(URL entryUrl, DateTime ifModifiedSince) Returns the media entry referenced by the entryUrl, if it's been modified since the specified date.
GoogleBaseMediaEntry	getMediaEntry(URL entryUrl) Returns the media entry referenced by the entryUrl.
GoogleBaseMediaFeed	getMediaFeed(URL feedUrl, DateTime ifModifiedSince) Returns the Google Base media feed associated with a particular feed URL, if it's been modified since the specified date.
GoogleBaseMediaFeed	getMediaFeed(URL feedUrl) Returns the Google base media feed associated with the specified feed URL.
String	getServiceVersion() Returns the google base service version followed by the gdata service version.
<E extends IEntry> E	insert(URL url, E e) Inserts a new `Entry` into a feed associated with the target service.
GoogleBaseFeed	query(Query query) Executes a GData query against the target service and returns the `Feed` containing entries that match the query result.
GoogleBaseFeed	query(Query query, DateTime ifModifiedSince) Executes a GData query against the target service and returns the `GoogleBaseFeed` containing entries that match the query result, if it's been modified since the specified date.
<E extends IEntry> E	update(URL url, E e) Updates an existing entry metadata by writing it to the specified edit 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 GOOGLE_BASE_SERVICE

The official name of the service.

Constant Value: "gbase"

Fields

public static final Version DEFAULT_VERSION

Version 1 is the current default version for GoogleBaseService.

public static final String GOOGLE_BASE_SERVICE_VERSION

Version of this service.

protected String application

Name of the application passed to the constructor.

Public Constructors

public GoogleBaseService (String applicationName)

Creates a GoogleBaseService connecting to the default authentication domain (www.google.com) using the HTTPS.

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 GoogleBaseService (String applicationName, String developerKey)

Creates a GoogleBaseService connecting to the default authentication domain (www.google.com) using the HTTPS.

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.
developerKey	Developer key (ignored)

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

Creates a GoogleBaseService connecting to a specific authentication domain using a specific protocol.

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 GoogleBaseService (String applicationName, String developerKey, String protocol, String domainName)

Creates a GoogleBaseService connecting to a specific authentication domain using a specific protocol.

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.
developerKey	Developer key (ignored)
protocol	Name of protocol to use for authentication ("http"/"https")
domainName	The name of the domain hosting the login handler

Public Methods

public F batch (URL url, F f)

Executes several operations (insert, update or delete) on the entries that are part of the input IFeed. It will return another feed that describes what was done while executing these operations. It is possible for one batch operation to fail even though other operations have worked, so this method won't throw a ServiceException unless something really wrong is going on. You need to check the entries in the returned feed to know which operations succeeded and which operations failed (see BatchStatus and BatchInterrupted extensions.)

Parameters

url	The POST URI associated with the target feed.
f	A description of the operations to execute, described using tags in the batch: namespace

Returns

a feed with the result of each operation in a separate entry

Throws

IOException
ServiceException
BatchInterruptedException

public GoogleBaseEntry getEntry (URL entryUrl)

Returns an Google Base entry instance, given the URL of the entry.

Parameters

entryUrl	Resource URL for the entry.

Returns

the entry referenced by the URL parameter.

Throws

IOException	error communicating with the GData service.
ParseException	error parsing the returned entry.
ResourceNotFoundException	if the entry URL is not valid.
ServiceForbiddenException	if the GData service cannot get the entry resource due to access constraints.
ServiceException	if a system error occurred when retrieving the entry.

public GoogleBaseEntry getEntry (URL entryUrl, DateTime ifModifiedSince)

Returns an Google Base entry instance, given the URL of the entry and an if-modified-since date.

Parameters

entryUrl	Resource URL for the entry.
ifModifiedSince	Used to set a precondition date that indicates the entry should be returned only if it has been modified after the specified date. A value of `null` indicates no precondition.

Returns

the entry referenced by the URL parameter.

Throws

IOException	error communicating with the GData service.
NotModifiedException	if the entry resource has not been modified after the specified precondition date.
ParseException	error parsing the returned entry.
ResourceNotFoundException	if the entry URL is not valid.
ServiceForbiddenException	if the GData service cannot get the entry resource due to access constraints.
ServiceException	if a system error occurred when retrieving the entry.

public GoogleBaseFeed getFeed (URL feedUrl)

Returns the Google base feed associated with a particular feed URL.

Parameters

feedUrl	The URL associated with a feed. This URL can include GData query parameters.

Returns

Feed resource referenced by the input URL.

Throws

IOException	error sending request or reading the feed.
ParseException	error parsing the returned feed data.
ResourceNotFoundException	invalid feed URL.
ServiceException	system error retrieving feed.

public GoogleBaseFeed getFeed (URL feedUrl, DateTime ifModifiedSince)

Returns the Google Base feed associated with a particular feed URL, if it's been modified since the specified date.

Parameters

feedUrl	The URL associated with a feed. This URL can include GData query parameters.
ifModifiedSince	Used to set a precondition date that indicates the feed should be returned only if it has been modified after the specified date. A value of `null` indicates no precondition.

Returns

Feed resource referenced by the input URL.

Throws

IOException	error sending request or reading the feed.
NotModifiedException	if the feed resource has not been modified since the specified precondition date.
ParseException	error parsing the returned feed data.
ResourceNotFoundException	invalid feed URL.
ServiceException	system error retrieving feed.

public GoogleBaseMediaEntry getMediaEntry (URL entryUrl, DateTime ifModifiedSince)

Returns the media entry referenced by the entryUrl, if it's been modified since the specified date.

Parameters

entryUrl	The url to the media entry.
ifModifiedSince

Returns

a media entry object representing the meta-data for the referenced media object (item image or attachment).

Throws

IOException	error communicating with the GData service.
NotModifiedException	if the entry resource has not been modified after the specified precondition date.
ParseException	error parsing the returned entry.
ResourceNotFoundException	if the entry URL is not valid.
ServiceForbiddenException	if the GData service cannot get the entry resource due to access constraints.
ServiceException	if a system error occurred when retrieving the entry

public GoogleBaseMediaEntry getMediaEntry (URL entryUrl)

Returns the media entry referenced by the entryUrl. If the URL is not pointing to a media entry, an exception will be thrown.

Parameters

entryUrl	The url to the media entry.

Returns

a media entry object representing the meta-data for the referenced media object (item image or attachment).

Throws

IOException	error communicating with the GData service.
ParseException	error parsing the returned entry.
ResourceNotFoundException	if the entry URL is not valid.
ServiceForbiddenException	if the GData service cannot get the entry resource due to access constraints.
ServiceException	if a system error occurred when retrieving the entry

public GoogleBaseMediaFeed getMediaFeed (URL feedUrl, DateTime ifModifiedSince)

Returns the Google Base media feed associated with a particular feed URL, if it's been modified since the specified date.

Parameters

feedUrl	The URL associated with a media feed for one particular item.
ifModifiedSince	Used to set a precondition date that indicates the feed should be returned only if it has been modified after the specified date. A value of `null` indicates no precondition.

Returns

Feed resource referenced by the input URL.

Throws

IOException	error sending request or reading the feed.
NotModifiedException	if the feed resource has not been modified since the specified precondition date.
ParseException	error parsing the returned feed data.
ResourceNotFoundException	invalid feed URL.
ServiceException	system error retrieving feed.

public GoogleBaseMediaFeed getMediaFeed (URL feedUrl)

Returns the Google base media feed associated with the specified feed URL. For the call to be valid, the user must be authenticated and own the item. The Google Base item has the link to its media feed registered as a FeedLink extension with the media relation.

Parameters

feedUrl

Throws

IOException	error sending request or reading the feed.
ParseException	error parsing the returned feed data.
ResourceNotFoundException	invalid feed URL.
ServiceException	system error retrieving feed.

public String getServiceVersion ()

Returns the google base service version followed by the gdata service version.

Returns

both versions, separated by a space

public E insert (URL url, E e)

Inserts a new Entry into a feed associated with the target service. It will return the inserted Entry, including any additional attributes or extensions set by the GData server. If the Entry has been associated with a MediaSource through the setMediaSource(MediaSource) method then both the entry and the media resource will be inserted into the media feed associated with the target service. If the media source has a name (getName() that is non-null), the name will be provided as a Slug header that is sent along with request and may be used as a hint when determining the ID, url, and/or title of the inserted resource.

To insert only media content, use insert(URL, Class, MediaSource).

Parameters

url	The POST URI associated with the target feed.
e	The new entry to insert into the feed.

Returns

the newly inserted Entry returned by the service.

Throws

IOException
ServiceException

public GoogleBaseFeed query (Query query)

Executes a GData query against the target service and returns the Feed containing entries that match the query result.

Parameters

query	Query instance defining target feed and query parameters, usually a `GoogleBaseQuery`

Throws

IOException	error communicating with the GData service.
NotModifiedException	if the query resource does not contain entries modified since the specified precondition date.
ServiceForbiddenException	feed does not support the query.
ParseException	error parsing the returned feed data.
ServiceException	query request failed.

public GoogleBaseFeed query (Query query, DateTime ifModifiedSince)

Executes a GData query against the target service and returns the GoogleBaseFeed containing entries that match the query result, if it's been modified since the specified date.

Parameters

query	Query instance defining target feed and query parameters, usually a `GoogleBaseQuery`
ifModifiedSince	Used to set a precondition date that indicates the query result feed should be returned only if contains entries that have been modified after the specified date. A value of `null` indicates no precondition.

Throws

IOException	error communicating with the GData service.
NotModifiedException	if the query resource does not contain entries modified since the specified precondition date.
ServiceForbiddenException	feed does not support the query.
ParseException	error parsing the returned feed data.
ServiceException	query request failed.

public E update (URL url, E e)

Updates an existing entry metadata by writing it to the specified edit URL. The resulting entry (after update) will be returned. If the entry has media resource, the media part will not be updated. To update both metadata and media, use updateMedia(URL, IEntry). To update media only, use updateMedia(URL, Class, MediaSource).

Parameters

url	The media edit URL associated with the resource.
e	The updated entry to be written to the server.

Returns

the updated entry returned by the service.

Throws

IOException
ServiceException

Classes

Enums

GoogleBaseService

Class Overview

Usage example

GoogleBaseService service = new GoogleBaseService("mycompany-myapp-1.0"); service.setUserCredentials(username, password); GoogleBaseQuery query = new GoogleBaseQuery(...); query.setGoogleBaseQuery(...); GoogleBaseFeed feed = service.query(query);

Summary

Constants

public static final String GOOGLE_BASE_SERVICE

Fields

public static final Version DEFAULT_VERSION

public static final String GOOGLE_BASE_SERVICE_VERSION

See Also

protected String application

Public Constructors

public GoogleBaseService (String applicationName)

Parameters

public GoogleBaseService (String applicationName, String developerKey)

Parameters

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

Parameters

public GoogleBaseService (String applicationName, String developerKey, String protocol, String domainName)

Parameters

Public Methods

public F batch (URL url, F f)

Parameters

Returns

Throws

public GoogleBaseEntry getEntry (URL entryUrl)

Parameters

Returns

Throws

See Also

public GoogleBaseEntry getEntry (URL entryUrl, DateTime ifModifiedSince)

Parameters

Returns

Throws

See Also

public GoogleBaseFeed getFeed (URL feedUrl)

Parameters

Returns

Throws

See Also

public GoogleBaseFeed getFeed (URL feedUrl, DateTime ifModifiedSince)

Parameters

Returns

Throws

See Also

public GoogleBaseMediaEntry getMediaEntry (URL entryUrl, DateTime ifModifiedSince)

Parameters

Returns

Throws

public GoogleBaseMediaEntry getMediaEntry (URL entryUrl)

Parameters

Returns

Throws

public GoogleBaseMediaFeed getMediaFeed (URL feedUrl, DateTime ifModifiedSince)

Parameters

Returns

Throws

See Also

public GoogleBaseMediaFeed getMediaFeed (URL feedUrl)

Parameters

Throws

See Also

public String getServiceVersion ()

Returns

See Also

public E insert (URL url, E e)

Parameters

Returns

Throws

public GoogleBaseFeed query (Query query)

Parameters

Throws

public GoogleBaseFeed query (Query query, DateTime ifModifiedSince)

Parameters

Throws

See Also

public E update (URL url, E e)