com.communote.server.core.security.authentication.confluence

Class ConfluenceAuthenticationProvider

java.lang.Object

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

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

com.communote.server.core.security.authentication.confluence.ConfluenceAuthenticationProvider

All Implemented Interfaces:

org.springframework.security.authentication.AuthenticationProvider

public class ConfluenceAuthenticationProvider
extends ExternalAuthenticationProvider

Authentication provider that authenticates a user against the user store of Confluence.

Author:

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

Constructor Summary

Constructors

Constructor and Description
ConfluenceAuthenticationProvider()

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.
protected ConfluenceConfiguration	getConfiguration() Returns the configuration for the external authentication.
String	getIdentifier()
List<InvitationField>	getInvitationFields()
UserVO	queryUser(Map<InvitationField,String> queryData) Queries a user and returns the user data
protected ExternalUserVO	retrieveExternalUser(org.springframework.security.core.Authentication authentication) Tries to retrieve the user details from the associated external resource.
boolean	supports(Class authentication)

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

createUserIdentification, getUser, handleRetrieveUserDetails, supportsUserQuerying

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

ConfluenceAuthenticationProvider

public ConfluenceAuthenticationProvider()

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

getConfiguration

protected ConfluenceConfiguration getConfiguration()

Description copied from class: ExternalAuthenticationProvider

Returns the configuration for the external authentication.

Specified by:

getConfiguration in class ExternalAuthenticationProvider

Returns:

the confluence configuration - can be null

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in class BaseCommunoteAuthenticationProvider

Returns:

ConfigurationManagement.DEFAULT_CONFLUENCE_SYSTEM_ID

getInvitationFields

public List<InvitationField> getInvitationFields()

Specified by:

getInvitationFields in class BaseCommunoteAuthenticationProvider

Returns:

all invitation fields this provider requires

queryUser

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

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

retrieveExternalUser

protected 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.

Specified by:

retrieveExternalUser in class ExternalAuthenticationProvider

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.

supports

public boolean supports(Class authentication)