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.TermsNotAgreedException
Service.ClientInputProperties, Service.ClientOutputProperties, Service.ClientStreamProperties, Service.GDataRequest, Service.GDataRequestFactory, Service.Versions
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
accountSettingsUrl |
protected java.lang.String |
appearanceUrl |
protected java.lang.String |
domainBaseUrl |
protected java.lang.String |
generalSettingsUrl
Base URL for various feeds.
|
APPS_SERVICE, DOMAIN_NAME, HTTPS_PROTOCOL
connectTimeout, extProfile, metadataRegistry, requestFactory
Constructor and Description |
---|
DomainSettingsService(java.lang.String domain,
java.lang.String applicationName)
Parameterized constructor to setup a Service object which can be used to
initialize the service without obtaining a token.
|
DomainSettingsService(java.lang.String adminUser,
java.lang.String adminPassword,
java.lang.String domain,
java.lang.String applicationName)
Parameterized constructor for service authentication.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCountryCodeForDomain()
Retrieves the country code for the domain registered.
|
java.lang.String |
getCustomerPIN()
Retrieves Customer PIN associated with the domain.
|
java.lang.String |
getDefaultLanguage()
Retrieves the default language for the Google Apps domain
|
java.lang.String |
getDomainCreationTime()
Gets the time domain was created.
|
java.lang.String |
getDomainEdition()
Retrieves the domain edition.
|
java.lang.String |
getDomainSecondaryEmailAddress()
Retrieves the secondary Email address registered with the domain
|
java.lang.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
|
java.lang.String |
getOrganizationName()
Retrieves the organization name associated with the domain
|
java.lang.String |
getSupportPIN()
Retrieves the Support PIN for the domain.
|
GenericEntry |
setDefaultLanguage(java.lang.String language)
Sets the default language for Google Apps domain.
|
GenericEntry |
setDomainLogo(java.lang.String base64EncodedImage)
Updates the custom logo with the new image provided.
|
GenericEntry |
setDomainSecondaryEmailAddress(java.lang.String adminSecondaryEmail)
Registers the given Email as domain's secondary Email address
|
GenericEntry |
setOrganizationName(java.lang.String organizationName)
Set the organization name for the domain
|
delete, getAllPages, getEntry, getEntry, getFeed, getFeed, insert, query, update
addCookie, batch, createRequest, createRequest, delete, getAuthToken, getAuthTokenFactory, getCookieManager, getCookies, getEntry, getFeed, getFeed, getFeed, handleRedirectException, handlesCookies, handleSessionExpiredException, makePostRequest, setAuthSubToken, setAuthSubToken, setAuthTokenFactory, setCookieManager, setHandlesCookies, setOAuthCredentials, setUserCredentials, setUserCredentials, setUserCredentials, setUserCredentials, setUserToken, tokenChanged
classOf, 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, writeRequestData
protected java.lang.String generalSettingsUrl
protected java.lang.String domainBaseUrl
protected java.lang.String appearanceUrl
protected java.lang.String accountSettingsUrl
public DomainSettingsService(java.lang.String domain, java.lang.String applicationName)
setUserCredentials
or setUserToken
when using this constructor.domain
- Domain being configuredapplicationName
- Application name consuming the APIpublic DomainSettingsService(java.lang.String adminUser, java.lang.String adminPassword, java.lang.String domain, java.lang.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(java.lang.String language) throws AppsForYourDomainException, java.io.IOException, ServiceException
language
- AppsForYourDomainException
- if an Apps for your domain API error
occurred.java.io.IOException
- if an error occurs while communicating with the GData
service.ServiceException
- if the update request failed due to system error.public java.lang.String getDefaultLanguage() throws AppsForYourDomainException, java.io.IOException, ServiceException
AppsForYourDomainException
- if an Apps for your domain API error
occurred.java.io.IOException
- if an error occurs while communicating with the GData
service.ServiceException
- if the fetch request failed due to system error.public GenericEntry setOrganizationName(java.lang.String organizationName) throws AppsForYourDomainException, java.io.IOException, ServiceException
organizationName
- The name of the organization associated with the
domainjava.io.IOException
- 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 java.lang.String getOrganizationName() throws AppsForYourDomainException, java.net.MalformedURLException, java.io.IOException, ServiceException
java.io.IOException
- if an error occurs while communicating with the GData
service.java.net.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, java.net.MalformedURLException, java.io.IOException, ServiceException
java.io.IOException
- if an error occurs while communicating with the GData
service.java.net.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 java.lang.String getDomainVerificationStatus() throws AppsForYourDomainException, java.net.MalformedURLException, java.io.IOException, ServiceException
java.io.IOException
- if an error occurs while communicating with the GData
service.java.net.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 java.lang.String getSupportPIN() throws AppsForYourDomainException, java.net.MalformedURLException, java.io.IOException, ServiceException
java.io.IOException
- if an error occurs while communicating with the GData
service.java.net.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 java.lang.String getDomainEdition() throws AppsForYourDomainException, java.net.MalformedURLException, java.io.IOException, ServiceException
java.io.IOException
- if an error occurs while communicating with the GData
service.java.net.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 java.lang.String getCustomerPIN() throws AppsForYourDomainException, java.net.MalformedURLException, java.io.IOException, ServiceException
java.io.IOException
- if an error occurs while communicating with the GData
service.java.net.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 java.lang.String getDomainCreationTime() throws AppsForYourDomainException, java.net.MalformedURLException, java.io.IOException, ServiceException
java.io.IOException
- if an error occurs while communicating with the GData
service.java.net.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 java.lang.String getCountryCodeForDomain() throws AppsForYourDomainException, java.net.MalformedURLException, java.io.IOException, ServiceException
java.io.IOException
- if an error occurs while communicating with the GData
service.java.net.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 java.lang.String getDomainSecondaryEmailAddress() throws AppsForYourDomainException, java.net.MalformedURLException, java.io.IOException, ServiceException
java.io.IOException
- if an error occurs while communicating with the GData
service.java.net.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(java.lang.String adminSecondaryEmail) throws AppsForYourDomainException, java.io.IOException, ServiceException
adminSecondaryEmail
- Email addressjava.io.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
occurredpublic GenericEntry setDomainLogo(java.lang.String base64EncodedImage) throws java.io.IOException, AppsForYourDomainException, ServiceException
base64EncodedImage
- image file in base64 encoding.java.io.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
occurred