com.communote.server.core.external

Class AbstractExternalUserRepository

java.lang.Object

com.communote.server.core.external.AbstractExternalUserRepository

All Implemented Interfaces:

Orderable, ExternalUserRepository

Direct Known Subclasses:

ConfluenceUserRepository, LdapUserRepository

public abstract class AbstractExternalUserRepository
extends Object
implements ExternalUserRepository

Author:

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

Constructor Summary

Constructors

Constructor and Description
AbstractExternalUserRepository(String defaultExternalSystemId)

Method Summary

Modifier and Type	Method and Description
String	getExternalSystemId() Get the external system identifier
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.
int	getOrder()
ExternalUserVO	getUser(UserIdentification userIdentification) Get the ExternalUserVO of the UserIdentification
boolean	isActive() Check if configuration is set
protected boolean	isConfigurationSet()
boolean	isIncrementalSynchronizationAvailable()
boolean	showInIntegrationOverview()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.communote.server.core.external.ExternalUserRepository

createConfiguration, getConfiguration, getExternalLoginProperties, getName, getProvidedProfileFieldNames, getUser

Constructor Detail

AbstractExternalUserRepository

public AbstractExternalUserRepository(String defaultExternalSystemId)

Parameters:

defaultExternalSystemId - use this id as defaultExternalSystemId (see and #getExternalSystemId()

Method Detail

getExternalSystemId

public String getExternalSystemId()

Get the external system identifier

Specified by:

getExternalSystemId in interface ExternalUserRepository

Returns:

external system identifier or null

getExternalUserGroupAccessor

public ExternalUserGroupAccessor getExternalUserGroupAccessor()

Description copied from interface: ExternalUserRepository

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

Specified by:

getExternalUserGroupAccessor in interface ExternalUserRepository

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

Parameters:

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

Returns:

null

getOrder

public int getOrder()

Specified by:

getOrder in interface Orderable

Returns:

the value for ordering this object

getUser

public ExternalUserVO getUser(UserIdentification userIdentification)
                       throws ExternalRepositoryException

Get the ExternalUserVO of the UserIdentification

Specified by:

getUser in interface ExternalUserRepository

Parameters:

userIdentification - UserIdentification

Returns:

ExternalUserVO

Throws:

ExternalRepositoryException - repository exception

isActive

public boolean isActive()

Check if configuration is set

Specified by:

isActive in interface ExternalUserRepository

Returns:

true or false

isConfigurationSet

protected boolean isConfigurationSet()

isIncrementalSynchronizationAvailable

public boolean isIncrementalSynchronizationAvailable()

Specified by:

isIncrementalSynchronizationAvailable in interface ExternalUserRepository

Returns:

false

showInIntegrationOverview

public boolean showInIntegrationOverview()

Specified by:

showInIntegrationOverview in interface ExternalUserRepository

Returns:

True to show the repo in the Integration overview.