com.communote.server.core.external

Interface ExternalUserRepository

All Superinterfaces:

Orderable

All Known Implementing Classes:

AbstractExternalUserRepository, ConfluenceUserRepository, LdapUserRepository

public interface ExternalUserRepository
extends Orderable

Author:

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

Method Summary

Modifier and Type	Method and Description
ExternalSystemConfiguration	createConfiguration() Create an empty configuration.
ExternalSystemConfiguration	getConfiguration() Gets the external system configuration
Collection<StringPropertyTO>	getExternalLoginProperties(Long userId, ExternalUserAuthentication externalUserAuthentication) External Repos can return additional properties that will be included e.g.
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.
LocalizedMessage	getName()
Set<UserProfileFields>	getProvidedProfileFieldNames()
ExternalUserVO	getUser(String externalUserId) Get the ExternalUserVO of the external user identifier
ExternalUserVO	getUser(UserIdentification userIdentification) Get the ExternalUserVO for the UserIdentification.
boolean	isActive() Check if external repo is active and can be used
boolean	isIncrementalSynchronizationAvailable()
boolean	showInIntegrationOverview()

Methods inherited from interface com.communote.common.util.Orderable

getOrder

Method Detail

createConfiguration

ExternalSystemConfiguration createConfiguration()

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

Returns:

the empty configuration

getConfiguration

ExternalSystemConfiguration getConfiguration()

Gets the external system configuration

Returns:

ExternalSystemConfiguration set, is null if not configured

getExternalLoginProperties

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

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

Parameters:

userId - the id of the user the authentication is for

externalUserAuthentication - the authentication to get additional properties for

Returns:

Throws:

AuthorizationException

getExternalSystemId

String getExternalSystemId()

Get the external system identifier.

Returns:

external system identifier

getExternalUserGroupAccessor

ExternalUserGroupAccessor getExternalUserGroupAccessor()

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

Returns:

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

getIncrementalRepositoryChangeTracker

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.

Parameters:

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

Returns:

A tracker, if incremental synchronization is possible and enabled, else false.

getName

LocalizedMessage getName()

Returns:

a user friendly name of the repository

getProvidedProfileFieldNames

Set<UserProfileFields> getProvidedProfileFieldNames()

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

ExternalUserVO getUser(String externalUserId)
                throws ExternalRepositoryException

Get the ExternalUserVO of the external user identifier

Parameters:

externalUserId - external user identifier

Returns:

ExternalUserVO

Throws:

ExternalRepositoryException - repository exception

getUser

ExternalUserVO getUser(UserIdentification userIdentification)
                throws ExternalRepositoryException

Get the ExternalUserVO for the UserIdentification. The UserIdentification provides information about internal id, external id and so on. The external user repo implementation of this method must considered the following:
the internal id or alias have not been evaluated so far if the external system id is set or a primary id is given the external system id of the user identification does not have to match the system id of this repo, e.g. if a primary repo is given

Parameters:

userIdentification - UserIdentification

Returns:

ExternalUserVO

Throws:

ExternalRepositoryException - repository exception

isActive

boolean isActive()

Check if external repo is active and can be used

Returns:

true or false

isIncrementalSynchronizationAvailable

boolean isIncrementalSynchronizationAvailable()

Returns:

True, if incremental synchronization is available, else false.

showInIntegrationOverview

boolean showInIntegrationOverview()

Returns:

True to show the repo in the Integration overview.