edu.internet2.middleware.grouper.app.gsh.template

Class GshTemplateConfiguration

java.lang.Object

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

edu.internet2.middleware.grouper.app.gsh.template.GshTemplateConfiguration

public class GshTemplateConfiguration
extends GrouperConfigurationModuleBase

Field Summary

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

attributeCache, extraConfigKeys

Constructor Summary

Constructors

Constructor and Description
GshTemplateConfiguration()

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
void	deleteConfig(boolean fromUi) delete config
void	editConfig(boolean fromUi, StringBuilder message, List<String> errorsToDisplay, Map<String,String> validationErrorsToDisplay) save the attribute in an edit.
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.
void	insertConfig(boolean fromUi, StringBuilder message, List<String> errorsToDisplay, Map<String,String> validationErrorsToDisplay) save the attribute in an insert.
boolean	isEnabled() is the config enabled or not
static List<GshTemplateConfiguration>	retrieveAllGshTemplateConfigs() list of configured gsh template 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, formatIndexes, getCacheAttributePrefix, getCacheEntityAttributePrefix, getCacheFieldPrefix, getCacheGroupAttributePrefix, getConfigId, getDescription, getGenericConfigId, getPropertySuffixThatIdentifiesThisConfig, getPropertyValueThatIdentifiesThisConfig, getSubSections, getTitle, 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

GshTemplateConfiguration

public GshTemplateConfiguration()

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:

retrieveAllGshTemplateConfigs

public static List<GshTemplateConfiguration> retrieveAllGshTemplateConfigs()

list of configured gsh template configs

Returns:

isEnabled

public boolean isEnabled()

is the config enabled or not

Overrides:

isEnabled in class GrouperConfigurationModuleBase

Returns:

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

insertConfig

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

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)));

editConfig

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

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)));

deleteConfig

public void deleteConfig(boolean fromUi)

Description copied from class: GrouperConfigurationModuleBase

delete config

Overrides:

deleteConfig in class GrouperConfigurationModuleBase