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

Class GroupAttributeNameValidationHook

java.lang.Object

edu.internet2.middleware.grouper.hooks.GroupHooks

edu.internet2.middleware.grouper.hooks.examples.GroupAttributeNameValidationHook

public class GroupAttributeNameValidationHook
extends GroupHooks

 built in hook to grouper, which is turned on when it is configured in the grouper.properties.
 
 you can restrict certain attributes of a group to be within a certain regex
 
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	defaultRegex	default regex
static final String	TEST_ATTRIBUTE_NAME	for unit tests
static final String	TEST_PATTERN	for unit tests

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
GroupAttributeNameValidationHook()

Method Summary

Modifier and Type	Method	Description
static void	addAttributeNameData(String attributeName, String regex, String vetoMessage, String originalProperty)	Add a custom validator after Grouper startup (mainly used for test classes)
static void	clearHook()
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 void	registerHookIfNecessary(boolean addTestValidation)	see if this is configured in the grouper.properties, if so, register this hook
static void	removeAttributeNameData(String attributeName)

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

TEST_ATTRIBUTE_NAME

public static final String TEST_ATTRIBUTE_NAME

for unit tests

See Also:

• Constant Field Values

TEST_PATTERN

public static final String TEST_PATTERN

for unit tests

See Also:

• Constant Field Values

defaultRegex

public static final String defaultRegex

default regex

See Also:

• Constant Field Values

Constructor Details

GroupAttributeNameValidationHook

public GroupAttributeNameValidationHook()

Method Details

clearHook

public static void clearHook()

registerHookIfNecessary

public static void registerHookIfNecessary(boolean addTestValidation)

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

Parameters:

addTestValidation - if a test validation should be added

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)

addAttributeNameData

public static void addAttributeNameData(String attributeName,
 String regex,
 String vetoMessage,
 String originalProperty)

Add a custom validator after Grouper startup (mainly used for test classes)

Parameters:

attributeName - attribute key for record

regex - pattern string

vetoMessage - veto message

originalProperty - description of where the validation came from (property, etc)

removeAttributeNameData

public static void removeAttributeNameData(String attributeName)

Parameters:

attributeName - attribute key for record

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)