com.atlassian.crowd.integration.soap.springsecurity

Class RemoteCrowdAuthenticationProvider

java.lang.Object

com.atlassian.crowd.integration.springsecurity.CrowdAuthenticationProvider

com.atlassian.crowd.integration.soap.springsecurity.RemoteCrowdAuthenticationProvider

All Implemented Interfaces:

org.springframework.security.authentication.AuthenticationProvider

public class RemoteCrowdAuthenticationProvider
extends CrowdAuthenticationProvider

A concrete implementation of the CrowdAuthenticationProvider that uses the crowd client libraries (SOAP) to communicate with the Crowd server.

This should be the class developers use to integrate Crowd and Spring Security.

Constructor Summary

Constructors

Constructor and Description
RemoteCrowdAuthenticationProvider(AuthenticationManager authenticationManager, HttpAuthenticator httpAuthenticator, CrowdUserDetailsService userDetailsService)

Method Summary

Modifier and Type	Method and Description
protected String	authenticate(String username, String password, List<ValidationFactor> validationFactors) Authenticate a remote user and return the Crowd SSO token string.
protected boolean	isAuthenticated(String token, List<ValidationFactor> validationFactors) Determine if a remote user is authenticated via SSO based on the supplied SSO token string and validation factors.
protected CrowdUserDetails	loadUserByToken(String token) Retrieve a user from Crowd by looking up the principal by their authenticated Crowd token.
protected CrowdUserDetails	loadUserByUsername(String username) Retreive the user details for a user based on their username.
protected org.springframework.security.core.AuthenticationException	translateException(Exception e) Converts Crowd-specific exceptions to Spring Security-friendly exceptions.

Methods inherited from class com.atlassian.crowd.integration.springsecurity.CrowdAuthenticationProvider

authenticate, authenticateCrowdSSO, authenticateUsernamePassword, supports, supports

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteCrowdAuthenticationProvider

public RemoteCrowdAuthenticationProvider(AuthenticationManager authenticationManager,
                                         HttpAuthenticator httpAuthenticator,
                                         CrowdUserDetailsService userDetailsService)

Method Detail

isAuthenticated

protected boolean isAuthenticated(String token,
                                  List<ValidationFactor> validationFactors)
                           throws InvalidAuthenticationException,
                                  OperationFailedException,
                                  ApplicationPermissionException

Description copied from class: CrowdAuthenticationProvider

Determine if a remote user is authenticated via SSO based on the supplied SSO token string and validation factors.

Specified by:

isAuthenticated in class CrowdAuthenticationProvider

Parameters:

token - Crowd SSO token.

validationFactors - validation factors.

Returns:

true iff the remote user is authenticated.

Throws:

InvalidAuthenticationException

OperationFailedException

ApplicationPermissionException

authenticate

protected String authenticate(String username,
                              String password,
                              List<ValidationFactor> validationFactors)
                       throws InvalidAuthenticationException,
                              InactiveAccountException,
                              ApplicationAccessDeniedException,
                              ExpiredCredentialException,
                              ApplicationPermissionException,
                              OperationFailedException

Description copied from class: CrowdAuthenticationProvider

Authenticate a remote user and return the Crowd SSO token string.

Specified by:

authenticate in class CrowdAuthenticationProvider

Parameters:

username - username of the remote user.

password - password of the remote user.

validationFactors - validation factors from the remote user.

Returns:

Crowd SSO token string

Throws:

InvalidAuthenticationException - invalid username/password.

InactiveAccountException

ApplicationAccessDeniedException

ExpiredCredentialException

ApplicationPermissionException

OperationFailedException

loadUserByUsername

protected CrowdUserDetails loadUserByUsername(String username)
                                       throws org.springframework.security.core.userdetails.UsernameNotFoundException,
                                              org.springframework.dao.DataAccessException

Description copied from class: CrowdAuthenticationProvider

Retreive the user details for a user based on their username.

Specified by:

loadUserByUsername in class CrowdAuthenticationProvider

Parameters:

username - username of user.

Returns:

user details of user.

Throws:

org.springframework.security.core.userdetails.UsernameNotFoundException - user with supplied username does not exist.

org.springframework.dao.DataAccessException - error retrieving user.

loadUserByToken

protected CrowdUserDetails loadUserByToken(String token)
                                    throws CrowdSSOTokenInvalidException,
                                           org.springframework.dao.DataAccessException

Description copied from class: CrowdAuthenticationProvider

Retrieve a user from Crowd by looking up the principal by their authenticated Crowd token.

Specified by:

loadUserByToken in class CrowdAuthenticationProvider

Parameters:

token - Crowd SSO token string.

Returns:

CrowdUserDetails corresponding to the principal.

Throws:

CrowdSSOTokenInvalidException - if the provided token is invalid.

org.springframework.dao.DataAccessException - error retrieveing user.

translateException

protected org.springframework.security.core.AuthenticationException translateException(Exception e)

Description copied from class: CrowdAuthenticationProvider

Converts Crowd-specific exceptions to Spring Security-friendly exceptions.

Overrides:

translateException in class CrowdAuthenticationProvider

Parameters:

e - Crowd-specific exception.

Returns:

Spring Security-friendly exception.