com.communote.server.core.security.authentication

Class ExternalKenmeiApiAuthenticator<R extends AuthenticationRequest>

java.lang.Object

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

Type Parameters:

R - The type of the authentication request the class can handle

Direct Known Subclasses:

ConfluenceAuthenticator

public abstract class ExternalKenmeiApiAuthenticator<R extends AuthenticationRequest>
extends Object

Authenticator that runs against an external api. The api is defined by kenmei.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PARAM_EMAIL json parameter for the email of the user
static String	JSON_PARAM_FIRST_NAME json parameter for the first name
static String	JSON_PARAM_LANG json parameter for the language code
static String	JSON_PARAM_LAST_NAME json parameter for the last name
static String	JSON_PARAM_LOGIN json parameter for the login
static String	JSON_PARAM_NAME json parameter for the combined name
protected static String	JSON_PARAM_USER_FOUND json parameter for the user found flag.

Constructor Summary

Constructors

Constructor and Description
ExternalKenmeiApiAuthenticator(String name, boolean httpClientReusable)

Method Summary

Modifier and Type	Method and Description
protected void	assertFieldsExist(org.codehaus.jackson.node.ObjectNode jsonNode, String... fieldNames) Test whether a provided JSON object has all the given members and throw an exception if not.
ExternalUserVO	authenticate(R authenticationRequest) Does the authentication.
protected void	configureHttpClient(org.apache.http.impl.client.AbstractHttpClient httpClient, R authenticationRequest) Hook to be overwritten to configure the http client prior to executing a method.
protected abstract org.apache.http.client.methods.HttpRequestBase	createMethod(R authenticationRequest, boolean isQuerying)
protected abstract ExternalUserVO	createUserVO() Creates a prepared value object.
protected abstract void	extractUserData(org.codehaus.jackson.node.ObjectNode jsonUser, ExternalUserVO userVO) Copies user data from a JSON object to a value object.
protected abstract 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 ExternalUserVO	prepareDefaultUserVO() Creates a prepared value object with all update options set to true.
ExternalUserVO	queryUserData(R authenticationRequest) Queries the external system for data about a user
protected abstract void	validateRetrievedUser(R authenticationRequest, ExternalUserVO retrievedVO) Method is called after an authentication call has been made.

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PARAM_EMAIL

public static final String JSON_PARAM_EMAIL

json parameter for the email of the user

See Also:

Constant Field Values

JSON_PARAM_LAST_NAME

public static final String JSON_PARAM_LAST_NAME

json parameter for the last name

See Also:

Constant Field Values

JSON_PARAM_FIRST_NAME

public static final String JSON_PARAM_FIRST_NAME

json parameter for the first name

See Also:

Constant Field Values

JSON_PARAM_NAME

public static final String JSON_PARAM_NAME

json parameter for the combined name

See Also:

Constant Field Values

JSON_PARAM_LOGIN

public static final String JSON_PARAM_LOGIN

json parameter for the login

See Also:

Constant Field Values

JSON_PARAM_LANG

public static final String JSON_PARAM_LANG

json parameter for the language code

See Also:

Constant Field Values

JSON_PARAM_USER_FOUND

protected static final String JSON_PARAM_USER_FOUND

json parameter for the user found flag.

See Also:

Constant Field Values

Constructor Detail

ExternalKenmeiApiAuthenticator

public ExternalKenmeiApiAuthenticator(String name,
                                      boolean httpClientReusable)

Parameters:

name - name for logging

httpClientReusable - true if the client can be reused. If true #configureHttpClient(HttpClient) is NOT called.

Method Detail

assertFieldsExist

protected void assertFieldsExist(org.codehaus.jackson.node.ObjectNode jsonNode,
                                 String... fieldNames)

Test whether a provided JSON object has all the given members and throw an exception if not.

Parameters:

jsonNode - the JSON object

fieldNames - the names of the members the object has to have

Throws:

org.springframework.security.authentication.AuthenticationServiceException - in case one of the fields is missing

authenticate

public ExternalUserVO authenticate(R authenticationRequest)

Does the authentication. If the token is set it will be used, otherwise the email address, password is used.

Parameters:

authenticationRequest - the context holding all the parameters

Returns:

a value object with details about the successfully authenticated user

Throws:

org.springframework.security.authentication.BadCredentialsException - Thrown, when the provided credentials are wrong.

org.springframework.security.authentication.AuthenticationServiceException - Thrown, when something else is wrong connecting the server.

UnknownHostAuthenticationServiceException - Thrown on any "physical" communication problem with the foreign server.

configureHttpClient

protected void configureHttpClient(org.apache.http.impl.client.AbstractHttpClient httpClient,
                                   R authenticationRequest)

Hook to be overwritten to configure the http client prior to executing a method. Is only called if httpClientReusable is false.

Parameters:

httpClient - the client to configure

authenticationRequest - the external auth for the currrent request

createMethod

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

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 abstract ExternalUserVO createUserVO()

Creates a prepared value object.

Returns:

the value object

extractUserData

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

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 abstract String getAuthenticationApiUrl()

Returns:

get the authentication api url

isValidJsonUser

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

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

Parameters:

jsonUser - The retrieved user as Json object

Returns:

True (default), if the user is valid.

prepareDefaultUserVO

protected ExternalUserVO prepareDefaultUserVO()

Creates a prepared value object with all update options set to true.

Returns:

the value object

queryUserData

public ExternalUserVO queryUserData(R authenticationRequest)

Queries the external system for data about a user

Parameters:

authenticationRequest - the authentication request

Returns:

the data of the user (firstname, lastname and email) or null if not found

validateRetrievedUser

protected abstract void validateRetrievedUser(R authenticationRequest,
                                              ExternalUserVO retrievedVO)

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

Parameters:

authenticationRequest - the request

retrievedVO - the retrieved user