com.atlassian.crowd.integration.atlassianuser
Class AbstractDynamicUserConfiguration

java.lang.Object
  extended by com.atlassian.crowd.integration.atlassianuser.AbstractDynamicUserConfiguration
All Implemented Interfaces:
DynamicUserConfiguration, com.atlassian.user.configuration.Configuration

public abstract class AbstractDynamicUserConfiguration
extends java.lang.Object
implements DynamicUserConfiguration


Field Summary
static java.lang.String SCHEDULE_JOB_KEY
           
 
Fields inherited from interface com.atlassian.user.configuration.Configuration
ACCESSOR, AUTHENTICATION, AUTHENTICATOR, BASE_CONTEXT, BASE_GROUP_NAMESPACE, BASE_USER_NAMESPACE, BATCH_SIZE, CACHE, CACHEFACTORY, CLASS, CLASSES, CONNECT_TIMEOUT, DEBUG, DEFAULT, DELEGATION, DESCRIPTION, EMAIL_ATTRIBUTE, ENTITY_QUERY_PARSER, EXTERNAL_ENTITY_DAO, EXTERNAL_REPOSITORY, FIRSTNAME_ATTRIBUTE, GROUP_SEARCH_ALL_DEPTHS, GROUP_SEARCH_FILTER, GROUPADAPTOR, GROUPFACTORY, GROUPMANAGER, GROUPNAME_ATTRIBUTE, HIBERNATE, HIBERNATE_CONFIGURATION_PROVIDER, HIBERNATE_SESSION_FACTORY, HOST, INITIAL_CONTEXT_FACTORY_JNDI, INITSIZE, KEY, LDAP, LDAP_CONNECTION_POOL_PROPERTIES, LDAP_SCHEMA_MAPPINGS_PROPERTIES, MAPPINGS, MAXSIZE, MEMBERSHIP_ATTRIBUTE, MEMORY, NAME, ORDER, OSU_ACCESS_PROVIDER, OSU_AUTHENTICATOR, OSU_CREDENTIALS_PROVIDER, OSU_CREDENTIALS_PROVIDER_LIST, OSU_PROFILE_PROVIDER, OSUSER, PARAM, PASSWORD_ENCRYPTOR, POOL_AUTHENTICATION, POOLING_ON, PORT, PREFSIZE, PROCESSOR, PROPERTYSET_FACTORY, PROVIDER_URL, READ_TIMEOUT, REPOSITORIES, REPOSITORY, SECURITY_CREDENTIAL, SECURITY_PRINCIPAL, SECURITY_PROTOCOL, SERVER, SURNAME_ATTRIBUTE, TIME_TO_LIVE, TIMEOUT, TRUSTSTORE, USE_UNQUALIFIED_USER_NAME_FOR_MEMBERSHIP_COMPARISON, USER_SEARCH_ALL_DEPTHS, USER_SEARCH_FILTER, USERADAPTOR, USERFACTORY, USERMANAGER, USERNAME_ATTRIBUTE
 
Constructor Summary
AbstractDynamicUserConfiguration(java.io.File configurationDirectory)
           
 
Method Summary
abstract  com.atlassian.user.configuration.Configuration createConfiguration()
           
 com.atlassian.user.configuration.DelegationAccessor getDelegationAccessor()
           
 void init()
           
 boolean isInitialized()
           
 void updateConfiguration(java.lang.Iterable<java.lang.String> adminGroupNamesToCheck)
          Reloads the user repository.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SCHEDULE_JOB_KEY

public static final java.lang.String SCHEDULE_JOB_KEY
See Also:
Constant Field Values
Constructor Detail

AbstractDynamicUserConfiguration

public AbstractDynamicUserConfiguration(java.io.File configurationDirectory)
                                 throws com.atlassian.user.configuration.ConfigurationException,
                                        java.io.IOException
Throws:
com.atlassian.user.configuration.ConfigurationException
java.io.IOException
Method Detail

getDelegationAccessor

public com.atlassian.user.configuration.DelegationAccessor getDelegationAccessor()
Specified by:
getDelegationAccessor in interface com.atlassian.user.configuration.Configuration

init

public void init()
Specified by:
init in interface com.atlassian.user.configuration.Configuration

isInitialized

public boolean isInitialized()
Specified by:
isInitialized in interface com.atlassian.user.configuration.Configuration

createConfiguration

public abstract com.atlassian.user.configuration.Configuration createConfiguration()
                                                                            throws com.atlassian.user.configuration.ConfigurationException,
                                                                                   java.io.IOException
Throws:
com.atlassian.user.configuration.ConfigurationException
java.io.IOException

updateConfiguration

public final void updateConfiguration(java.lang.Iterable<java.lang.String> adminGroupNamesToCheck)
                               throws com.atlassian.user.configuration.ConfigurationException,
                                      java.io.IOException
Description copied from interface: DynamicUserConfiguration
Reloads the user repository.

If adminGroupNamesToCheck is not null, the update will fail if none of the given group names contains any users. This can be used to ensure that the new configuration will contain at least one admin user.

Specified by:
updateConfiguration in interface DynamicUserConfiguration
Parameters:
adminGroupNamesToCheck - admin groups to check for users
Throws:
com.atlassian.user.configuration.ConfigurationException - if the new repository could not be loaded
java.io.IOException - if there was an error reading configuration files


Copyright © 2012 Atlassian. All Rights Reserved.