com.communote.server.core.security.authentication.database

Class DatabaseAuthenticationProvider

java.lang.Object

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

com.communote.server.core.security.authentication.database.DatabaseAuthenticationProvider

All Implemented Interfaces:

org.springframework.security.authentication.AuthenticationProvider

public class DatabaseAuthenticationProvider
extends BaseCommunoteAuthenticationProvider

Authentication provider that authenticates a user against the local database.

Author:

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

Constructor Summary

Constructors

Constructor and Description
DatabaseAuthenticationProvider() Constructor.

Method Summary

Modifier and Type	Method and Description
protected org.springframework.security.core.Authentication	createSuccessAuthentication(UserDetails details, org.springframework.security.core.Authentication authentication) Creates a successful Authentication object.
String	getIdentifier()
List<InvitationField>	getInvitationFields()
protected UserDetails	handleRetrieveUserDetails(org.springframework.security.core.Authentication auth) Tries to retrieve user details using the passed authentication.
UserVO	queryUser(Map<InvitationField,String> queryData) Querying here means, might there be a user that exists in the universe with these data.
boolean	supports(Class<?> authentication)
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, retrieveAndAuthenticateUserDetails

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseAuthenticationProvider

public DatabaseAuthenticationProvider()

Constructor.

Method Detail

createSuccessAuthentication

protected org.springframework.security.core.Authentication createSuccessAuthentication(UserDetails details,
                                                                                       org.springframework.security.core.Authentication authentication)

Creates a successful Authentication object. Subclasses will usually store the original credentials the user supplied (not salted or encoded passwords) in the returned Authentication object.

Specified by:

createSuccessAuthentication in class BaseCommunoteAuthenticationProvider

Parameters:

details - the authenticated user details. Subclasses should store it as principal in the authentication object.

authentication - that was presented to the provider for validation

Returns:

the successful authentication token

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in class BaseCommunoteAuthenticationProvider

Returns:

ConfigurationManagement.DEFAULT_DATABASE_ID

getInvitationFields

public List<InvitationField> getInvitationFields()

Specified by:

getInvitationFields in class BaseCommunoteAuthenticationProvider

Returns:

all invitation fields this provider requires

handleRetrieveUserDetails

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

Tries to retrieve user details using the passed authentication.

Specified by:

handleRetrieveUserDetails in class BaseCommunoteAuthenticationProvider

Parameters:

auth - describes the user to retrieve

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 - in case there is no user for the passed authentication

queryUser

public UserVO queryUser(Map<InvitationField,String> queryData)
                 throws org.springframework.security.core.AuthenticationException

Querying here means, might there be a user that exists in the universe with these data. Since someone provided the data as such we assume there is such a person.
Queries a user and returns the user data

Specified by:

queryUser in class BaseCommunoteAuthenticationProvider

Parameters:

queryData - the data to use for query. See InvitationField for possible values. The fields this provider uses are defined by BaseCommunoteAuthenticationProvider.getInvitationFields()

Returns:

the found user as value object, or null

Throws:

org.springframework.security.core.AuthenticationException

supports

public boolean supports(Class<?> authentication)

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