edu.internet2.middleware.grouper.app.externalSystem

Class GrouperExternalSystem

java.lang.Object

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

edu.internet2.middleware.grouper.app.externalSystem.GrouperExternalSystem

All Implemented Interfaces:

OptionValueDriver

Direct Known Subclasses:

AzureGrouperExternalSystem, DatabaseGrouperExternalSystem, DuoGrouperExternalSystem, GrouperInternalMessagingExternalSystem, LdapGrouperExternalSystem, RemedyDigitalMarketplaceGrouperExternalSystem, RemedyGrouperExternalSystem, SftpGrouperExternalSystem, SmtpGrouperExternalSystem, WsBearerTokenExternalSystem

public abstract class GrouperExternalSystem
extends GrouperConfigurationModuleBase
implements OptionValueDriver

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	externalTypeClassNames

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

attributeCache, extraConfigKeys

Constructor Summary

Constructors

Constructor and Description
GrouperExternalSystem()

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
protected String	getConfigurationTypePrefix() for each type of configuration this is the prefix for eg in subsections.
boolean	isCanAdd()
boolean	isCanDelete()
boolean	isEnabled() is the config enabled or not
String	propertiesApiProperyValue(String attributeName) get value for one property
void	refreshConnectionsIfNeeded() check if connections need to be refreshed due to config changes
static List<GrouperExternalSystem>	retrieveAllGrouperExternalSystems() list of configured external systems
static List<GrouperExternalSystem>	retrieveAllModuleConfigurationTypes() list of systems that can be configured
List<GrouperExternalSystemConsumer>	retrieveAllUsedBy()
List<MultiKey>	retrieveKeysAndLabels()
List<String>	test() return list of error messages
void	validatePreSave(boolean isInsert, boolean fromUi, List<String> errorsToDisplay, Map<String,String> validationErrorsToDisplay)

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.internet2.middleware.grouper.cfg.dbConfig.OptionValueDriver

setConfigSuffixToConfigModuleAttribute

Field Detail

externalTypeClassNames

public static final Set<String> externalTypeClassNames

Constructor Detail

GrouperExternalSystem

public GrouperExternalSystem()

Method Detail

test

public List<String> test()
                  throws UnsupportedOperationException

return list of error messages

Returns:

Throws:

UnsupportedOperationException

validatePreSave

public void validatePreSave(boolean isInsert,
                            boolean fromUi,
                            List<String> errorsToDisplay,
                            Map<String,String> validationErrorsToDisplay)

Parameters:

isInsert -

fromUi -

errorsToDisplay -

validationErrorsToDisplay -

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:

retrieveAllUsedBy

public List<GrouperExternalSystemConsumer> retrieveAllUsedBy()
                                                      throws UnsupportedOperationException

Returns:

Throws:

UnsupportedOperationException

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 -

propertiesApiProperyValue

public String propertiesApiProperyValue(String attributeName)

get value for one property

Parameters:

attributeName -

Returns:

retrieveAllModuleConfigurationTypes

public static List<GrouperExternalSystem> retrieveAllModuleConfigurationTypes()

list of systems that can be configured

Returns:

retrieveAllGrouperExternalSystems

public static List<GrouperExternalSystem> retrieveAllGrouperExternalSystems()

list of configured external systems

Returns:

retrieveKeysAndLabels

public List<MultiKey> retrieveKeysAndLabels()

Specified by:

retrieveKeysAndLabels in interface OptionValueDriver

refreshConnectionsIfNeeded

public void refreshConnectionsIfNeeded()
                                throws UnsupportedOperationException

check if connections need to be refreshed due to config changes

Throws:

UnsupportedOperationException

isCanAdd

public boolean isCanAdd()

isCanDelete

public boolean isCanDelete()