com.neurosys.user.service

Class AbstractSessionAuthService<U extends User,S>

java.lang.Object

com.neurosys.user.service.AbstractSessionAuthService<U,S>

Direct Known Subclasses:

WicketBasicSessionAuthService

public abstract class AbstractSessionAuthService<U extends User,S>
extends Object

Standard Session based Auth mechanism defined. (for common cases like Admin)

Author:

Arjun Dhar

See Also:

getUserDetailsToLoadInSession(String), setSessionFromUserDetails(User, AuthenticationToken)

Constructor Summary

Constructors

Constructor and Description
AbstractSessionAuthService()

Method Summary

Modifier and Type	Method and Description
protected CharSequence	getPassword(String normalizedUserId)
abstract S	getSession()
U	getUserDetailsToLoadInSession(String normalizedUserId) Create exact User type
abstract UserService<User,?>	getUserService() Handle to the UserService backing this
Class	getUserType() If provided will ensure getUserDetailsToLoadInSession(String) will return this type.
<S extends org.apache.wicket.Session> S	processSessionOnLogin(S existingSession) Opportunity to process, override session on login.
abstract S	setSessionFromUserDetails(U user, AuthenticationToken authToken) Chance to replace the Session Object itself
U	signIn(Principal inputPrincipal, ChangeGenerator<Object> changeGenerator) Sign in a user Since this method allows a ChangeGenerator; it will also generate Events of Type Successful Login - BasicAuthenticationToken Unsuccessful Login - userId as String Exception - exception object as Exception
abstract void	signOut(S session)
void	userValidation(U user, UpdatableAuthenticationToken authToken) Perform any additional user validation tasks on the loaded User object and also update the UpdatableAuthenticationToken if necessary.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSessionAuthService

public AbstractSessionAuthService()

Method Detail

getPassword

protected final CharSequence getPassword(String normalizedUserId)
                                  throws Exception

Throws:

Exception

getUserDetailsToLoadInSession

public U getUserDetailsToLoadInSession(String normalizedUserId)

Create exact User type

Default value:

AdminUser type

userValidation

public void userValidation(U user,
                           UpdatableAuthenticationToken authToken)

Perform any additional user validation tasks on the loaded User object and also update the UpdatableAuthenticationToken if necessary.

Parameters:

user - as U

authToken - as type

processSessionOnLogin

public <S extends org.apache.wicket.Session> S processSessionOnLogin(S existingSession)

Opportunity to process, override session on login. A session may already exist.

Parameters:

existingSession - as T BasicSession

getSession

public abstract S getSession()

setSessionFromUserDetails

public abstract S setSessionFromUserDetails(U user,
                                            AuthenticationToken authToken)

Chance to replace the Session Object itself

Parameters:

User - as Filled user Object from IDM System (DB,LDAP etc), returned from {getUserDetailsToLoadInSession(String) after successful authentication

authToken - as AuthenticationToken, indicating there was successful Authentication with any Auth related details in it.

Returns:

updates session as type <S>

signIn

public U signIn(Principal inputPrincipal,
                ChangeGenerator<Object> changeGenerator)
         throws Exception

Sign in a user

Since this method allows a ChangeGenerator; it will also generate Events of Type

• Successful Login - BasicAuthenticationToken
• Unsuccessful Login - userId as String
• Exception - exception object as Exception

Parameters:

inputPrincipal - as Principal

changeGenerator - as an Optional ChangeGenerator

Returns:

User type

Throws:

Exception

getUserType

public Class getUserType()

If provided will ensure getUserDetailsToLoadInSession(String) will return this type.

Default value:

AdminUser type or its children.

signOut

public abstract void signOut(S session)

getUserService

public abstract UserService<User,?> getUserService()

Handle to the UserService backing this