public class DomainSettingsService extends AppsPropertyService
AppsPropertyService for managing general, account
related and appearance settings of a domain.GoogleService.AccountDeletedException, GoogleService.AccountDisabledException, GoogleService.CaptchaRequiredException, GoogleService.InvalidCredentialsException, GoogleService.NotVerifiedException, GoogleService.ServiceUnavailableException, GoogleService.SessionExpiredException, GoogleService.TermsNotAgreedExceptionService.ClientInputProperties, Service.ClientOutputProperties, Service.ClientStreamProperties, Service.GDataRequest, Service.GDataRequestFactory, Service.Versions| Modifier and Type | Field and Description |
|---|---|
protected String |
accountSettingsUrl |
protected String |
appearanceUrl |
protected String |
domainBaseUrl |
protected String |
generalSettingsUrl
Base URL for various feeds.
|
APPS_SERVICE, DOMAIN_NAME, HTTPS_PROTOCOLconnectTimeout, extProfile, metadataRegistry, requestFactory| Constructor and Description |
|---|
DomainSettingsService(String domain,
String applicationName)
Parameterized constructor to setup a Service object which can be used to
initialize the service without obtaining a token.
|
DomainSettingsService(String adminUser,
String adminPassword,
String domain,
String applicationName)
Parameterized constructor for service authentication.
|
| Modifier and Type | Method and Description |
|---|---|
String |
getCountryCodeForDomain()
Retrieves the country code for the domain registered.
|
String |
getCustomerPIN()
Retrieves Customer PIN associated with the domain.
|
String |
getDefaultLanguage()
Retrieves the default language for the Google Apps domain
|
String |
getDomainCreationTime()
Gets the time domain was created.
|
String |
getDomainEdition()
Retrieves the domain edition.
|
String |
getDomainSecondaryEmailAddress()
Retrieves the secondary Email address registered with the domain
|
String |
getDomainVerificationStatus()
Retrieves the status of verification for the domain.
|
int |
getMaxUserCount()
Retrieves the maximum number of users that can be created in the domain
|
String |
getOrganizationName()
Retrieves the organization name associated with the domain
|
String |
getSupportPIN()
Retrieves the Support PIN for the domain.
|
GenericEntry |
setDefaultLanguage(String language)
Sets the default language for Google Apps domain.
|
GenericEntry |
setDomainLogo(String base64EncodedImage)
Updates the custom logo with the new image provided.
|
GenericEntry |
setDomainSecondaryEmailAddress(String adminSecondaryEmail)
Registers the given Email as domain's secondary Email address
|
GenericEntry |
setOrganizationName(String organizationName)
Set the organization name for the domain
|
delete, getAllPages, getEntry, getEntry, getFeed, getFeed, insert, query, updateaddCookie, batch, createRequest, createRequest, delete, getAuthToken, getAuthTokenFactory, getCookieManager, getCookies, getEntry, getFeed, getFeed, getFeed, handleRedirectException, handlesCookies, handleSessionExpiredException, makePostRequest, setAuthSubToken, setAuthSubToken, setAuthTokenFactory, setCookieManager, setHandlesCookies, setOAuth2Credentials, setOAuthCredentials, setUserCredentials, setUserCredentials, setUserCredentials, setUserCredentials, setUserToken, tokenChangedclassOf, createBatchRequest, createDeleteRequest, createEntryRequest, createFeedRequest, createFeedRequest, createInsertRequest, createLinkQueryRequest, createPatchRequest, createUpdateRequest, delete, delete, endVersionScope, getAltRegistry, getContentType, getDefaultAltRegistry, getExtensionProfile, getFeed, getMetadataRegistry, getProtocolVersion, getRequestFactory, getSchema, getServiceVersion, getStreamFromLink, getStrictValidation, getVersion, initServiceVersion, introspect, parseResponseData, parseResponseData, patch, patch, query, query, setAcceptLanguage, setAltRegistry, setConnectTimeout, setContentType, setExtensionProfile, setHeader, setOAuthProxyHeaders, setPrivateHeader, setProtocolVersion, setReadTimeout, setRequestFactory, setStrictValidation, setTimeouts, startVersionScope, update, useSsl, writeRequestData, writeRequestDataprotected String generalSettingsUrl
protected String domainBaseUrl
protected String appearanceUrl
protected String accountSettingsUrl
public DomainSettingsService(String domain, String applicationName)
setUserCredentials or setUserToken when using this constructor.domain - Domain being configuredapplicationName - Application name consuming the APIpublic DomainSettingsService(String adminUser, String adminPassword, String domain, String applicationName) throws AuthenticationException
adminUser - the email id of the administrator.adminPassword - the administrator password.domain - the domain name to be configured.applicationName - the calling client application name.for e.g.
mycompany-javaAuthenticationException - if an authentication related error occurs.public GenericEntry setDefaultLanguage(String language) throws AppsForYourDomainException, IOException, ServiceException
language - AppsForYourDomainException - if an Apps for your domain API error
occurred.IOException - if an error occurs while communicating with the GData
service.ServiceException - if the update request failed due to system error.public String getDefaultLanguage() throws AppsForYourDomainException, IOException, ServiceException
AppsForYourDomainException - if an Apps for your domain API error
occurred.IOException - if an error occurs while communicating with the GData
service.ServiceException - if the fetch request failed due to system error.public GenericEntry setOrganizationName(String organizationName) throws AppsForYourDomainException, IOException, ServiceException
organizationName - The name of the organization associated with the
domainIOException - if an error occurs while communicating with the GData
service.ServiceException - if the update request failed due to system error.AppsForYourDomainException - if an Apps for your domain API error
occurred.public String getOrganizationName() throws AppsForYourDomainException, MalformedURLException, IOException, ServiceException
IOException - if an error occurs while communicating with the GData
service.MalformedURLException - if the feed URL cannot be constructed.ServiceException - if the fetch request failed due to system error.AppsForYourDomainException - if an Apps for your domain API error
occurred.public int getMaxUserCount()
throws AppsForYourDomainException,
MalformedURLException,
IOException,
ServiceException
IOException - if an error occurs while communicating with the GData
service.MalformedURLException - if the feed URL cannot be constructed.ServiceException - if the fetch request failed due to system error.AppsForYourDomainException - if an Apps for your domain API error
occurred.public String getDomainVerificationStatus() throws AppsForYourDomainException, MalformedURLException, IOException, ServiceException
IOException - if an error occurs while communicating with the GData
service.MalformedURLException - if the feed URL cannot be constructed.ServiceException - if the fetch request failed due to system error.AppsForYourDomainException - if an Apps for your domain API error
occurred.public String getSupportPIN() throws AppsForYourDomainException, MalformedURLException, IOException, ServiceException
IOException - if an error occurs while communicating with the GData
service.MalformedURLException - if the feed URL cannot be constructed.ServiceException - if the fetch request failed due to system error.AppsForYourDomainException - if an Apps for your domain API error
occurred.public String getDomainEdition() throws AppsForYourDomainException, MalformedURLException, IOException, ServiceException
IOException - if an error occurs while communicating with the GData
service.MalformedURLException - if the feed URL cannot be constructed.ServiceException - if the fetch request failed due to system error.AppsForYourDomainException - if an Apps for your domain API error
occurred.public String getCustomerPIN() throws AppsForYourDomainException, MalformedURLException, IOException, ServiceException
IOException - if an error occurs while communicating with the GData
service.MalformedURLException - if the feed URL cannot be constructed.ServiceException - if the fetch request failed due to system error.AppsForYourDomainException - if an Apps for your domain API error
occurred.public String getDomainCreationTime() throws AppsForYourDomainException, MalformedURLException, IOException, ServiceException
IOException - if an error occurs while communicating with the GData
service.MalformedURLException - if the feed URL cannot be constructed.ServiceException - if the fetch request failed due to system error.AppsForYourDomainException - if an Apps for your domain API error
occurred.public String getCountryCodeForDomain() throws AppsForYourDomainException, MalformedURLException, IOException, ServiceException
IOException - if an error occurs while communicating with the GData
service.MalformedURLException - if the feed URL cannot be constructed.ServiceException - if the fetch request failed due to system error.AppsForYourDomainException - if an Apps for your domain API error
occurred.public String getDomainSecondaryEmailAddress() throws AppsForYourDomainException, MalformedURLException, IOException, ServiceException
IOException - if an error occurs while communicating with the GData
service.MalformedURLException - if the feed URL cannot be constructed.ServiceException - if the fetch request failed due to system error.AppsForYourDomainException - if an Apps for your domain API error
occurred.public GenericEntry setDomainSecondaryEmailAddress(String adminSecondaryEmail) throws AppsForYourDomainException, IOException, ServiceException
adminSecondaryEmail - Email addressIOException - if an error occurs while communicating with the GData
service.ServiceException - if the fetch request failed due to system error.AppsForYourDomainException - if an Apps for your domain API error
occurredpublic GenericEntry setDomainLogo(String base64EncodedImage) throws IOException, AppsForYourDomainException, ServiceException
base64EncodedImage - image file in base64 encoding.IOException - if an error occurs while communicating with the GData
service.ServiceException - if the fetch request failed due to system error.AppsForYourDomainException - if an Apps for your domain API error
occurredCopyright © 2012. All Rights Reserved.