public abstract class

AppsForYourDomainService

extends GoogleService

java.lang.Object
↳	com.google.gdata.client.Service
	↳	com.google.gdata.client.GoogleService
		↳	com.google.gdata.client.appsforyourdomain.AppsForYourDomainService

Known Direct Subclasses

AppsPropertyService, EmailListRecipientService, EmailListService, GmailFilterService, NicknameService, UserService

Known Indirect Subclasses

AppsGroupsService, AuditService, DomainSettingsService, DomainVerificationService, EmailManagementService, SingleSignOnService

Class Overview

The AppsForYourDomainService class extends the basic GoogleService abstraction to define a service that is preconfigured for access to the Google Apps for Your Domain GData API.

Summary

Constants
String	APPS_SERVICE	The abbreviated name of Apps for Your Domain recognized by Google.
String	DOMAIN_NAME	The domain which hosts the the authentication.
String	HTTPS_PROTOCOL	The protocol used to obtain authentication tokens.

[Expand]

Inherited Fields

From class com.google.gdata.client.GoogleService

From class com.google.gdata.client.Service

Public Constructors
	AppsForYourDomainService(String applicationName) Constructs a AppsForYourDomainService instance for an application with the name `applicationName`.
	AppsForYourDomainService(String applicationName, String protocol, String domainName) Constructs a GoogleService instance connecting to the service with name `serviceName` for an application with the name `applicationName`.

Public Methods
void	delete(URL entryUrl) Deletes an existing entry (and associated media content, if any) using the specified edit URL.
<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.
<E extends IEntry> E	getEntry(URL entryUrl, Class<E> entryClass) The call to super.getEntry should fall through to Service and the behaviour is unknown if this method is overloaded in GoogleService.
<F extends IFeed> F	getFeed(URL feedUrl, 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	getFeed(URL feedUrl, Class<F> feedClass) The call to super.getEntry should fall through to Service and the behaviour is unknown if this method is overloaded in GoogleService.
<E extends IEntry> E	insert(URL feedUrl, E entry) Inserts a new `IEntry` into a feed associated with the target service.
<F extends IFeed> F	query(Query query, Class<F> feedClass) The call to super.getEntry should fall through to Service and the behaviour is unknown if this method is overloaded in GoogleService.
<E extends IEntry> E	update(URL entryUrl, E entry) Updates an existing `IEntry` by writing it to the specified entry edit URL.

Protected Methods
<E extends IEntry, F extends IFeed> List<E>	getAllPages(URL feedUrl, Class<F> feedClass) Executes a GData query against the target service and returns a List containing all the `IEntry` that match the query result.

[Expand]

Inherited Methods

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 APPS_SERVICE

The abbreviated name of Apps for Your Domain recognized by Google. The service name is used while requesting an authentication token.

Constant Value: "apps"

public static final String DOMAIN_NAME

The domain which hosts the the authentication.

Constant Value: "www.google.com"

public static final String HTTPS_PROTOCOL

The protocol used to obtain authentication tokens.

Constant Value: "https"

Public Constructors

public AppsForYourDomainService (String applicationName)

Constructs a AppsForYourDomainService instance 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 AppsForYourDomainService (String applicationName, String protocol, String domainName)

Constructs a GoogleService instance connecting to the service 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 delete (URL entryUrl)

Deletes an existing entry (and associated media content, if any) using the specified edit URL.

Parameters

entryUrl	The edit or medit edit url associated with the resource.

Throws

AppsForYourDomainException	If an Apps for Your Domain API error occurred.
IOException
ServiceException

public 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. Note that this method is overriden to prevent the usage of a non-null if-modified-since value. The Google Apps for Your Domain Provisioning API does not support the use of the if-modified-since value.

Parameters

entryUrl	Resource URL for the entry.
entryClass	Class used to represent service entries.
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 E getEntry (URL entryUrl, Class<E> entryClass)

The call to super.getEntry should fall through to Service and the behaviour is unknown if this method is overloaded in GoogleService.

Parameters

entryUrl	Resource URL for the entry.
entryClass	Class used to represent service entries, not `null`.

Returns

the entry referenced by the URL parameter.

Throws

AppsForYourDomainException	If an Apps for Your Domain API error occurred.
IOException
ServiceException

public F getFeed (URL feedUrl, 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. Note that this method is overridden to prevent the usage of a non-null if-modified-since value. The Google Apps for Your Domain Provisioning API does not support the use of the if-modified-since value.

Parameters

feedUrl	The URL associated with a feed. This URL can include GData query parameters.
feedClass	The Class used to represent a service Feed.
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.

Returns

Feed resource referenced by the input URL.

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 F getFeed (URL feedUrl, Class<F> feedClass)

The call to super.getEntry should fall through to Service and the behaviour is unknown if this method is overloaded in GoogleService.

Parameters

feedUrl	The URL associated with a feed. This URL can include GData query parameters.
feedClass	The class used to represent a service Feed.

Returns

Feed resource referenced by the input URL.

Throws

AppsForYourDomainException	If an Apps for Your Domain API error occurred.
IOException
ServiceException

public E insert (URL feedUrl, E entry)

Inserts a new IEntry 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.

Parameters

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

Returns

the newly inserted Entry returned by the service.

Throws

AppsForYourDomainException	If an Apps for Your Domain API error occurred.
IOException
ServiceException

public F query (Query query, Class<F> feedClass)

The call to super.getEntry should fall through to Service and the behaviour is unknown if this method is overloaded in GoogleService.

Parameters

query	Query instance defining target feed and query parameters.
feedClass	The Class used to represent a service Feed, not `null`.

Throws

AppsForYourDomainException	If an Apps for Your Domain API error occurred.
IOException
ServiceException

public E update (URL entryUrl, E entry)

Updates an existing IEntry by writing it to the specified entry edit URL. The resulting Entry (after update) will be returned.

Parameters

entryUrl	The edit URL associated with the entry.
entry	The modified Entry to be written to the server.

Returns

the updated Entry returned by the service.

Throws

AppsForYourDomainException	If an Apps for Your Domain API error occurred.
IOException
ServiceException

Protected Methods

protected List<E> getAllPages (URL feedUrl, Class<F> feedClass)

Executes a GData query against the target service and returns a List containing all the IEntry that match the query result. This method will page through the feed and return all matching records to the client. Should be only used by services that have paged resultsets.

Please note that this method may take a very long time to execute for feeds with thousands of entries.

Parameters

feedUrl	Resource URL of the feed
feedClass	Class used to represent service entries

Returns

List of IEntry

Throws

IOException	error communicating with the GData service
ServiceForbiddenException	feed does not support the query.
ParseException	error parsing the returned feed data.
ServiceException	query request failed.

Classes

AppsForYourDomainService

Class Overview

Summary

Constants

public static final String APPS_SERVICE

public static final String DOMAIN_NAME

public static final String HTTPS_PROTOCOL

Public Constructors

public AppsForYourDomainService (String applicationName)

Parameters

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

Parameters

Public Methods

public void delete (URL entryUrl)

Parameters

Throws

public E getEntry (URL entryUrl, Class<E> entryClass, DateTime ifModifiedSince)

Parameters

Returns

Throws

public E getEntry (URL entryUrl, Class<E> entryClass)

Parameters

Returns

Throws

public F getFeed (URL feedUrl, Class<F> feedClass, DateTime ifModifiedSince)

Parameters

Returns

Throws

public F getFeed (URL feedUrl, Class<F> feedClass)

Parameters

Returns

Throws

public E insert (URL feedUrl, E entry)

Parameters

Returns

Throws

public F query (Query query, Class<F> feedClass)

Parameters

Throws

public E update (URL entryUrl, E entry)

Parameters

Returns

Throws

Protected Methods

protected List<E> getAllPages (URL feedUrl, Class<F> feedClass)

Parameters

Returns

Throws