Package edu.internet2.middleware.grouper.userLifecycle

Class UserLifecycleActionConfiguration

java.lang.Object

edu.internet2.middleware.grouper.app.config.GrouperConfigurationModuleBase

edu.internet2.middleware.grouper.userLifecycle.UserLifecycleActionConfiguration

All Implemented Interfaces:

OptionValueDriver

public class UserLifecycleActionConfiguration
extends GrouperConfigurationModuleBase
implements OptionValueDriver

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	lifecycleActionConfigIds	some required config to see what the fields are

Fields inherited from class edu.internet2.middleware.grouper.app.config.GrouperConfigurationModuleBase

attributeCache, extraConfigKeys

Constructor Summary

Constructors

Constructor	Description
UserLifecycleActionConfiguration()

Method Summary

Modifier and Type	Method	Description
void	deleteConfig(boolean fromUi)	delete config
void	editConfig(boolean fromUi, StringBuilder message, List<String> errorsToDisplay, Map<String,String> validationErrorsToDisplay, List<String> actionsPerformed)	save the attribute in an edit.
String	getActionType()
ConfigFileName	getConfigFileName()	config file name to check for properties and metadata
String	getConfigIdRegex()	config id regeg eg: ^(provisioner)\\.([^.]+)\\.(.*)$
String	getConfigIdThatIdentifiesThisConfig()	config id that identified this config. either suffix and value or getConfigIdThatIdentifiesThisConfig is required, not both. eg: personLdap
String	getConfigItemPrefix()	prefix for the properties eg: provisioner.someConfigId.
protected String	getConfigurationTypePrefix()	for each type of configuration this is the prefix for eg in subsections. only ui concern in external text config.
String	getName()
void	insertConfig(boolean fromUi, StringBuilder message, List<String> errorsToDisplay, Map<String,String> validationErrorsToDisplay, List<String> actionsPerformed)	save the attribute in an insert.
static List<UserLifecycleActionConfiguration>	retrieveAllUserLifecycleActionConfigurations()	list of configured user lifecycle action configs
List<MultiKey>	retrieveKeysAndLabels()
void	validatePreSave(boolean isInsert, List<String> errorsToDisplay, Map<String,String> validationErrorsToDisplay)	validations to run before saving values into db

Methods inherited from class edu.internet2.middleware.grouper.app.config.GrouperConfigurationModuleBase

changeStatus, clearAttributeCache, formatIndexes, getCacheAttributePrefix, getCacheEntityAttributePrefix, getCacheGroupAttributePrefix, getCacheMembershipAttributePrefix, getConfigId, getDescription, getDocumentation, getGenericConfigId, getPropertySuffixThatIdentifiesThisConfig, getPropertyValueThatIdentifiesThisConfig, getStartWithDescription, getStartWithDocumentation, getSubSections, getTitle, isEnabled, isMultiple, listAllConfigurationsOfThisType, populateConfigurationValuesFromUi, populateValuesLabelsFromOptionValueClass, removeNoUnsedConfigs, retrieveAllConfigurations, retrieveAllConfigurationTypesHelper, retrieveAttributes, retrieveAttributesFromConfig, retrieveAttributeValueFromConfig, retrieveConfigurationConfigIds, retrieveConfigurationKeysByPrefix, retrieveExtraConfigKeys, retrieveObjectValueSubstituteMap, retrieveSuffix, retrieveText, setConfigId, showAttributeOverride

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.internet2.middleware.grouper.cfg.dbConfig.OptionValueDriver

setConfigSuffixToConfigModuleAttribute

Field Details

lifecycleActionConfigIds

public static final Pattern lifecycleActionConfigIds

some required config to see what the fields are

Constructor Details

UserLifecycleActionConfiguration

public UserLifecycleActionConfiguration()

Method Details

retrieveKeysAndLabels

public List<MultiKey> retrieveKeysAndLabels()

Specified by:

retrieveKeysAndLabels in interface OptionValueDriver

getConfigFileName

public ConfigFileName getConfigFileName()

Description copied from class: GrouperConfigurationModuleBase

config file name to check for properties and metadata

Specified by:

getConfigFileName in class GrouperConfigurationModuleBase

Returns:

getConfigItemPrefix

public String getConfigItemPrefix()

Description copied from class: GrouperConfigurationModuleBase

prefix for the properties eg: provisioner.someConfigId.

Specified by:

getConfigItemPrefix in class GrouperConfigurationModuleBase

Returns:

the prefix

getConfigIdRegex

public String getConfigIdRegex()

Description copied from class: GrouperConfigurationModuleBase

config id regeg eg: ^(provisioner)\\.([^.]+)\\.(.*)$

Specified by:

getConfigIdRegex in class GrouperConfigurationModuleBase

Returns:

getConfigurationTypePrefix

protected String getConfigurationTypePrefix()

Description copied from class: GrouperConfigurationModuleBase

for each type of configuration this is the prefix for eg in subsections. only ui concern in external text config.

Specified by:

getConfigurationTypePrefix in class GrouperConfigurationModuleBase

Returns:

getConfigIdThatIdentifiesThisConfig

public String getConfigIdThatIdentifiesThisConfig()

Description copied from class: GrouperConfigurationModuleBase

config id that identified this config. either suffix and value or getConfigIdThatIdentifiesThisConfig is required, not both. eg: personLdap

Overrides:

getConfigIdThatIdentifiesThisConfig in class GrouperConfigurationModuleBase

Returns:

getName

public String getName()

getActionType

public String getActionType()

retrieveAllUserLifecycleActionConfigurations

public static List<UserLifecycleActionConfiguration> retrieveAllUserLifecycleActionConfigurations()

list of configured user lifecycle action configs

Returns:

validatePreSave

public void validatePreSave(boolean isInsert,
 List<String> errorsToDisplay,
 Map<String,String> validationErrorsToDisplay)

Description copied from class: GrouperConfigurationModuleBase

validations to run before saving values into db

Overrides:

validatePreSave in class GrouperConfigurationModuleBase

insertConfig

public void insertConfig(boolean fromUi,
 StringBuilder message,
 List<String> errorsToDisplay,
 Map<String,String> validationErrorsToDisplay,
 List<String> actionsPerformed)

Description copied from class: GrouperConfigurationModuleBase

save the attribute in an insert. Note, if theres a failure, you should see if any made it

Overrides:

insertConfig in class GrouperConfigurationModuleBase

errorsToDisplay - call from ui: guiResponseJs.addAction(GuiScreenAction.newMessage(GuiMessageType.error, message.toString()));

validationErrorsToDisplay - call from ui: guiResponseJs.addAction(GuiScreenAction.newValidationMessage(GuiMessageType.error, validationKey, validationErrorsToDisplay.get(validationKey)));

deleteConfig

public void deleteConfig(boolean fromUi)

Description copied from class: GrouperConfigurationModuleBase

delete config

Overrides:

deleteConfig in class GrouperConfigurationModuleBase

editConfig

public void editConfig(boolean fromUi,
 StringBuilder message,
 List<String> errorsToDisplay,
 Map<String,String> validationErrorsToDisplay,
 List<String> actionsPerformed)

Description copied from class: GrouperConfigurationModuleBase

save the attribute in an edit. Note, if theres a failure, you should see if any made it

Overrides:

editConfig in class GrouperConfigurationModuleBase

errorsToDisplay - call from ui: guiResponseJs.addAction(GuiScreenAction.newMessage(GuiMessageType.error, message.toString()));

validationErrorsToDisplay - call from ui: guiResponseJs.addAction(GuiScreenAction.newValidationMessage(GuiMessageType.error, validationKey, validationErrorsToDisplay.get(validationKey)));

actionsPerformed - add to screen so user knows what is going on