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

Class StemAttributeNameValidationHook

java.lang.Object

edu.internet2.middleware.grouper.hooks.StemHooks

edu.internet2.middleware.grouper.hooks.examples.StemAttributeNameValidationHook

public class StemAttributeNameValidationHook
extends StemHooks

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

Field Summary

Fields

Modifier and Type	Field	Description
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.StemHooks

METHOD_STEM_POST_COMMIT_DELETE, METHOD_STEM_POST_COMMIT_INSERT, METHOD_STEM_POST_COMMIT_UPDATE, METHOD_STEM_POST_DELETE, METHOD_STEM_POST_INSERT, METHOD_STEM_POST_UPDATE, METHOD_STEM_PRE_DELETE, METHOD_STEM_PRE_INSERT, METHOD_STEM_PRE_UPDATE

Constructor Summary

Constructors

Constructor	Description
StemAttributeNameValidationHook()

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()
static void	registerHookIfNecessary(boolean addTestValidation)	see if this is configured in the grouper.properties, if so, register this hook
static void	removeAttributeNameData(String attributeName)
void	stemPreInsert(HooksContext hooksContext, HooksStemBean preInsertBean)	called right before a stem insert
void	stemPreUpdate(HooksContext hooksContext, HooksStemBean preUpdateBean)	called right before a stem update

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

stemPostCommitDelete, stemPostCommitInsert, stemPostCommitUpdate, stemPostDelete, stemPostInsert, stemPostUpdate, stemPreDelete

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

Constructor Details

StemAttributeNameValidationHook

public StemAttributeNameValidationHook()

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

stemPreInsert

public void stemPreInsert(HooksContext hooksContext,
 HooksStemBean preInsertBean)

Description copied from class: StemHooks

called right before a stem insert

Overrides:

stemPreInsert in class StemHooks

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

stemPreUpdate

public void stemPreUpdate(HooksContext hooksContext,
 HooksStemBean preUpdateBean)

Description copied from class: StemHooks

called right before a stem update

Overrides:

stemPreUpdate in class StemHooks

See Also:

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