com.atlassian.crowd.integration.atlassianuser
Interface UserConfigurationPersister

All Known Implementing Classes:

UserConfigurationPersisterImpl

public interface UserConfigurationPersister

Provides functionality for working with Atlassian User library configuration.

Method Summary

void	detectPersistedConfigurationType() Detects the persisted configuration type.
java.io.InputStream	getConfigurationStream() Returns the active configuration.
UserConfigurationType	getConfigurationType() Returns the current configuration type
boolean	isCustomConfigurationAvailable() Returns true if a custom Atlassian User configuration file is available.
void	updateConfiguration(UserConfigurationType newConfigurationType) Updates configuration to the given configuration type.

Method Detail

getConfigurationStream

java.io.InputStream getConfigurationStream()
                                           throws java.io.IOException

Returns the active configuration.

Returns:

active configuration

Throws:

java.io.IOException - if the file cannot be read

updateConfiguration

void updateConfiguration(@NotNull
                         UserConfigurationType newConfigurationType)
                         throws java.io.IOException

Updates configuration to the given configuration type.

Parameters:

newConfigurationType - new configuration type

Throws:

java.io.IOException - If the configuration could not be updated

getConfigurationType

UserConfigurationType getConfigurationType()

Returns the current configuration type

Returns:

current configuration type

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

detectPersistedConfigurationType

void detectPersistedConfigurationType()
                                      throws java.io.IOException

Detects the persisted configuration type.

Should be called when it is likely that atlassian-user.xml has been modified.

Throws:

java.io.IOException - if the persistent configuration could not be read