Package edu.internet2.middleware.grouper.app.provisioning

Class ProvisioningConfiguration

java.lang.Object

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

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

Direct Known Subclasses:

AzureProvisionerConfiguration, BoxProvisionerConfiguration, DigitalMarketplaceProvisionerConfiguration, DuoProvisionerConfiguration, DuoRoleProvisionerConfiguration, ExampleGroupProvisionerConfiguration, ExampleWsProvisionerConfiguration, GenericProvisionerConfiguration, GoogleProvisionerConfiguration, GrouperScim2Configuration, LdapProvisionerConfiguration, MessagingProvisionerConfiguration, MidPointProvisionerConfiguration, RemedyProvisionerConfiguration, SqlProvisionerConfiguration, TeamDynamixProvisionerConfiguration

public abstract class ProvisioningConfiguration
extends GrouperConfigurationModuleBase

Field Summary

Fields

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

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

attributeCache, extraConfigKeys

Constructor Summary

Constructors

Constructor	Description
ProvisioningConfiguration()

Method Summary

Modifier and Type	Method	Description
void	addDaemonsIfNecessary(StringBuilder message, List<String> errorsToDisplay, Map<String,String> validationErrorsToDisplay)
void	correctFormFieldsForExpressionLanguageValues()
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.
protected String	getConfigurationTypePrefix()	for each type of configuration this is the prefix for eg in subsections.
protected String	getGenericConfigId()
List<ProvisionerStartWithBase>	getStartWithConfigClasses()	Classes that are configured to give a starting point for setting up provisioners.
ProvisioningConfigSyncDetails	getSyncDetails()	get sync details for a provisioner config
ProvisioningConfigSyncStats	getSyncStats()	get sync stats for a provisioner config
void	insertConfig(boolean fromUi, StringBuilder message, List<String> errorsToDisplay, Map<String,String> validationErrorsToDisplay, List<String> actionsPerformed)	save the attribute in an insert.
static boolean	isSubjectInAssignOrViewGroup(String suffix, Subject subject, ProvisioningConfiguration provisioningConfiguration)	check if subject is member of allowedToAssign or allowedToView group
static List<ProvisioningConfiguration>	retrieveAllAssignableProvisioningConfigurations(Subject subject)	list of configured provisioner systems that are assignable for the subject
static List<ProvisioningConfiguration>	retrieveAllProvisioningConfigurations()	list of configured provisioner systems
static List<ProvisioningConfiguration>	retrieveAllProvisioningConfigurationTypes()	list of systems that can be configured
static List<ProvisioningConfiguration>	retrieveAllViewableProvisioningConfigurations(Subject subject)	list of configured provisioner systems that are viewable for the subject
static ProvisioningConfiguration	retrieveConfigurationByConfigSuffix(String propertyValueThatIdentifiesThisDaemon)
void	validatePreSave(boolean isInsert, List<String> errorsToDisplay, Map<String,String> validationErrorsToDisplay)	validations to run before saving values into db
void	validatePreSaveNonProvisionerSpecific(boolean isInsert, List<String> errorsToDisplay, Map<String,String> validationErrorsToDisplay)

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

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

Field Details

provisionerConfigClassNames

public static final Set<String> provisionerConfigClassNames

Constructor Details

ProvisioningConfiguration

public ProvisioningConfiguration()

Method Details

retrieveConfigurationByConfigSuffix

public static ProvisioningConfiguration retrieveConfigurationByConfigSuffix(String propertyValueThatIdentifiesThisDaemon)

getStartWithConfigClasses

public List<ProvisionerStartWithBase> getStartWithConfigClasses()

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

Returns:

list of start with classes

retrieveAllProvisioningConfigurationTypes

public static List<ProvisioningConfiguration> retrieveAllProvisioningConfigurationTypes()

list of systems that can be configured

Returns:

retrieveAllProvisioningConfigurations

public static List<ProvisioningConfiguration> retrieveAllProvisioningConfigurations()

list of configured provisioner systems

Returns:

retrieveAllViewableProvisioningConfigurations

public static List<ProvisioningConfiguration> retrieveAllViewableProvisioningConfigurations(Subject subject)

list of configured provisioner systems that are viewable for the subject

Parameters:

subject - - subject for whom to retrive all viewable provisioning configs

Returns:

retrieveAllAssignableProvisioningConfigurations

public static List<ProvisioningConfiguration> retrieveAllAssignableProvisioningConfigurations(Subject subject)

list of configured provisioner systems that are assignable for the subject

Parameters:

subject - - subject for whom to retrive all assignable provisioning configs

Returns:

isSubjectInAssignOrViewGroup

public static boolean isSubjectInAssignOrViewGroup(String suffix,
 Subject subject,
 ProvisioningConfiguration provisioningConfiguration)

check if subject is member of allowedToAssign or allowedToView group

Parameters:

suffix -

subject -

provisioningConfiguration -

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:

getGenericConfigId

protected String getGenericConfigId()

Overrides:

getGenericConfigId in class GrouperConfigurationModuleBase

deleteConfig

public void deleteConfig(boolean fromUi)

Description copied from class: GrouperConfigurationModuleBase

delete config

Overrides:

deleteConfig in class GrouperConfigurationModuleBase

getSyncDetails

public ProvisioningConfigSyncDetails getSyncDetails()

get sync details for a provisioner config

Returns:

getSyncStats

public ProvisioningConfigSyncStats getSyncStats()

get sync stats for a provisioner config

Returns:

validatePreSaveNonProvisionerSpecific

public void validatePreSaveNonProvisionerSpecific(boolean isInsert,
 List<String> errorsToDisplay,
 Map<String,String> 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

correctFormFieldsForExpressionLanguageValues

public void correctFormFieldsForExpressionLanguageValues()

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

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

addDaemonsIfNecessary

public void addDaemonsIfNecessary(StringBuilder message,
 List<String> errorsToDisplay,
 Map<String,String> validationErrorsToDisplay)