Package edu.internet2.middleware.grouper.hooks.examples

Class GroupUniqueExtensionInFoldersHook

java.lang.Object

edu.internet2.middleware.grouper.hooks.GroupHooks

edu.internet2.middleware.grouper.hooks.examples.GroupUniqueExtensionInFoldersHook

public class GroupUniqueExtensionInFoldersHook
extends GroupHooks

 built in hook to grouper, which is turned on when it is configured in the grouper.properties.
 
 extensions in groups will be unique in a list of folders (or subfolders)
 
 set that with grouper.properties:
 
 groupUniqueExtensionInFolderHook.someConfigId.folderNames = a:b:c,d:e:f
 groupUniqueExtensionInFolderHook.someConfigId2.folderNames = a:b:c,d:e:f
 
 # set this to true in grouper.properties to make this case insensitive
 groupUniqueExtensionInFolderHookCaseInsensitive = true
 
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VETO_GROUP_UNIQUE_EXTENSION_IN_FOLDER	You cannot use this extension since it is in use with another related group (in this folder or another related folder):

Fields inherited from class edu.internet2.middleware.grouper.hooks.GroupHooks

METHOD_GROUP_POST_COMMIT_DELETE, METHOD_GROUP_POST_COMMIT_INSERT, METHOD_GROUP_POST_COMMIT_UPDATE, METHOD_GROUP_POST_DELETE, METHOD_GROUP_POST_INSERT, METHOD_GROUP_POST_UPDATE, METHOD_GROUP_PRE_DELETE, METHOD_GROUP_PRE_INSERT, METHOD_GROUP_PRE_UPDATE

Constructor Summary

Constructors

Constructor	Description
GroupUniqueExtensionInFoldersHook()

Method Summary

Modifier and Type	Method	Description
static void	clearHook()
static Map<String,Set<String>>	configIdToSetOfFolderNames()	never null.
void	groupPreInsert(HooksContext hooksContext, HooksGroupBean preInsertBean)	called right before a group insert
void	groupPreUpdate(HooksContext hooksContext, HooksGroupBean preUpdateBean)	called right before a group update
static boolean	hasConfiguredFolders()
static void	registerHookIfNecessary()	see if this is configured in the grouper.properties, if so, register this hook
static void	verifyUniqueExtension(Group group)

Methods inherited from class edu.internet2.middleware.grouper.hooks.GroupHooks

groupPostCommitDelete, groupPostCommitInsert, groupPostCommitUpdate, groupPostDelete, groupPostInsert, groupPostUpdate, groupPreDelete

Methods inherited from class java.lang.Object

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

Field Details

VETO_GROUP_UNIQUE_EXTENSION_IN_FOLDER

public static final String VETO_GROUP_UNIQUE_EXTENSION_IN_FOLDER

You cannot use this extension since it is in use with another related group (in this folder or another related folder):

See Also:

• Constant Field Values

Constructor Details

GroupUniqueExtensionInFoldersHook

public GroupUniqueExtensionInFoldersHook()

Method Details

hasConfiguredFolders

public static boolean hasConfiguredFolders()

Returns:

groupPreInsert

public void groupPreInsert(HooksContext hooksContext,
 HooksGroupBean preInsertBean)

Description copied from class: GroupHooks

called right before a group insert

Overrides:

groupPreInsert in class GroupHooks

See Also:

• GroupHooks.groupPreInsert(edu.internet2.middleware.grouper.hooks.beans.HooksContext, edu.internet2.middleware.grouper.hooks.beans.HooksGroupBean)

configIdToSetOfFolderNames

public static Map<String,Set<String>> configIdToSetOfFolderNames()

never null. key is config id _ true|false (for if case sensitive or not

Returns:

verifyUniqueExtension

public static void verifyUniqueExtension(Group group)

Parameters:

group -

groupPreUpdate

public void groupPreUpdate(HooksContext hooksContext,
 HooksGroupBean preUpdateBean)

Description copied from class: GroupHooks

called right before a group update

Overrides:

groupPreUpdate in class GroupHooks

See Also:

• GroupHooks.groupPreUpdate(edu.internet2.middleware.grouper.hooks.beans.HooksContext, edu.internet2.middleware.grouper.hooks.beans.HooksGroupBean)

clearHook

public static void clearHook()

registerHookIfNecessary

public static void registerHookIfNecessary()

see if this is configured in the grouper.properties, if so, register this hook