com.atlassian.crowd.integration.atlassianuser

Interface UserConfigurationService

All Known Implementing Classes:

UserConfigurationServiceImpl

public interface UserConfigurationService

Provides services for dynamically changing the behaviour of Atlassian User library.

Method Summary

Methods

Modifier and Type	Method and Description
void	changeUserConfigurationType(UserConfigurationType configurationType, Properties crowdProperties) Changes the application to use a new configuration at runtime.
Properties	getCrowdProperties() Returns Crowd related properties.
UserConfigurationType	getUserConfigurationType() Returns Atlassian User configuration type that is currently active.
boolean	isCrowdPropertyWritable(String crowdPropertyName) Returns true if the given Crowd property can be modified.
boolean	isCustomConfigurationAvailable() Returns true if a custom Atlassian User configuration file is available.
void	reloadUserConfiguration() Reloads user configuration using the current configuration.

Method Detail

getUserConfigurationType

UserConfigurationType getUserConfigurationType()

Returns Atlassian User configuration type that is currently active.

Returns:

configuration type that is currently active

changeUserConfigurationType

void changeUserConfigurationType(@NotNull
                               UserConfigurationType configurationType,
                               @Nullable
                               Properties crowdProperties)
                                 throws IOException,
                                        com.atlassian.user.configuration.ConfigurationException

Changes the application to use a new configuration at runtime.

Parameters:

configurationType - new configuration type to use

crowdProperties - new crowd configuration properties to use

Throws:

IOException - if the configuration could not be updated

com.atlassian.user.configuration.ConfigurationException - if the configuration could not be loaded

reloadUserConfiguration

void reloadUserConfiguration()
                             throws com.atlassian.user.configuration.ConfigurationException,
                                    IOException

Reloads user configuration using the current configuration.

Throws:

IOException - if the configuration could not be loaded

com.atlassian.user.configuration.ConfigurationException - if the configuration could not be loaded

isCustomConfigurationAvailable

boolean isCustomConfigurationAvailable()

Returns true if a custom Atlassian User configuration file is available.

Returns:

true if a custom Atlassian User configuration file is available

getCrowdProperties

Properties getCrowdProperties()

Returns Crowd related properties.

Returns:

Crowd related properties

isCrowdPropertyWritable

boolean isCrowdPropertyWritable(@NotNull
                              String crowdPropertyName)

Returns true if the given Crowd property can be modified.

Parameters:

crowdPropertyName - Crowd property name

Returns:

true if the given Crowd property can be modified