org.lsc.service

Class GoogleAppsService

java.lang.Object

org.lsc.service.GoogleAppsService

All Implemented Interfaces:

IService, IWritableService

public class GoogleAppsService
extends Object
implements IWritableService

This class enables a provisioning of the Google Apps accounts - Provisioning API version 2.0 This service reuses most of the code provided as samples by Google at the following location: http://code.google.com/p /gdata-java-client/source/browse/trunk/java/sample/appsforyourdomain/AppsForYourDomainClient.java This service never delete users account: it only suspends them.

Author:

Sebastien Bahloul <seb@lsc-project.org>

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATASET_NAME_ADMIN
static String	DATASET_NAME_AGREEDTOTERMS
static String	DATASET_NAME_CREATETS
static String	DATASET_NAME_GIVENNAME
static String	DATASET_NAME_ID
static String	DATASET_NAME_LOGIN
static String	DATASET_NAME_MAIL
static String	DATASET_NAME_MODIFYTS
static String	DATASET_NAME_NICKNAME
static String	DATASET_NAME_PASSWORD
static String	DATASET_NAME_PASSWORD_HASH
static String	DATASET_NAME_QUOTA
static String	DATASET_NAME_SURNAME
static String	DATASET_NAME_SUSPENDED
static String	DATASET_NAME_WHITELISTED

Constructor Summary

Constructors

Constructor and Description
GoogleAppsService(TaskType task)

Method Summary

Modifier and Type	Method and Description
com.google.gdata.data.appsforyourdomain.provisioning.UserEntry	addAdminPrivilege(String username) Set admin privilege for user.
boolean	apply(LscModifications lm) Apply lsc modifications.
com.google.gdata.data.appsforyourdomain.provisioning.NicknameEntry	createNickname(String username, String nickname) Creates a nickname for the username.
com.google.gdata.data.appsforyourdomain.provisioning.UserEntry	createUser(String username, String givenName, String familyName, String password) Creates a new user with an email account.
com.google.gdata.data.appsforyourdomain.provisioning.UserEntry	createUser(String username, String givenName, String familyName, String password, Integer quotaLimitInMb) Creates a new user with an email account.
com.google.gdata.data.appsforyourdomain.provisioning.UserEntry	createUser(String username, String givenName, String familyName, String password, String passwordHashFunction) Creates a new user with an email account.
com.google.gdata.data.appsforyourdomain.provisioning.UserEntry	createUser(String username, String givenName, String familyName, String password, String passwordHashFunction, Integer quotaLimitInMb) Creates a new user with an email account.
com.google.gdata.data.appsforyourdomain.provisioning.UserEntry	createUser(String username, com.google.gdata.data.appsforyourdomain.provisioning.UserEntry entry)
void	deleteNickname(String nickname) Deletes a nickname.
void	deleteUser(String username) Deletes a user.
com.google.gdata.data.appsforyourdomain.provisioning.UserEntry	forceUserToChangePassword(String username) Require a user to change password at next login.
IBean	getBean(String pivotName, LscDatasets pivotAttributes, boolean fromSameService) The simple object getter according to its identifier.
Map<String,LscDatasets>	getListPivots() Returns a list of all the objects' identifiers.
List<String>	getWriteDatasetIds()
com.google.gdata.data.appsforyourdomain.provisioning.UserEntry	removeAdminPrivilege(String username) Remove admin privilege for user.
com.google.gdata.data.appsforyourdomain.provisioning.UserEntry	restoreUser(String username) Restores a user.
com.google.gdata.data.appsforyourdomain.provisioning.NicknameFeed	retrieveAllNicknames() Retrieves all nicknames in domain.
com.google.gdata.data.appsforyourdomain.provisioning.UserFeed	retrieveAllUsers() Retrieves all users in domain.
com.google.gdata.data.appsforyourdomain.provisioning.NicknameEntry	retrieveNickname(String nickname) Retrieves a nickname.
com.google.gdata.data.appsforyourdomain.provisioning.NicknameFeed	retrieveNicknames(String username) Retrieves all nicknames for the given username.
com.google.gdata.data.appsforyourdomain.provisioning.NicknameFeed	retrievePageOfNicknames(String startNickname) Retrieves one page (100) of nicknames in domain.
com.google.gdata.data.appsforyourdomain.provisioning.UserFeed	retrievePageOfUsers(String startUsername) Retrieves one page (100) of users in domain.
com.google.gdata.data.appsforyourdomain.provisioning.UserEntry	retrieveUser(String username) Retrieves a user.
com.google.gdata.data.appsforyourdomain.provisioning.UserEntry	suspendUser(String username) Suspends a user.
com.google.gdata.data.appsforyourdomain.provisioning.UserEntry	updateUser(String username, com.google.gdata.data.appsforyourdomain.provisioning.UserEntry userEntry) Updates a user.

Methods inherited from class java.lang.Object

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

Field Detail

DATASET_NAME_ID

public static final String DATASET_NAME_ID

See Also:

Constant Field Values

DATASET_NAME_MAIL

public static final String DATASET_NAME_MAIL

See Also:

Constant Field Values

DATASET_NAME_LOGIN

public static final String DATASET_NAME_LOGIN

See Also:

Constant Field Values

DATASET_NAME_PASSWORD

public static final String DATASET_NAME_PASSWORD

See Also:

Constant Field Values

DATASET_NAME_PASSWORD_HASH

public static final String DATASET_NAME_PASSWORD_HASH

See Also:

Constant Field Values

DATASET_NAME_SUSPENDED

public static final String DATASET_NAME_SUSPENDED

See Also:

Constant Field Values

DATASET_NAME_ADMIN

public static final String DATASET_NAME_ADMIN

See Also:

Constant Field Values

DATASET_NAME_AGREEDTOTERMS

public static final String DATASET_NAME_AGREEDTOTERMS

See Also:

Constant Field Values

DATASET_NAME_WHITELISTED

public static final String DATASET_NAME_WHITELISTED

See Also:

Constant Field Values

DATASET_NAME_GIVENNAME

public static final String DATASET_NAME_GIVENNAME

See Also:

Constant Field Values

DATASET_NAME_SURNAME

public static final String DATASET_NAME_SURNAME

See Also:

Constant Field Values

DATASET_NAME_QUOTA

public static final String DATASET_NAME_QUOTA

See Also:

Constant Field Values

DATASET_NAME_CREATETS

public static final String DATASET_NAME_CREATETS

See Also:

Constant Field Values

DATASET_NAME_MODIFYTS

public static final String DATASET_NAME_MODIFYTS

See Also:

Constant Field Values

DATASET_NAME_NICKNAME

public static final String DATASET_NAME_NICKNAME

See Also:

Constant Field Values

Constructor Detail

GoogleAppsService

public GoogleAppsService(TaskType task)
                  throws LscServiceException

Throws:

LscServiceException

Method Detail

getBean

public IBean getBean(String pivotName,
                     LscDatasets pivotAttributes,
                     boolean fromSameService)
              throws LscServiceException

Description copied from interface: IService

The simple object getter according to its identifier.

Specified by:

getBean in interface IService

Parameters:

pivotName - Name of the entry to be returned, which is the name returned by IService.getListPivots() (used for display only)

pivotAttributes - Map of attribute names and values, which is the data identifier in the source such as returned by IService.getListPivots(). It must identify a unique entry in the source.

fromSameService - are the pivot attributes provided by the same service

Returns:

The bean, or null if not found

Throws:

LscServiceException

getListPivots

public Map<String,LscDatasets> getListPivots()
                                      throws LscServiceException

Description copied from interface: IService

Returns a list of all the objects' identifiers.

Specified by:

getListPivots in interface IService

Returns:

Map of all entries names that are returned by the directory with an associated map of attribute names and values (never null)

Throws:

LscServiceException

apply

public boolean apply(LscModifications lm)
              throws LscServiceException

Description copied from interface: IWritableService

Apply lsc modifications.

Specified by:

apply in interface IWritableService

Parameters:

lm - Modifications to apply in a LscModifications object.

Returns:

Operation status

Throws:

LscServiceException - thrown if an error is encountered

getWriteDatasetIds

public List<String> getWriteDatasetIds()

Specified by:

getWriteDatasetIds in interface IWritableService

createUser

public com.google.gdata.data.appsforyourdomain.provisioning.UserEntry createUser(String username,
                                                                                 String givenName,
                                                                                 String familyName,
                                                                                 String password)
                                                                          throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                 com.google.gdata.util.ServiceException,
                                                                                 IOException

Creates a new user with an email account.

Parameters:

username - The username of the new user.

givenName - The given name for the new user.

familyName - the family name for the new user.

password - The password for the new user.

Returns:

A UserEntry object of the newly created user.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

createUser

public com.google.gdata.data.appsforyourdomain.provisioning.UserEntry createUser(String username,
                                                                                 String givenName,
                                                                                 String familyName,
                                                                                 String password,
                                                                                 Integer quotaLimitInMb)
                                                                          throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                 com.google.gdata.util.ServiceException,
                                                                                 IOException

Creates a new user with an email account.

Parameters:

username - The username of the new user.

givenName - The given name for the new user.

familyName - the family name for the new user.

password - The password for the new user.

quotaLimitInMb - User's quota limit in megabytes. This field is only used for domains with custom quota limits.

Returns:

A UserEntry object of the newly created user.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

createUser

public com.google.gdata.data.appsforyourdomain.provisioning.UserEntry createUser(String username,
                                                                                 String givenName,
                                                                                 String familyName,
                                                                                 String password,
                                                                                 String passwordHashFunction)
                                                                          throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                 com.google.gdata.util.ServiceException,
                                                                                 IOException

Creates a new user with an email account.

Parameters:

username - The username of the new user.

givenName - The given name for the new user.

familyName - the family name for the new user.

password - The password for the new user.

passwordHashFunction - The name of the hash function to hash the password

Returns:

A UserEntry object of the newly created user.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

createUser

public com.google.gdata.data.appsforyourdomain.provisioning.UserEntry createUser(String username,
                                                                                 String givenName,
                                                                                 String familyName,
                                                                                 String password,
                                                                                 String passwordHashFunction,
                                                                                 Integer quotaLimitInMb)
                                                                          throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                 com.google.gdata.util.ServiceException,
                                                                                 IOException

Creates a new user with an email account.

Parameters:

username - The username of the new user.

givenName - The given name for the new user.

familyName - the family name for the new user.

password - The password for the new user.

passwordHashFunction - Specifies the hash format of the password parameter

quotaLimitInMb - User's quota limit in megabytes. This field is only used for domains with custom quota limits.

Returns:

A UserEntry object of the newly created user.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

createUser

public com.google.gdata.data.appsforyourdomain.provisioning.UserEntry createUser(String username,
                                                                                 com.google.gdata.data.appsforyourdomain.provisioning.UserEntry entry)
                                                                          throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                 IOException,
                                                                                 com.google.gdata.util.ServiceException

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException

IOException

com.google.gdata.util.ServiceException

retrieveUser

public com.google.gdata.data.appsforyourdomain.provisioning.UserEntry retrieveUser(String username)
                                                                            throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                   com.google.gdata.util.ServiceException,
                                                                                   IOException

Retrieves a user.

Parameters:

username - The user you wish to retrieve.

Returns:

A UserEntry object of the retrieved user.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

retrieveAllUsers

public com.google.gdata.data.appsforyourdomain.provisioning.UserFeed retrieveAllUsers()
                                                                               throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                      com.google.gdata.util.ServiceException,
                                                                                      IOException

Retrieves all users in domain. This method may be very slow for domains with a large number of users. Any changes to users, including creations and deletions, which are made after this method is called may or may not be included in the Feed which is returned.

Returns:

A UserFeed object of the retrieved users.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

retrievePageOfUsers

public com.google.gdata.data.appsforyourdomain.provisioning.UserFeed retrievePageOfUsers(String startUsername)
                                                                                  throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                         com.google.gdata.util.ServiceException,
                                                                                         IOException

Retrieves one page (100) of users in domain. Any changes to users, including creations and deletions, which are made after this method is called may or may not be included in the Feed which is returned. If the optional startUsername parameter is specified, one page of users is returned which have usernames at or after the startUsername as per ASCII value ordering with case-insensitivity. A value of null or empty string indicates you want results from the beginning of the list.

Parameters:

startUsername - The starting point of the page (optional).

Returns:

A UserFeed object of the retrieved users.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

updateUser

public com.google.gdata.data.appsforyourdomain.provisioning.UserEntry updateUser(String username,
                                                                                 com.google.gdata.data.appsforyourdomain.provisioning.UserEntry userEntry)
                                                                          throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                 com.google.gdata.util.ServiceException,
                                                                                 IOException

Updates a user.

Parameters:

username - The user to update.

userEntry - The updated UserEntry for the user.

Returns:

A UserEntry object of the newly updated user.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

deleteUser

public void deleteUser(String username)
                throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                       com.google.gdata.util.ServiceException,
                       IOException

Deletes a user.

Parameters:

username - The user you wish to delete.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

suspendUser

public com.google.gdata.data.appsforyourdomain.provisioning.UserEntry suspendUser(String username)
                                                                           throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                  com.google.gdata.util.ServiceException,
                                                                                  IOException

Suspends a user. Note that executing this method for a user who is already suspended has no effect.

Parameters:

username - The user you wish to suspend.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

restoreUser

public com.google.gdata.data.appsforyourdomain.provisioning.UserEntry restoreUser(String username)
                                                                           throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                  com.google.gdata.util.ServiceException,
                                                                                  IOException

Restores a user. Note that executing this method for a user who is not suspended has no effect.

Parameters:

username - The user you wish to restore.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

addAdminPrivilege

public com.google.gdata.data.appsforyourdomain.provisioning.UserEntry addAdminPrivilege(String username)
                                                                                 throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                        com.google.gdata.util.ServiceException,
                                                                                        IOException

Set admin privilege for user. Note that executing this method for a user who is already an admin has no effect.

Parameters:

username - The user you wish to make an admin.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific error occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

removeAdminPrivilege

public com.google.gdata.data.appsforyourdomain.provisioning.UserEntry removeAdminPrivilege(String username)
                                                                                    throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                           com.google.gdata.util.ServiceException,
                                                                                           IOException

Remove admin privilege for user. Note that executing this method for a user who is not an admin has no effect.

Parameters:

username - The user you wish to remove admin privileges.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific error occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

forceUserToChangePassword

public com.google.gdata.data.appsforyourdomain.provisioning.UserEntry forceUserToChangePassword(String username)
                                                                                         throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                                com.google.gdata.util.ServiceException,
                                                                                                IOException

Require a user to change password at next login. Note that executing this method for a user who is already required to change password at next login as no effect.

Parameters:

username - The user who must change his or her password.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

createNickname

public com.google.gdata.data.appsforyourdomain.provisioning.NicknameEntry createNickname(String username,
                                                                                         String nickname)
                                                                                  throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                         com.google.gdata.util.ServiceException,
                                                                                         IOException

Creates a nickname for the username.

Parameters:

username - The user for which we want to create a nickname.

nickname - The nickname you wish to create.

Returns:

A NicknameEntry object of the newly created nickname.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

retrieveNickname

public com.google.gdata.data.appsforyourdomain.provisioning.NicknameEntry retrieveNickname(String nickname)
                                                                                    throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                           com.google.gdata.util.ServiceException,
                                                                                           IOException

Retrieves a nickname.

Parameters:

nickname - The nickname you wish to retrieve.

Returns:

A NicknameEntry object of the newly created nickname.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

retrieveNicknames

public com.google.gdata.data.appsforyourdomain.provisioning.NicknameFeed retrieveNicknames(String username)
                                                                                    throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                           com.google.gdata.util.ServiceException,
                                                                                           IOException

Retrieves all nicknames for the given username.

Parameters:

username - The user for which you want all nicknames.

Returns:

A NicknameFeed object with all the nicknames for the user.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

retrievePageOfNicknames

public com.google.gdata.data.appsforyourdomain.provisioning.NicknameFeed retrievePageOfNicknames(String startNickname)
                                                                                          throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                                 com.google.gdata.util.ServiceException,
                                                                                                 IOException

Retrieves one page (100) of nicknames in domain. Any changes to nicknames, including creations and deletions, which are made after this method is called may or may not be included in the Feed which is returned. If the optional startNickname parameter is specified, one page of nicknames is returned which have names at or after startNickname as per ASCII value ordering with case-insensitivity. A value of null or empty string indicates you want results from the beginning of the list.

Parameters:

startNickname - The starting point of the page (optional).

Returns:

A NicknameFeed object of the retrieved nicknames.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

retrieveAllNicknames

public com.google.gdata.data.appsforyourdomain.provisioning.NicknameFeed retrieveAllNicknames()
                                                                                       throws com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                                                                                              com.google.gdata.util.ServiceException,
                                                                                              IOException

Retrieves all nicknames in domain. This method may be very slow for domains with a large number of nicknames. Any changes to nicknames, including creations and deletions, which are made after this method is called may or may not be included in the Feed which is returned.

Returns:

A NicknameFeed object of the retrieved nicknames.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.

deleteNickname

public void deleteNickname(String nickname)
                    throws IOException,
                           com.google.gdata.data.appsforyourdomain.AppsForYourDomainException,
                           com.google.gdata.util.ServiceException

Deletes a nickname.

Parameters:

nickname - The nickname you wish to delete.

Throws:

com.google.gdata.data.appsforyourdomain.AppsForYourDomainException - If a Provisioning API specific occurs.

com.google.gdata.util.ServiceException - If a generic GData framework error occurs.

IOException - If an error occurs communicating with the GData service.