com.atlassian.seraph.filter
Class LoginFilterRequest

java.lang.Object
  com.atlassian.seraph.filter.LoginFilterRequest

public final class LoginFilterRequest
extends java.lang.Object

Helper class to provide safe access to HTTP Request attributes set by the BaseLoginFilter.

Since:

v2.4

Constructor Summary

LoginFilterRequest()

Method Summary

static AuthenticationErrorType	getAuthenticationErrorType(javax.servlet.http.HttpServletRequest request) Returns the authentication error type set by the LoginFilter as a request Attribute.
static java.lang.String	getAuthenticationStatus(javax.servlet.http.HttpServletRequest request) Returns the authentication status code set by the LoginFilter as a request Attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoginFilterRequest

public LoginFilterRequest()

Method Detail

getAuthenticationStatus

public static java.lang.String getAuthenticationStatus(javax.servlet.http.HttpServletRequest request)

Returns the authentication status code set by the LoginFilter as a request Attribute.

The possible statuses are:

• BaseLoginFilter.LOGIN_SUCCESS - the login was processed, and user was logged in
• BaseLoginFilter.LOGIN_FAILURE - the login was processed, the user gave a bad username or password
• BaseLoginFilter.LOGIN_ERROR - the login was processed, an exception occurred trying to log the user in
• BaseLoginFilter.LOGIN_NOATTEMPT - the login was no processed, no form parameters existed

Parameters:

request - the HttpServletRequest to retrieve the attribute from.

Returns:

the authentication status code set by the Login Filter as a request Attribute.

See Also:

BaseLoginFilter.login(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getAuthenticationErrorType

public static AuthenticationErrorType getAuthenticationErrorType(javax.servlet.http.HttpServletRequest request)

Returns the authentication error type set by the LoginFilter as a request Attribute.

This will only be set if authentication status is "error" (BaseLoginFilter.LOGIN_ERROR), and is not even then guaranteed to be set by all implementations of BaseLoginFilter.

The original purpose of this was to indicate when a communication error occurs with a remote authentication server.

Parameters:

request - the HttpServletRequest to retrieve the attribute from.

Returns:

the authentication status code set by the Login Filter as a request Attribute.

See Also:

AuthenticatorException.getErrorType()