Google Data APIs Client Library (1.38.0)

com.google.gdata.client.sites
Class SitesService

java.lang.Object
  com.google.gdata.client.Service
      com.google.gdata.client.GoogleService
          com.google.gdata.client.media.MediaService
              com.google.gdata.client.sites.SitesService

All Implemented Interfaces:

AuthTokenFactory.TokenListener

public class SitesService
extends MediaService

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

Nested Class Summary

static class

SitesService.Versions GData versions supported by the Google Sites Data API.

Nested classes/interfaces inherited from class com.google.gdata.client.GoogleService

GoogleService.AccountDeletedException, GoogleService.AccountDisabledException, GoogleService.CaptchaRequiredException, GoogleService.InvalidCredentialsException, GoogleService.NotVerifiedException, GoogleService.ServiceUnavailableException, GoogleService.SessionExpiredException, GoogleService.TermsNotAgreedException

Nested classes/interfaces inherited from class com.google.gdata.client.Service

Service.ClientInputProperties, Service.ClientOutputProperties, Service.ClientStreamProperties, Service.GDataRequest, Service.GDataRequestFactory

Field Summary

static Version	DEFAULT_VERSION Default GData version used by the Google Sites Data API.
static java.lang.String	SITES_SERVICE The abbreviated name of Google Sites Data API recognized by Google.
static java.lang.String	SITES_SERVICE_VERSION The version ID of the service.

Fields inherited from class com.google.gdata.client.media.MediaService

DEFAULT_CHUNKED_BUFFER_SIZE, NO_CHUNKED_MEDIA_REQUEST

Fields inherited from class com.google.gdata.client.Service

connectTimeout, extProfile, metadataRegistry, requestFactory

Constructor Summary

SitesService(java.lang.String applicationName)
Constructs an instance connecting to the Google Sites Data API for an application with the name applicationName.

SitesService(java.lang.String applicationName, Service.GDataRequestFactory requestFactory, AuthTokenFactory authTokenFactory)
Constructs an instance connecting to the Google Sites Data API for an application with the name applicationName and the given GDataRequestFactory and AuthTokenFactory.

SitesService(java.lang.String applicationName, java.lang.String protocol, java.lang.String domainName)
Constructs an instance connecting to the Google Sites Data API with name serviceName for an application with the name applicationName.

Method Summary

java.lang.String	getServiceVersion() Returns information about the service version.
static Version	getVersion() Returns the current GData version used by the Google Sites Data API.

Methods inherited from class com.google.gdata.client.media.MediaService

getDefaultAltRegistry, getMedia, getMedia, insert, insert, setChunkedMediaUpload, updateMedia, updateMedia

Methods inherited from class com.google.gdata.client.GoogleService

addCookie, batch, createRequest, createRequest, delete, delete, getAuthToken, getAuthTokenFactory, getCookieManager, getCookies, getEntry, getEntry, getFeed, getFeed, getFeed, getFeed, handleRedirectException, handlesCookies, handleSessionExpiredException, makePostRequest, setAuthSubToken, setAuthSubToken, setAuthTokenFactory, setCookieManager, setHandlesCookies, setOAuthCredentials, setUserCredentials, setUserCredentials, setUserCredentials, setUserCredentials, setUserToken, tokenChanged, update

Methods inherited from class com.google.gdata.client.Service

classOf, createBatchRequest, createDeleteRequest, createEntryRequest, createFeedRequest, createFeedRequest, createInsertRequest, createLinkQueryRequest, createUpdateRequest, delete, delete, endVersionScope, getAltRegistry, getContentType, getEntry, getExtensionProfile, getFeed, getFeed, getMetadataRegistry, getProtocolVersion, getRequestFactory, getSchema, getStreamFromLink, initServiceVersion, introspect, parseResponseData, query, query, query, setAcceptLanguage, setAltRegistry, setConnectTimeout, setContentType, setExtensionProfile, setProtocolVersion, setReadTimeout, setRequestFactory, setTimeouts, startVersionScope, update, useSsl, writeRequestData

Methods inherited from class java.lang.Object

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

Field Detail

SITES_SERVICE

public static final java.lang.String SITES_SERVICE

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

See Also:

Constant Field Values

SITES_SERVICE_VERSION

public static final java.lang.String SITES_SERVICE_VERSION

The version ID of the service.

DEFAULT_VERSION

public static final Version DEFAULT_VERSION

Default GData version used by the Google Sites Data API.

Constructor Detail

SitesService

public SitesService(java.lang.String applicationName)

Constructs an instance connecting to the Google Sites 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.

SitesService

public SitesService(java.lang.String applicationName,
                    Service.GDataRequestFactory requestFactory,
                    AuthTokenFactory authTokenFactory)

Constructs an instance connecting to the Google Sites 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

SitesService

public SitesService(java.lang.String applicationName,
                    java.lang.String protocol,
                    java.lang.String domainName)

Constructs an instance connecting to the Google Sites 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

Method Detail

getServiceVersion

public java.lang.String getServiceVersion()

Description copied from class: Service

Returns information about the service version.

Overrides:

getServiceVersion in class Service

getVersion

public static Version getVersion()

Returns the current GData version used by the Google Sites Data API.