org.springframework.extensions.surf.mvc

Class AbstractLoginController

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.support.WebContentGenerator

org.springframework.web.servlet.mvc.AbstractController

org.springframework.extensions.surf.mvc.AbstractLoginController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller

Direct Known Subclasses:

LoginController

public abstract class AbstractLoginController
extends org.springframework.web.servlet.mvc.AbstractController

Superclass for login controller implementations, using the Template Method design pattern. Authenticates the user by using userFactory, and then calls onSuccess(HttpServletRequest, HttpServletResponse) if authentication is successful, or onFailure(HttpServletRequest, HttpServletResponse) if authentication fails.

Author:

muzquiano, kevinr

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	PARAM_PASSWORD
protected static String	PARAM_USERNAME

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

METHOD_GET, METHOD_HEAD, METHOD_POST

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

Constructors

Constructor and Description
AbstractLoginController()

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.web.servlet.ModelAndView	handleRequestInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected abstract void	onFailure(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Template method.
protected abstract void	onSuccess(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Template method.
void	setUserFactory(UserFactory userFactory) This method is provided to allow the Spring framework to set a UserFactory required for authenticating requests
void	setWebFrameworkConfiguration(WebFrameworkConfigElement webFrameworkConfiguration)

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setAlwaysMustRevalidate, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_PASSWORD

protected static final String PARAM_PASSWORD

See Also:

Constant Field Values

PARAM_USERNAME

protected static final String PARAM_USERNAME

See Also:

Constant Field Values

Constructor Detail

AbstractLoginController

public AbstractLoginController()

Method Detail

setUserFactory

public void setUserFactory(UserFactory userFactory)

This method is provided to allow the Spring framework to set a UserFactory required for authenticating requests

Parameters:

userFactory - UserFactory

setWebFrameworkConfiguration

public void setWebFrameworkConfiguration(WebFrameworkConfigElement webFrameworkConfiguration)

handleRequestInternal

public org.springframework.web.servlet.ModelAndView handleRequestInternal(javax.servlet.http.HttpServletRequest request,
                                                                 javax.servlet.http.HttpServletResponse response)
                                                                   throws Exception

Specified by:

handleRequestInternal in class org.springframework.web.servlet.mvc.AbstractController

Throws:

Exception

onFailure

protected abstract void onFailure(javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response)
                           throws Exception

Template method. Called after failed authentication.

Parameters:

request - current HTTP request

response - current HTTP response

Throws:

Exception - in case of errors

onSuccess

protected abstract void onSuccess(javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response)
                           throws Exception

Template method. Called after successful authentication.

Parameters:

request - current HTTP request

response - current HTTP response

Throws:

Exception - in case of errors