Package edu.internet2.middleware.grouper.app.boxProvisioner

Class BoxProvisionerConfiguration

java.lang.Object

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

edu.internet2.middleware.grouper.app.provisioning.ProvisioningConfiguration

edu.internet2.middleware.grouper.app.boxProvisioner.BoxProvisionerConfiguration

public class BoxProvisionerConfiguration
extends ProvisioningConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	startWithConfigClassNames

Fields inherited from class edu.internet2.middleware.grouper.app.provisioning.ProvisioningConfiguration

provisionerConfigClassNames

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

attributeCache, extraConfigKeys

Constructor Summary

Constructors

Constructor	Description
BoxProvisionerConfiguration()

Method Summary

Modifier and Type	Method	Description
void	editConfig(boolean fromUi, StringBuilder message, List<String> errorsToDisplay, Map<String,String> validationErrorsToDisplay, List<String> actionsPerformed)	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	getConfigItemPrefix()	prefix for the properties eg: provisioner.someConfigId.
String	getPropertySuffixThatIdentifiesThisConfig()	property suffix that will be used to identify the config eg class
String	getPropertyValueThatIdentifiesThisConfig()	property value that identifies the config.
List<ProvisionerStartWithBase>	getStartWithConfigClasses()	Classes that are configured to give a starting point for setting up provisioners.
void	insertConfig(boolean fromUi, StringBuilder message, List<String> errorsToDisplay, Map<String,String> validationErrorsToDisplay, List<String> actionsPerformed)	save the attribute in an insert.
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.provisioning.ProvisioningConfiguration

addDaemonsIfNecessary, correctFormFieldsForExpressionLanguageValues, deleteConfig, getConfigurationTypePrefix, getGenericConfigId, getSyncDetails, getSyncStats, isSubjectInAssignOrViewGroup, retrieveAllAssignableProvisioningConfigurations, retrieveAllProvisioningConfigurations, retrieveAllProvisioningConfigurationTypes, retrieveAllViewableProvisioningConfigurations, retrieveConfigurationByConfigSuffix, validatePreSaveNonProvisionerSpecific

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

changeStatus, clearAttributeCache, formatIndexes, getCacheAttributePrefix, getCacheEntityAttributePrefix, getCacheGroupAttributePrefix, getCacheMembershipAttributePrefix, getConfigId, getConfigIdThatIdentifiesThisConfig, getDescription, getDocumentation, 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

Field Details

startWithConfigClassNames

public static final Set<String> startWithConfigClassNames

Constructor Details

BoxProvisionerConfiguration

public BoxProvisionerConfiguration()

Method Details

getStartWithConfigClasses

public List<ProvisionerStartWithBase> getStartWithConfigClasses()

Description copied from class: ProvisioningConfiguration

Classes that are configured to give a starting point for setting up provisioners. These are spefici to provisioner type e.g. Sql provisioner have SqlProvisioningGroupTableStartWith, SqlProvisioningEntityTableStartWith, SqlProvisioningGroupAndMembershipTableStartWith

Overrides:

getStartWithConfigClasses in class ProvisioningConfiguration

Returns:

list of start with classes

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:

getPropertySuffixThatIdentifiesThisConfig

public String getPropertySuffixThatIdentifiesThisConfig()

Description copied from class: GrouperConfigurationModuleBase

property suffix that will be used to identify the config eg class

Overrides:

getPropertySuffixThatIdentifiesThisConfig in class GrouperConfigurationModuleBase

Returns:

getPropertyValueThatIdentifiesThisConfig

public String getPropertyValueThatIdentifiesThisConfig()

Description copied from class: GrouperConfigurationModuleBase

property value that identifies the config. Suffix is required for this property to be useful. eg: edu.internet2.middleware.grouper.app.ldapProvisioning.LdapSync

Overrides:

getPropertyValueThatIdentifiesThisConfig in class GrouperConfigurationModuleBase

Returns:

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 ProvisioningConfiguration

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,
 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 ProvisioningConfiguration

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

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 ProvisioningConfiguration