com.communote.plugin.ldap

Class LdapUserRepository

java.lang.Object

com.communote.server.core.external.AbstractExternalUserRepository

com.communote.plugin.ldap.LdapUserRepository

All Implemented Interfaces:

Orderable, PropertyKeys, ExternalUserRepository

public class LdapUserRepository
extends AbstractExternalUserRepository
implements PropertyKeys

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTERNAL_SYSTEM_ID_DEFAULT_LDAP Default Ldap it.

Fields inherited from interface com.communote.plugin.ldap.PropertyKeys

PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_ALLOW_PAGING, PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_ENABLED_GROUP, PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_ENABLED_USER, PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_PAGING_SIZE, PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_TIME_OUT, PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_USER_SEQUENCE_NUMBER

Constructor Summary

Constructors

Constructor and Description
LdapUserRepository(org.osgi.framework.BundleContext bundleContext) Default constructor setting the default system id

Method Summary

Modifier and Type	Method and Description
LdapConfiguration	createConfiguration() Create an empty configuration.
LdapConfiguration	getConfiguration() Get the ldap configuration of the client
Collection<StringPropertyTO>	getExternalLoginProperties(Long userId, ExternalUserAuthentication externalUserAuthentication) External Repos can return additional properties that will be included e.g.
ExternalUserGroupAccessor	getExternalUserGroupAccessor() Get the external user group accessor if user repository is also an group repository
IncrementalRepositoryChangeTracker	getIncrementalRepositoryChangeTracker(boolean doFullSynchronization) Method to get an tracker for changes within an external repository.
LocalizedMessage	getName()
Set<UserProfileFields>	getProvidedProfileFieldNames()
ExternalUserVO	getUser(String externalUserId) Get external user from ldap repository
boolean	isIncrementalSynchronizationAvailable()
void	start()
void	stop()

Methods inherited from class com.communote.server.core.external.AbstractExternalUserRepository

getExternalSystemId, getOrder, getUser, isActive, isConfigurationSet, showInIntegrationOverview

Methods inherited from class java.lang.Object

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

Field Detail

EXTERNAL_SYSTEM_ID_DEFAULT_LDAP

public static final String EXTERNAL_SYSTEM_ID_DEFAULT_LDAP

Default Ldap it.

See Also:

Constant Field Values

Constructor Detail

LdapUserRepository

public LdapUserRepository(org.osgi.framework.BundleContext bundleContext)

Default constructor setting the default system id

Method Detail

createConfiguration

public LdapConfiguration createConfiguration()

Create an empty configuration. E.g. to access the configuration url and name if no configuration exists.

Specified by:

createConfiguration in interface ExternalUserRepository

Returns:

the empty configuration

getConfiguration

public LdapConfiguration getConfiguration()

Get the ldap configuration of the client

Specified by:

getConfiguration in interface ExternalUserRepository

Returns:

LdapConfiguration

getExternalLoginProperties

public Collection<StringPropertyTO> getExternalLoginProperties(Long userId,
                                                               ExternalUserAuthentication externalUserAuthentication)
                                                        throws AuthorizationException

Description copied from interface: ExternalUserRepository

External Repos can return additional properties that will be included e.g. in the rest resource

Specified by:

getExternalLoginProperties in interface ExternalUserRepository

Parameters:

userId - the id of the user the authentication is for

externalUserAuthentication - the authentication to get additional properties for

Returns:

Throws:

AuthorizationException

getExternalUserGroupAccessor

public ExternalUserGroupAccessor getExternalUserGroupAccessor()

Get the external user group accessor if user repository is also an group repository

Specified by:

getExternalUserGroupAccessor in interface ExternalUserRepository

Overrides:

getExternalUserGroupAccessor in class AbstractExternalUserRepository

Returns:

the external user group accessor or null if repository is not an group repository.

getIncrementalRepositoryChangeTracker

public IncrementalRepositoryChangeTracker getIncrementalRepositoryChangeTracker(boolean doFullSynchronization)

Method to get an tracker for changes within an external repository. This method should only return an object, if the incremental changes are possible and enabled.

Specified by:

getIncrementalRepositoryChangeTracker in interface ExternalUserRepository

Overrides:

getIncrementalRepositoryChangeTracker in class AbstractExternalUserRepository

Parameters:

doFullSynchronization - If set to true, a full synchronization should be done.

Returns:

null

getName

public LocalizedMessage getName()

Specified by:

getName in interface ExternalUserRepository

Returns:

a user friendly name of the repository

getProvidedProfileFieldNames

public Set<UserProfileFields> getProvidedProfileFieldNames()

Specified by:

getProvidedProfileFieldNames in interface ExternalUserRepository

Returns:

the names of the user profile fields this user repository provides for all its users. If no fields are provided an empty set has to be returned.

getUser

public ExternalUserVO getUser(String externalUserId)
                       throws ExternalRepositoryException

Get external user from ldap repository

Specified by:

getUser in interface ExternalUserRepository

Parameters:

externalUserId - external user identifier conform with the alias in ldap

Returns:

ExternalUserVO

Throws:

ExternalRepositoryException - external repository exception

isIncrementalSynchronizationAvailable

public boolean isIncrementalSynchronizationAvailable()

Specified by:

isIncrementalSynchronizationAvailable in interface ExternalUserRepository

Overrides:

isIncrementalSynchronizationAvailable in class AbstractExternalUserRepository

Returns:

IncrementalRepositoryChangeTrackerFactory != null

start

public void start()

stop

public void stop()