com.communote.server.core.external.confluence

Class ConfluenceUserRepository

java.lang.Object

com.communote.server.core.external.AbstractExternalUserRepository

com.communote.server.core.external.confluence.ConfluenceUserRepository

All Implemented Interfaces:

Orderable, ExternalUserRepository

public class ConfluenceUserRepository
extends AbstractExternalUserRepository

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTERNAL_SYSTEM_ID_DEFAULT_CONFLUENCE Define constant here, once this is a plugin.

Constructor Summary

Constructors

Constructor and Description
ConfluenceUserRepository() Default constructor setting the default system id

Method Summary

Modifier and Type	Method and Description
ConfluenceConfiguration	createConfiguration() Create an empty configuration.
ConfluenceConfiguration	getConfiguration() Get the confluence configuration of the client
Collection<StringPropertyTO>	getExternalLoginProperties(Long userId, ExternalUserAuthentication externalUserAuthentication) External Repos can return additional properties that will be included e.g.
LocalizedMessage	getName()
Set<UserProfileFields>	getProvidedProfileFieldNames()
ExternalUserVO	getUser(String externalUserId) Get the ExternalUserVO of the external user identifier

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

getExternalSystemId, getExternalUserGroupAccessor, getIncrementalRepositoryChangeTracker, getOrder, getUser, isActive, isConfigurationSet, isIncrementalSynchronizationAvailable, 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_CONFLUENCE

public static final String EXTERNAL_SYSTEM_ID_DEFAULT_CONFLUENCE

Define constant here, once this is a plugin.

See Also:

Constant Field Values

Constructor Detail

ConfluenceUserRepository

public ConfluenceUserRepository()

Default constructor setting the default system id

Method Detail

createConfiguration

public ConfluenceConfiguration createConfiguration()

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

Returns:

the empty configuration

getConfiguration

public ConfluenceConfiguration getConfiguration()

Get the confluence configuration of the client

Returns:

ConfluenceConfiguration

getExternalLoginProperties

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

Description copied from interface: ExternalUserRepository

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:

getName

public LocalizedMessage getName()

Returns:

a user friendly name of the repository

getProvidedProfileFieldNames

public 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

public 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