com.communote.server.core.security.authentication

Class ExternalAuthenticationProvider

java.lang.Object

com.communote.server.core.security.authentication.BaseCommunoteAuthenticationProvider

com.communote.server.core.security.authentication.ExternalAuthenticationProvider

All Implemented Interfaces:

org.springframework.security.authentication.AuthenticationProvider

Direct Known Subclasses:

ConfluenceAuthenticationProvider, LdapAuthenticationProvider

public abstract class ExternalAuthenticationProvider
extends BaseCommunoteAuthenticationProvider

Authentication provider that authenticates a user against an external user repository.

Author:

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

Constructor Summary

Constructors

Constructor and Description
ExternalAuthenticationProvider()

Method Summary

Modifier and Type	Method and Description
protected UserIdentification	createUserIdentification(ExternalUserVO userVO) Create the user identification to be used for the user service.
protected abstract ExternalSystemConfiguration	getConfiguration() Returns the configuration for the external authentication.
protected User	getUser(UserIdentification userIdentification) Get the user for the given identification
protected UserDetails	handleRetrieveUserDetails(org.springframework.security.core.Authentication authentication) Try to retrieve the user details by using retrieveExternalUser(Authentication) and synchronize the returned data with the local database.
protected abstract ExternalUserVO	retrieveExternalUser(org.springframework.security.core.Authentication authentication) Tries to retrieve the user details from the associated external resource.
boolean	supportsUserQuerying() Checks if the provider is enabled and configured for user querying

Methods inherited from class com.communote.server.core.security.authentication.BaseCommunoteAuthenticationProvider

authenticate, createSuccessAuthentication, getIdentifier, getInvitationFields, queryUser, retrieveAndAuthenticateUserDetails

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.security.authentication.AuthenticationProvider

supports

Constructor Detail

ExternalAuthenticationProvider

public ExternalAuthenticationProvider()

Method Detail

createUserIdentification

protected UserIdentification createUserIdentification(ExternalUserVO userVO)

Create the user identification to be used for the user service. Allow subclasses to overwrite it.

Parameters:

userVO - the user vo previously retrieved.

Returns:

the user identification

getConfiguration

protected abstract ExternalSystemConfiguration getConfiguration()

Returns the configuration for the external authentication.

Returns:

the configuration

getUser

protected User getUser(UserIdentification userIdentification)
                throws UserNotFoundException

Get the user for the given identification

Parameters:

userIdentification - the identification (should contain the previously vo

Returns:

the user

Throws:

UserNotFoundException - in case user was not found

handleRetrieveUserDetails

protected final UserDetails handleRetrieveUserDetails(org.springframework.security.core.Authentication authentication)
                                               throws org.springframework.security.core.AuthenticationException

Try to retrieve the user details by using retrieveExternalUser(Authentication) and synchronize the returned data with the local database.

Specified by:

handleRetrieveUserDetails in class BaseCommunoteAuthenticationProvider

Parameters:

authentication - the authentication details

Returns:

the user details. May return null if the AuthenticationProvider is unable to support authentication of the passed Authentication object. In such a case, the next AuthenticationProvider that supports the presented Authentication class will be tried.

Throws:

org.springframework.security.core.AuthenticationException - if there is no user for the provided authentication or the authentication cannot be approved

See Also:

BaseCommunoteAuthenticationProvider.handleRetrieveUserDetails(Authentication)

retrieveExternalUser

protected abstract ExternalUserVO retrieveExternalUser(org.springframework.security.core.Authentication authentication)
                                                throws org.springframework.security.core.AuthenticationException

Tries to retrieve the user details from the associated external resource.

Parameters:

authentication - the authentication details

Returns:

the user VO describing the returned user. Attributes that the external resource does not return should be left null.

Throws:

org.springframework.security.core.AuthenticationException - if there is no user for the provided authentication or the authentication cannot be approved. Subclasses should throw an appropriate sub-exception.

supportsUserQuerying

public boolean supportsUserQuerying()

Checks if the provider is enabled and configured for user querying

Specified by:

supportsUserQuerying in class BaseCommunoteAuthenticationProvider

Returns:

true if this provider, in his current state, supports user querying