Authenticator

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> securityfilter >> [ authenticator overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.securityfilter.authenticator.Authenticator

SOURCE |

Download org.securityfilter.authenticator.Authenticator

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.securityfilter.authenticator
Interface Authenticator

All Known Implementing Classes:: BasicAuthenticator, FormAuthenticator

public interface Authenticator

Authenticator - interface for a SecurityFilter authenticator module. Implementations correspond to an implementation method, such as FORM or BASIC (others are possible).

Version:: $Revision: 1.1 $ $Date: 2003/07/07 13:12:56 $

Method Summary

boolean bypassSecurityForThisRequest(org.securityfilter.filter.SecurityRequestWrapper request, org.securityfilter.filter.URLPatternMatcher patternMatcher)
          Return true if security checks should be bypassed for this request.

java.lang.String getAuthMethod()
          Get the auth method string for this authentication scheme.

void init(javax.servlet.FilterConfig filterConfig, org.securityfilter.config.SecurityConfig securityConfig)
          Initialize this Authenticator.

boolean processLogin(org.securityfilter.filter.SecurityRequestWrapper request, javax.servlet.http.HttpServletResponse response)
          Process any login information that was included in the request, if any.

void showLogin(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Show the login interface.

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig,
                 org.securityfilter.config.SecurityConfig securityConfig)
          throws java.lang.Exception

Initialize this Authenticator.

getAuthMethod

public java.lang.String getAuthMethod()

Get the auth method string for this authentication scheme.

processLogin

public boolean processLogin(org.securityfilter.filter.SecurityRequestWrapper request,
                            javax.servlet.http.HttpServletResponse response)
                     throws java.lang.Exception

Process any login information that was included in the request, if any. Returns true if SecurityFilter should abort further processing after the method completes (for example, if a redirect was sent as part of the login processing).

showLogin

public void showLogin(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.io.IOException

Show the login interface.

bypassSecurityForThisRequest

public boolean bypassSecurityForThisRequest(org.securityfilter.filter.SecurityRequestWrapper request,
                                            org.securityfilter.filter.URLPatternMatcher patternMatcher)
                                     throws java.lang.Exception

Return true if security checks should be bypassed for this request. Example: for FORM based authentication, the login and error pages should always be viewable without being authenticated, even if they would otherwise be blocked by a security constraint.