edu.internet2.middleware.grouper.app.customUi

Class CustomUiConfiguration

java.lang.Object

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

edu.internet2.middleware.grouper.app.customUi.CustomUiConfiguration

public class CustomUiConfiguration
extends GrouperConfigurationModuleBase

Field Summary

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

attributeCache, extraConfigKeys

Constructor Summary

Constructors

Constructor and Description
CustomUiConfiguration()

Method Summary

Modifier and Type	Method and Description
void	changeStatus(boolean enable, StringBuilder message, List<String> errorsToDisplay, Map<String,String> validationErrorsToDisplay) change status of config to disable/enable
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.
String	getConfigItemPrefix() prefix for the properties eg: provisioner.
protected String	getConfigurationTypePrefix() for each type of configuration this is the prefix for eg in subsections.
String	getGroupId()
boolean	isEnabled() is the config enabled or not
static List<CustomUiConfiguration>	retrieveAllCustomUiConfigs() list of configured custom ui configs
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

clearAttributeCache, deleteConfig, editConfig, formatIndexes, getCacheAttributePrefix, getCacheEntityAttributePrefix, getCacheFieldPrefix, getCacheGroupAttributePrefix, getConfigId, getDescription, getGenericConfigId, getPropertySuffixThatIdentifiesThisConfig, getPropertyValueThatIdentifiesThisConfig, getSubSections, getTitle, insertConfig, isMultiple, listAllConfigurationsOfThisType, populateConfigurationValuesFromUi, populateValuesLabelsFromOptionValueClass, retrieveAllConfigurations, retrieveAllConfigurationTypesHelper, retrieveAttributes, retrieveConfigurationConfigIds, retrieveConfigurationKeysByPrefix, retrieveExtraConfigKeys, retrieveObjectValueSubstituteMap, retrieveSuffix, setConfigId, showAttributeOverride

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomUiConfiguration

public CustomUiConfiguration()

Method Detail

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.

Specified by:

getConfigItemPrefix in class GrouperConfigurationModuleBase

Returns:

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:

retrieveAllCustomUiConfigs

public static List<CustomUiConfiguration> retrieveAllCustomUiConfigs()

list of configured custom ui configs

Returns:

isEnabled

public boolean isEnabled()

is the config enabled or not

Overrides:

isEnabled in class GrouperConfigurationModuleBase

Returns:

getGroupId

public String getGroupId()

changeStatus

public void changeStatus(boolean enable,
                         StringBuilder message,
                         List<String> errorsToDisplay,
                         Map<String,String> validationErrorsToDisplay)

change status of config to disable/enable

Parameters:

enable -

message -

errorsToDisplay -

validationErrorsToDisplay -

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