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

Class ConfluenceAuthenticator

java.lang.Object

com.communote.server.core.security.authentication.ExternalKenmeiApiAuthenticator<ConfluenceAuthenticationRequest>

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

public class ConfluenceAuthenticator
extends ExternalKenmeiApiAuthenticator<ConfluenceAuthenticationRequest>

Authenticator that checks the token and logins against Confluence.

Author:

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

Field Summary

Fields inherited from class com.communote.server.core.security.authentication.ExternalKenmeiApiAuthenticator

JSON_PARAM_EMAIL, JSON_PARAM_FIRST_NAME, JSON_PARAM_LANG, JSON_PARAM_LAST_NAME, JSON_PARAM_LOGIN, JSON_PARAM_NAME, JSON_PARAM_USER_FOUND

Constructor Summary

Constructors

Constructor and Description
ConfluenceAuthenticator(ConfluenceConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.client.methods.HttpRequestBase	createMethod(ConfluenceAuthenticationRequest authenticationRequest, boolean isQuerying)
protected ExternalUserVO	createUserVO() Creates a prepared value object.
protected void	extractUserData(org.codehaus.jackson.node.ObjectNode jsonUser, ExternalUserVO userVO) Copies user data from a JSON object to a value object.
protected String	getAuthenticationApiUrl()
protected boolean	isValidJsonUser(org.codehaus.jackson.node.ObjectNode jsonUser) Can be used to validate the received user after receiving it from the foreign system.
protected void	validateRetrievedUser(ConfluenceAuthenticationRequest confuenceAuthRequest, ExternalUserVO userVO) Method is called after an authentication call has been made.

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

assertFieldsExist, authenticate, configureHttpClient, prepareDefaultUserVO, queryUserData

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfluenceAuthenticator

public ConfluenceAuthenticator(ConfluenceConfiguration configuration)

Parameters:

configuration - the configuration to use

Method Detail

createMethod

protected org.apache.http.client.methods.HttpRequestBase createMethod(ConfluenceAuthenticationRequest authenticationRequest,
                                                                      boolean isQuerying)

Specified by:

createMethod in class ExternalKenmeiApiAuthenticator<ConfluenceAuthenticationRequest>

Parameters:

authenticationRequest - the authentication request

isQuerying - true if the request is not an authentication one but to get the user data of a specific user

Returns:

the method to use

createUserVO

protected ExternalUserVO createUserVO()

Creates a prepared value object.

Specified by:

createUserVO in class ExternalKenmeiApiAuthenticator<ConfluenceAuthenticationRequest>

Returns:

the value object

extractUserData

protected void extractUserData(org.codehaus.jackson.node.ObjectNode jsonUser,
                               ExternalUserVO userVO)
                        throws org.springframework.security.authentication.AuthenticationServiceException

Copies user data from a JSON object to a value object.

Specified by:

extractUserData in class ExternalKenmeiApiAuthenticator<ConfluenceAuthenticationRequest>

Parameters:

jsonUser - the JSON object

userVO - the value object

Throws:

org.springframework.security.authentication.AuthenticationServiceException - in case the JSON object did not contain the required members

getAuthenticationApiUrl

protected String getAuthenticationApiUrl()

Specified by:

getAuthenticationApiUrl in class ExternalKenmeiApiAuthenticator<ConfluenceAuthenticationRequest>

Returns:

get the authentication api url

isValidJsonUser

protected boolean isValidJsonUser(org.codehaus.jackson.node.ObjectNode jsonUser)

Description copied from class: ExternalKenmeiApiAuthenticator

Can be used to validate the received user after receiving it from the foreign system.

Overrides:

isValidJsonUser in class ExternalKenmeiApiAuthenticator<ConfluenceAuthenticationRequest>

Parameters:

jsonUser - The retrieved user as Json object

Returns:

True (default), if the user is valid.

validateRetrievedUser

protected void validateRetrievedUser(ConfluenceAuthenticationRequest confuenceAuthRequest,
                                     ExternalUserVO userVO)

Method is called after an authentication call has been made. Validate the user here and thrown an exception if the user is not valid.

Specified by:

validateRetrievedUser in class ExternalKenmeiApiAuthenticator<ConfluenceAuthenticationRequest>

Parameters:

confuenceAuthRequest - the request

userVO - the retrieved user