public class SingleSignOnService extends AppsPropertyService
AppsPropertyService
for managing SSO related
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 |
domainUrlBase |
protected java.lang.String |
ssoSettingsUrl |
protected java.lang.String |
ssoSigningKeyUrl |
APPS_SERVICE, DOMAIN_NAME, HTTPS_PROTOCOL
connectTimeout, extProfile, metadataRegistry, requestFactory
Constructor and Description |
---|
SingleSignOnService(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.
|
SingleSignOnService(java.lang.String adminEmail,
java.lang.String password,
java.lang.String domain,
java.lang.String applicationName)
Parameterized constructor for service authentication.
|
Modifier and Type | Method and Description |
---|---|
GenericEntry |
getSsoSettings()
Retrieves the SSO properties configured for the domain.
|
GenericEntry |
getSsoSigningKey()
Retrieves the certificate uploaded to the domain for SSO.
|
GenericEntry |
updateSSOSettings(GenericEntry entry)
Updates the SSO properties with the GenericEntry values.
|
GenericEntry |
updateSsoSigningKey(java.lang.String base64EncodedKey)
Updates the public key used for SSO.
|
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 ssoSettingsUrl
protected java.lang.String ssoSigningKeyUrl
protected java.lang.String domainUrlBase
public SingleSignOnService(java.lang.String domain, java.lang.String applicationName)
setUserCredentials
or setUserToken
when using this constructor.domain
- Domain being configuredapplicationName
- Application name consuming the APIpublic SingleSignOnService(java.lang.String adminEmail, java.lang.String password, java.lang.String domain, java.lang.String applicationName) throws AuthenticationException
adminEmail
- the email id of the administrator.password
- 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 updateSSOSettings(GenericEntry entry) throws AppsForYourDomainException, java.io.IOException, ServiceException
entry
- a GenericEntry object with SSO propertiesjava.io.IOException
- if an error occurs while communicating with the GData
service.AppsForYourDomainException
- if an Apps for your domain API error
occurred.ServiceException
- if the insert request failed due to system error.public GenericEntry updateSsoSigningKey(java.lang.String base64EncodedKey) throws java.io.IOException, AppsForYourDomainException, ServiceException
base64EncodedKey
- java.io.IOException
- if an error occurs while communicating with the GData
service.AppsForYourDomainException
- if an Apps for your domain API error
occurred.ServiceException
- if the fetch request failed due to system error.public GenericEntry getSsoSigningKey() 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 getSsoSettings() 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.