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

Class ProvisionerStartWithBase

java.lang.Object

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

edu.internet2.middleware.grouper.app.provisioning.ProvisionerStartWithBase

Direct Known Subclasses:

AzureProvisioningStartWith, BoxProvisioningStartWith, DuoProvisioningStartWith, DuoRoleProvisioningStartWith, ExampleWsProvisioningStartWith, GoogleProvisioningStartWith, LdapProvisioningMembershipStartWith, MessagingProvisioningStartWith, RemedyProvisioningStartWith, ScimProvisioningStartWith, SqlProvisioningStartWith, TeamDynamixProvisioningStartWith

public abstract class ProvisionerStartWithBase
extends GrouperConfigurationModuleBase

Field Summary

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

attributeCache, extraConfigKeys

Constructor Summary

Constructors

Constructor	Description
ProvisionerStartWithBase()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getCachedConfigKeyToValue(String sessionId)
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.
protected String	getConfigurationTypePrefix()	for each type of configuration this is the prefix for eg in subsections.
String	getPropertySuffixThatIdentifiesThisConfig()	property suffix that will be used to identify the config eg class
abstract Class<? extends ProvisioningConfiguration>	getProvisioningConfiguration()
void	manipulateProvisionerConfigurationValue(String configId, Map<String,String> startWithSuffixToValue, Map<String,Object> provisionerSuffixToValue)	call this method after populateProvisionerConfigurationValuesFromStartWith to copy startWith values over to provisionerSuffixToValue where key for startWith matches key in provisionerSuffixToValue
void	populateCache(String sessionId, Map<String,String> configKeyToValue)
abstract void	populateProvisionerConfigurationValuesFromStartWith(Map<String,String> startWithSuffixToValue, Map<String,Object> provisionerSuffixToValue)	populate provisionerSuffixToValue with values that are driven off of values from startWithSuffixToValue
Map<String,String>	screenRedraw(Map<String,String> suffixToValue, Set<String> suffixesUserJustChanged)	Called everytime screen is redrawn, called before showEl is calculated.
static void	setValuesToNull(Map<String,String> map, Set<String> keysToKeep, Set<String> allKeysToSetToNull)	In the map, set all allKeysToSetToNull keys to null except in keysToKeep

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

ProvisionerStartWithBase

public ProvisionerStartWithBase()

Method Details

populateCache

public void populateCache(String sessionId,
 Map<String,String> configKeyToValue)

getCachedConfigKeyToValue

public Map<String,String> getCachedConfigKeyToValue(String sessionId)

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:

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:

populateProvisionerConfigurationValuesFromStartWith

public abstract void populateProvisionerConfigurationValuesFromStartWith(Map<String,String> startWithSuffixToValue,
 Map<String,Object> provisionerSuffixToValue)

populate provisionerSuffixToValue with values that are driven off of values from startWithSuffixToValue

Parameters:

startWithSuffixToValue -

provisionerSuffixToValue -

manipulateProvisionerConfigurationValue

public void manipulateProvisionerConfigurationValue(String configId,
 Map<String,String> startWithSuffixToValue,
 Map<String,Object> provisionerSuffixToValue)

call this method after populateProvisionerConfigurationValuesFromStartWith to copy startWith values over to provisionerSuffixToValue where key for startWith matches key in provisionerSuffixToValue

Parameters:

configId -

startWithSuffixToValue -

provisionerSuffixToValue -

setValuesToNull

public static void setValuesToNull(Map<String,String> map,
 Set<String> keysToKeep,
 Set<String> allKeysToSetToNull)

In the map, set all allKeysToSetToNull keys to null except in keysToKeep

Parameters:

map -

keysToKeep -

allKeysToSetToNull -

screenRedraw

public Map<String,String> screenRedraw(Map<String,String> suffixToValue,
 Set<String> suffixesUserJustChanged)

Called everytime screen is redrawn, called before showEl is calculated.

Parameters:

suffixToValue - - current config submitted by the user

suffixesUserJustChanged - - what the user edited since the last submit to the server

Returns:

- suffix to value of things that should change on the screen

getProvisioningConfiguration

public abstract Class<? extends ProvisioningConfiguration> getProvisioningConfiguration()