edu.internet2.middleware.grouper.hooks.logic
Enum GrouperHookType

java.lang.Object
  extended by java.lang.Enum<GrouperHookType>
      extended by edu.internet2.middleware.grouper.hooks.logic.GrouperHookType
All Implemented Interfaces:
GrouperHookTypeInterface, Serializable, Comparable<GrouperHookType>

public enum GrouperHookType
extends Enum<GrouperHookType>
implements GrouperHookTypeInterface

type of hook, and manages the classes and instances


Enum Constant Summary
ATTRIBUTE
          attribute hooks
ATTRIBUTE_ASSIGN
          attribute assign hooks
ATTRIBUTE_ASSIGN_VALUE
          attribute assign value hooks
ATTRIBUTE_DEF
          attribute hooks
ATTRIBUTE_DEF_NAME
          attribute hooks
COMPOSITE
          composite hooks
EXTERNAL_SUBJECT
          external subject hooks
FIELD
          field hooks
GROUP
          group hooks
GROUP_TYPE
          group type hooks
GROUP_TYPE_TUPLE
          stem hooks
GROUPER_SESSION
          grouper session hooks
LIFECYCLE
          group hooks
LOADER
          loader hooks
MEMBER
          member hooks
MEMBERSHIP
          membership hooks
STEM
          stem hooks
 
Method Summary
static void addHookOverride(String propertyFileKey, Class<?> hookClass)
          for testing, you can override a hook (dont forget to remove later).
static void addHookOverride(String propertyFileKey, List<Class<?>> hookClasses)
          for testing, you can override a hook (dont forget to remove later).
 Class<?> getBaseClass()
          base class for this hook class
 String getPropertyFileKey()
          property file key for this hook class
static List<GrouperHookMethodAndObject> hooksInstances(GrouperHookTypeInterface grouperHookTypeInterface, String methodName, Class<?> beanClass)
          get an instance for this group type
static GrouperHookType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static GrouperHookType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

EXTERNAL_SUBJECT

public static final GrouperHookType EXTERNAL_SUBJECT
external subject hooks


LOADER

public static final GrouperHookType LOADER
loader hooks


GROUP

public static final GrouperHookType GROUP
group hooks


ATTRIBUTE

public static final GrouperHookType ATTRIBUTE
attribute hooks


ATTRIBUTE_ASSIGN

public static final GrouperHookType ATTRIBUTE_ASSIGN
attribute assign hooks


ATTRIBUTE_ASSIGN_VALUE

public static final GrouperHookType ATTRIBUTE_ASSIGN_VALUE
attribute assign value hooks


ATTRIBUTE_DEF

public static final GrouperHookType ATTRIBUTE_DEF
attribute hooks


ATTRIBUTE_DEF_NAME

public static final GrouperHookType ATTRIBUTE_DEF_NAME
attribute hooks


LIFECYCLE

public static final GrouperHookType LIFECYCLE
group hooks


STEM

public static final GrouperHookType STEM
stem hooks


MEMBER

public static final GrouperHookType MEMBER
member hooks


COMPOSITE

public static final GrouperHookType COMPOSITE
composite hooks


FIELD

public static final GrouperHookType FIELD
field hooks


GROUPER_SESSION

public static final GrouperHookType GROUPER_SESSION
grouper session hooks


GROUP_TYPE

public static final GrouperHookType GROUP_TYPE
group type hooks


GROUP_TYPE_TUPLE

public static final GrouperHookType GROUP_TYPE_TUPLE
stem hooks


MEMBERSHIP

public static final GrouperHookType MEMBERSHIP
membership hooks

Method Detail

values

public static GrouperHookType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (GrouperHookType c : GrouperHookType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static GrouperHookType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

hooksInstances

public static List<GrouperHookMethodAndObject> hooksInstances(GrouperHookTypeInterface grouperHookTypeInterface,
                                                              String methodName,
                                                              Class<?> beanClass)
get an instance for this group type

Parameters:
grouperHookTypeInterface -
methodName - e.g. groupPreUpdate
beanClass - e.g. HooksGroupBean.class
Returns:
the instance / methods or empty list if none configured

addHookOverride

public static void addHookOverride(String propertyFileKey,
                                   Class<?> hookClass)
for testing, you can override a hook (dont forget to remove later). this temporarily hides existing hooks

Parameters:
propertyFileKey -
hookClass -

addHookOverride

public static void addHookOverride(String propertyFileKey,
                                   List<Class<?>> hookClasses)
for testing, you can override a hook (dont forget to remove later). this temporarily hides existing hooks

Parameters:
propertyFileKey -
hookClasses -

getPropertyFileKey

public String getPropertyFileKey()
property file key for this hook class

Specified by:
getPropertyFileKey in interface GrouperHookTypeInterface
Returns:
the propertyFileKey

getBaseClass

public Class<?> getBaseClass()
base class for this hook class

Specified by:
getBaseClass in interface GrouperHookTypeInterface
Returns:
the baseClass