edu.internet2.middleware.changelogconsumer.googleapps

Class GoogleGrouperConnector

java.lang.Object

edu.internet2.middleware.changelogconsumer.googleapps.GoogleGrouperConnector

public class GoogleGrouperConnector
extends Object

Contains methods used by both the ChangeLogConsumer and the FullSync classes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_CONFIG_STEM
static String	GOOGLE_CONFIG_STEM
static String	GOOGLE_PROVISIONER
static String	SYNC_TO_GOOGLE
static String	SYNC_TO_GOOGLE_NAME

Constructor Summary

Constructors

Constructor and Description
GoogleGrouperConnector()

Method Summary

Modifier and Type	Method and Description
void	cacheSyncedGroupsAndStems()
void	cacheSyncedGroupsAndStems(boolean fullyPopulate)
void	createGooGroupIfNecessary(Group grouperGroup)
void	createGooMember(Group group, Subject subject, String role)
void	createGooMember(com.google.api.services.admin.directory.model.Group group, com.google.api.services.admin.directory.model.User user, String role)
com.google.api.services.admin.directory.model.User	createGooUser(Subject subject)
void	deleteGooGroup(Group group)
void	deleteGooGroup(PITGroup group)
void	deleteGooGroupByEmail(String groupKey)
void	deleteGooGroupByName(String groupName)
void	deleteGooGroupByName(String groupName, String groupId)
String	determineRole(Member member, Group group)
com.google.api.services.admin.directory.model.Group	fetchGooGroup(String groupKey)
com.google.api.services.admin.directory.model.User	fetchGooUser(String userKey)
Group	fetchGrouperGroup(String groupName)
Subject	fetchGrouperSubject(String sourceId, String subjectId)
AddressFormatter	getAddressFormatter()
AttributeDefName	getGoogleSyncAttribute() Finds the AttributeDefName specific to this GoogleApps ChangeLog Consumer instance.
List<com.google.api.services.admin.directory.model.Member>	getGooMembership(String groupKey)
HashMap<String,String>	getSyncedGroupsAndStems()
void	initialize(String consumerName, GoogleAppsSyncProperties properties)
void	populateGoogleCache() populates the Google user and group caches.
void	populateGooGroupsCache(com.google.api.services.admin.directory.Directory directory)
void	populateGooUsersCache(com.google.api.services.admin.directory.Directory directory)
void	removeGooMembership(String groupKey, String subjectEmail)
void	removeGooMembership(String groupName, String groupId, Subject subject)
void	removeGooMembership(String groupName, Subject subject)
boolean	shouldSyncGroup(Group group)
boolean	shouldSyncStem(Stem stem)
boolean	shouldSyncStem(String stemName)
void	unarchiveGooGroupIfNecessary(com.google.api.services.admin.directory.model.Group group)
com.google.api.services.admin.directory.model.Group	updateGooGroup(String groupKey, com.google.api.services.admin.directory.model.Group group)
void	updateGooMember(Group group, Subject subject, String role)

Methods inherited from class java.lang.Object

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

Field Detail

SYNC_TO_GOOGLE

public static final String SYNC_TO_GOOGLE

See Also:

Constant Field Values

GOOGLE_PROVISIONER

public static final String GOOGLE_PROVISIONER

See Also:

Constant Field Values

ATTRIBUTE_CONFIG_STEM

public static final String ATTRIBUTE_CONFIG_STEM

See Also:

Constant Field Values

GOOGLE_CONFIG_STEM

public static final String GOOGLE_CONFIG_STEM

See Also:

Constant Field Values

SYNC_TO_GOOGLE_NAME

public static final String SYNC_TO_GOOGLE_NAME

See Also:

Constant Field Values

Constructor Detail

GoogleGrouperConnector

public GoogleGrouperConnector()

Method Detail

initialize

public void initialize(String consumerName,
                       GoogleAppsSyncProperties properties)
                throws GeneralSecurityException,
                       IOException

Throws:

GeneralSecurityException

IOException

populateGoogleCache

public void populateGoogleCache()

populates the Google user and group caches.

populateGooUsersCache

public void populateGooUsersCache(com.google.api.services.admin.directory.Directory directory)

populateGooGroupsCache

public void populateGooGroupsCache(com.google.api.services.admin.directory.Directory directory)

fetchGooGroup

public com.google.api.services.admin.directory.model.Group fetchGooGroup(String groupKey)
                                                                  throws IOException

Throws:

IOException

fetchGooUser

public com.google.api.services.admin.directory.model.User fetchGooUser(String userKey)

fetchGrouperGroup

public Group fetchGrouperGroup(String groupName)

fetchGrouperSubject

public Subject fetchGrouperSubject(String sourceId,
                                   String subjectId)

createGooUser

public com.google.api.services.admin.directory.model.User createGooUser(Subject subject)
                                                                 throws IOException

Throws:

IOException

createGooMember

public void createGooMember(com.google.api.services.admin.directory.model.Group group,
                            com.google.api.services.admin.directory.model.User user,
                            String role)
                     throws IOException

Throws:

IOException

createGooGroupIfNecessary

public void createGooGroupIfNecessary(Group grouperGroup)
                               throws IOException

Throws:

IOException

determineRole

public String determineRole(Member member,
                            Group group)

unarchiveGooGroupIfNecessary

public void unarchiveGooGroupIfNecessary(com.google.api.services.admin.directory.model.Group group)
                                  throws IOException

Throws:

IOException

deleteGooGroup

public void deleteGooGroup(Group group)
                    throws IOException

Throws:

IOException

deleteGooGroup

public void deleteGooGroup(PITGroup group)
                    throws IOException

Throws:

IOException

deleteGooGroupByName

public void deleteGooGroupByName(String groupName)
                          throws IOException

Throws:

IOException

deleteGooGroupByName

public void deleteGooGroupByName(String groupName,
                                 String groupId)
                          throws IOException

Throws:

IOException

deleteGooGroupByEmail

public void deleteGooGroupByEmail(String groupKey)
                           throws IOException

Throws:

IOException

getGoogleSyncAttribute

public AttributeDefName getGoogleSyncAttribute()

Finds the AttributeDefName specific to this GoogleApps ChangeLog Consumer instance.

Returns:

The AttributeDefName for this GoogleApps ChangeLog Consumer

shouldSyncGroup

public boolean shouldSyncGroup(Group group)

shouldSyncStem

public boolean shouldSyncStem(Stem stem)

shouldSyncStem

public boolean shouldSyncStem(String stemName)

cacheSyncedGroupsAndStems

public void cacheSyncedGroupsAndStems()

cacheSyncedGroupsAndStems

public void cacheSyncedGroupsAndStems(boolean fullyPopulate)

removeGooMembership

public void removeGooMembership(String groupName,
                                Subject subject)
                         throws IOException

Throws:

IOException

removeGooMembership

public void removeGooMembership(String groupName,
                                String groupId,
                                Subject subject)
                         throws IOException

Throws:

IOException

removeGooMembership

public void removeGooMembership(String groupKey,
                                String subjectEmail)
                         throws IOException

Throws:

IOException

updateGooGroup

public com.google.api.services.admin.directory.model.Group updateGooGroup(String groupKey,
                                                                          com.google.api.services.admin.directory.model.Group group)
                                                                   throws IOException

Throws:

IOException

getGooMembership

public List<com.google.api.services.admin.directory.model.Member> getGooMembership(String groupKey)
                                                                            throws IOException

Throws:

IOException

getAddressFormatter

public AddressFormatter getAddressFormatter()

getSyncedGroupsAndStems

public HashMap<String,String> getSyncedGroupsAndStems()

createGooMember

public void createGooMember(Group group,
                            Subject subject,
                            String role)
                     throws IOException

Throws:

IOException

updateGooMember

public void updateGooMember(Group group,
                            Subject subject,
                            String role)
                     throws IOException

Throws:

IOException