org.vaadin.spring.security.shared

Class SavedRequestAwareVaadinAuthenticationSuccessHandler

java.lang.Object

org.vaadin.spring.security.shared.AbstractVaadinAuthenticationTargetUrlRequestHandler

org.vaadin.spring.security.shared.VaadinUrlAuthenticationSuccessHandler

org.vaadin.spring.security.shared.SavedRequestAwareVaadinAuthenticationSuccessHandler

All Implemented Interfaces:

VaadinAuthenticationSuccessHandler

public class SavedRequestAwareVaadinAuthenticationSuccessHandler
extends VaadinUrlAuthenticationSuccessHandler

An authentication success strategy which can make use of the VaadinRedirectStrategy which may have been stored in the session by the ExceptionTranslationFilter. When such a request is intercepted and requires authentication, the request data is stored to record the original destination before the authentication process commenced, and to allow the request to be reconstructed when a redirect to the same URL occurs. This class is responsible for performing the redirect to the original URL if appropriate.

Following a successful authentication, it decides on the redirect destination, based on the following scenarios:

• If the alwaysUseDefaultTargetUrl property is set to true, the defaultTargetUrl will be used for the destination. Any DefaultSavedRequest stored in the session will be removed.
• If the targetUrlParameter has been set on the request, the value will be used as the destination. Any DefaultSavedRequest will again be removed.
• If a SavedRequest is found in the RequestCache (as set by the ExceptionTranslationFilter to record the original destination before the authentication process commenced), a redirect will be performed to the Url of that original destination. The SavedRequest object will remain cached and be picked up when the redirected request is received.
• If no SavedRequest is found, it will delegate to the base class.

Must be created as bean because to autowiring within parent class.

Author:

Luke Taylor (original source code spring-security), Gert-Jan Timmer (gjr.timmer@gmail.com) (Vaadin specific changes), Petter Holmström (petter@vaadin.com)

Nested Class Summary

Nested classes/interfaces inherited from interface org.vaadin.spring.security.shared.VaadinAuthenticationSuccessHandler

VaadinAuthenticationSuccessHandler.NullHandler

Field Summary

Fields inherited from class org.vaadin.spring.security.shared.AbstractVaadinAuthenticationTargetUrlRequestHandler

http, redirectStrategy

Constructor Summary

Constructors

Constructor and Description
SavedRequestAwareVaadinAuthenticationSuccessHandler(HttpService http, VaadinRedirectStrategy redirectStrategy, String defaultTargetUrl)

Method Summary

Modifier and Type	Method and Description
void	onAuthenticationSuccess(Authentication authentication) Called when a user has been successfully authenticated.
void	setRequestCache(RequestCache requestCache)

Methods inherited from class org.vaadin.spring.security.shared.VaadinUrlAuthenticationSuccessHandler

clearAuthenticationAttributes

Methods inherited from class org.vaadin.spring.security.shared.AbstractVaadinAuthenticationTargetUrlRequestHandler

determineTargetUrl, getDefaultTargetUrl, getTargetUrlParameter, handle, isAlwaysUseDefaultTargetUrl, setAlwaysUseDefaultTargetUrl, setDefaultTargetUrl, setTargetUrlParameter, setUseReferer

Methods inherited from class java.lang.Object

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

Constructor Detail

SavedRequestAwareVaadinAuthenticationSuccessHandler

public SavedRequestAwareVaadinAuthenticationSuccessHandler(HttpService http,
                                                           VaadinRedirectStrategy redirectStrategy,
                                                           String defaultTargetUrl)

Method Detail

onAuthenticationSuccess

public void onAuthenticationSuccess(Authentication authentication)
                             throws Exception

Description copied from interface: VaadinAuthenticationSuccessHandler

Called when a user has been successfully authenticated.

Specified by:

onAuthenticationSuccess in interface VaadinAuthenticationSuccessHandler

Overrides:

onAuthenticationSuccess in class VaadinUrlAuthenticationSuccessHandler

Parameters:

authentication - the Authentication object which was created during the authentication process.

Throws:

Exception

setRequestCache

public void setRequestCache(RequestCache requestCache)