com.atlassian.seraph.filter
Class LoginFilterRequest

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

public final class LoginFilterRequest
extends 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 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 String getAuthenticationStatus(javax.servlet.http.HttpServletRequest request)
Returns the authentication status code set by the LoginFilter as a request Attribute.

The possible statuses are:

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()


Copyright © 2013 Atlassian. All Rights Reserved.