public class LoginUrlAuthenticationEntryPoint extends java.lang.Object implements AuthenticationEntryPoint, org.springframework.beans.factory.InitializingBean
ExceptionTranslationFilter
to commence a form login authentication
via the UsernamePasswordAuthenticationFilter
.
Holds the location of the login form in the loginFormUrl
property, and uses
that to build a redirect URL to the login page. Alternatively, an absolute URL can be
set in this property and that will be used exclusively.
When using a relative URL, you can set the forceHttps
property to true, to
force the protocol used for the login form to be HTTPS
, even if the original
intercepted request for a resource used the HTTP
protocol. When this happens,
after a successful login (via HTTPS), the original resource will still be accessed as
HTTP, via the original request URL. For the forced HTTPS feature to work, the
PortMapper
is consulted to determine the HTTP:HTTPS pairs. The value of
forceHttps
will have no effect if an absolute URL is used.
Constructor and Description |
---|
LoginUrlAuthenticationEntryPoint(java.lang.String loginFormUrl) |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet() |
protected java.lang.String |
buildHttpsRedirectUrlForRequest(javax.servlet.http.HttpServletRequest request)
Builds a URL to redirect the supplied request to HTTPS.
|
protected java.lang.String |
buildRedirectUrlToLoginPage(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
AuthenticationException authException) |
void |
commence(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
AuthenticationException authException)
Performs the redirect (or forward) to the login form URL.
|
protected java.lang.String |
determineUrlToUseForThisRequest(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
AuthenticationException exception)
Allows subclasses to modify the login form URL that should be applicable for a
given request.
|
java.lang.String |
getLoginFormUrl() |
protected PortMapper |
getPortMapper() |
protected PortResolver |
getPortResolver() |
protected boolean |
isForceHttps() |
protected boolean |
isUseForward() |
void |
setForceHttps(boolean forceHttps)
Set to true to force login form access to be via https.
|
void |
setPortMapper(PortMapper portMapper) |
void |
setPortResolver(PortResolver portResolver) |
void |
setUseForward(boolean useForward)
Tells if we are to do a forward to the
loginFormUrl using the
RequestDispatcher , instead of a 302 redirect. |
public LoginUrlAuthenticationEntryPoint(java.lang.String loginFormUrl)
loginFormUrl
- URL where the login page can be found. Should either be
relative to the web-app context path (include a leading /
) or an absolute
URL.public void afterPropertiesSet() throws java.lang.Exception
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
java.lang.Exception
protected java.lang.String determineUrlToUseForThisRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, AuthenticationException exception)
request
- the requestresponse
- the responseexception
- the exceptiongetLoginFormUrl()
)public void commence(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, AuthenticationException authException) throws java.io.IOException, javax.servlet.ServletException
commence
in interface AuthenticationEntryPoint
request
- that resulted in an AuthenticationException
response
- so that the user agent can begin authenticationauthException
- that caused the invocationjava.io.IOException
javax.servlet.ServletException
protected java.lang.String buildRedirectUrlToLoginPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, AuthenticationException authException)
protected java.lang.String buildHttpsRedirectUrlForRequest(javax.servlet.http.HttpServletRequest request) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
public void setForceHttps(boolean forceHttps)
https
, then the client will
first be redirected to an https URL, even if serverSideRedirect is set to
true.protected boolean isForceHttps()
public java.lang.String getLoginFormUrl()
public void setPortMapper(PortMapper portMapper)
protected PortMapper getPortMapper()
public void setPortResolver(PortResolver portResolver)
protected PortResolver getPortResolver()
public void setUseForward(boolean useForward)
loginFormUrl
using the
RequestDispatcher
, instead of a 302 redirect.useForward
- true if a forward to the login page should be used. Must be false
(the default) if loginFormUrl
is set to an absolute value.protected boolean isUseForward()