| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_65) on Fri Mar 04 17:58:57 EST 2016 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| BasicHttpAuthenticationFilter (Apache Shiro 1.2.4 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2016-03-04"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="BasicHttpAuthenticationFilter (Apache Shiro 1.2.4 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BasicHttpAuthenticationFilter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="BasicHttpAuthenticationFilter.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.shiro.web.filter.authc</FONT> |
| <BR> |
| Class BasicHttpAuthenticationFilter</H2> |
| <PRE> |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.ServletContextSupport</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.AbstractFilter</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/shiro/web/servlet/NameableFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.NameableFilter</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.OncePerRequestFilter</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/shiro/web/servlet/AdviceFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.AdviceFilter</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html" title="class in org.apache.shiro.web.filter">org.apache.shiro.web.filter.PathMatchingFilter</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html" title="class in org.apache.shiro.web.filter">org.apache.shiro.web.filter.AccessControlFilter</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc">org.apache.shiro.web.filter.authc.AuthenticationFilter</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html" title="class in org.apache.shiro.web.filter.authc">org.apache.shiro.web.filter.authc.AuthenticatingFilter</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</A>, <A HREF="../../../../../../org/apache/shiro/util/Nameable.html" title="interface in org.apache.shiro.util">Nameable</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/PathConfigProcessor.html" title="interface in org.apache.shiro.web.filter">PathConfigProcessor</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.62"><B>BasicHttpAuthenticationFilter</B></A><DT>extends <A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticatingFilter</A></DL> |
| </PRE> |
| |
| <P> |
| Requires the requesting user to be <A HREF="../../../../../../org/apache/shiro/subject/Subject.html#isAuthenticated()"><CODE>authenticated</CODE></A> for the |
| request to continue, and if they're not, requires the user to login via the HTTP Basic protocol-specific challenge. |
| Upon successful login, they're allowed to continue on to the requested resource/url. |
| <p/> |
| This implementation is a 'clean room' Java implementation of Basic HTTP Authentication specification per |
| <a href="ftp://ftp.isi.edu/in-notes/rfc2617.txt">RFC 2617</a>. |
| <p/> |
| Basic authentication functions as follows: |
| <ol> |
| <li>A request comes in for a resource that requires authentication.</li> |
| <li>The server replies with a 401 response status, sets the <code>WWW-Authenticate</code> header, and the contents of a |
| page informing the user that the incoming resource requires authentication.</li> |
| <li>Upon receiving this <code>WWW-Authenticate</code> challenge from the server, the client then takes a |
| username and a password and puts them in the following format: |
| <p><code>username:password</code></p></li> |
| <li>This token is then base 64 encoded.</li> |
| <li>The client then sends another request for the same resource with the following header:<br/> |
| <p><code>Authorization: Basic <em>Base64_encoded_username_and_password</em></code></p></li> |
| </ol> |
| The <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><CODE>onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse)</CODE></A> method will |
| only be called if the subject making the request is not |
| <A HREF="../../../../../../org/apache/shiro/subject/Subject.html#isAuthenticated()"><CODE>authenticated</CODE></A> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>0.9</DD> |
| <DT><B>See Also:</B><DD><a href="ftp://ftp.isi.edu/in-notes/rfc2617.txt">RFC 2617</a>, |
| <a href="http://en.wikipedia.org/wiki/Basic_access_authentication">Basic Access Authentication</a></DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#AUTHENTICATE_HEADER">AUTHENTICATE_HEADER</A></B></CODE> |
| |
| <BR> |
| HTTP Authentication header, equal to <code>WWW-Authenticate</code></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#AUTHORIZATION_HEADER">AUTHORIZATION_HEADER</A></B></CODE> |
| |
| <BR> |
| HTTP Authorization header, equal to <code>Authorization</code></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.shiro.web.filter.authc.AuthenticatingFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.shiro.web.filter.authc.<A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticatingFilter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#PERMISSIVE">PERMISSIVE</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.shiro.web.filter.authc.AuthenticationFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.shiro.web.filter.authc.<A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticationFilter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html#DEFAULT_SUCCESS_URL">DEFAULT_SUCCESS_URL</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.shiro.web.filter.AccessControlFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.shiro.web.filter.<A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html" title="class in org.apache.shiro.web.filter">AccessControlFilter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#DEFAULT_LOGIN_URL">DEFAULT_LOGIN_URL</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#GET_METHOD">GET_METHOD</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#POST_METHOD">POST_METHOD</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.shiro.web.filter.PathMatchingFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.shiro.web.filter.<A HREF="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html" title="class in org.apache.shiro.web.filter">PathMatchingFilter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#appliedPaths">appliedPaths</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#pathMatcher">pathMatcher</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.shiro.web.servlet.OncePerRequestFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.shiro.web.servlet.<A HREF="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html" title="class in org.apache.shiro.web.servlet">OncePerRequestFilter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#ALREADY_FILTERED_SUFFIX">ALREADY_FILTERED_SUFFIX</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.shiro.web.servlet.AbstractFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.shiro.web.servlet.<A HREF="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html" title="class in org.apache.shiro.web.servlet">AbstractFilter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#filterConfig">filterConfig</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#BasicHttpAuthenticationFilter()">BasicHttpAuthenticationFilter</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#createToken(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">createToken</A></B>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</A> request, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</A> response)</CODE> |
| |
| <BR> |
| Creates an AuthenticationToken for use during login attempt with the provided credentials in the http header.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getApplicationName()">getApplicationName</A></B>()</CODE> |
| |
| <BR> |
| Returns the name to use in the ServletResponse's <b><code>WWW-Authenticate</code></b> header.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthcScheme()">getAuthcScheme</A></B>()</CODE> |
| |
| <BR> |
| Returns the HTTP <b><code>WWW-Authenticate</code></b> header scheme that this filter will use when sending |
| the HTTP Basic challenge response.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthzHeader(javax.servlet.ServletRequest)">getAuthzHeader</A></B>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</A> request)</CODE> |
| |
| <BR> |
| Returns the <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#AUTHORIZATION_HEADER"><CODE>AUTHORIZATION_HEADER</CODE></A> from the specified ServletRequest.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthzScheme()">getAuthzScheme</A></B>()</CODE> |
| |
| <BR> |
| Returns the HTTP <b><code>Authorization</code></b> header value that this filter will respond to as indicating |
| a login request.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getPrincipalsAndCredentials(java.lang.String, javax.servlet.ServletRequest)">getPrincipalsAndCredentials</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> authorizationHeader, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</A> request)</CODE> |
| |
| <BR> |
| Returns the username obtained from the |
| <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthzHeader(javax.servlet.ServletRequest)"><CODE>authorizationHeader</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getPrincipalsAndCredentials(java.lang.String, java.lang.String)">getPrincipalsAndCredentials</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> scheme, |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> encoded)</CODE> |
| |
| <BR> |
| Returns the username and password pair based on the specified <code>encoded</code> String obtained from |
| the request's authorization header.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#isLoginAttempt(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">isLoginAttempt</A></B>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</A> request, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</A> response)</CODE> |
| |
| <BR> |
| Determines whether the incoming request is an attempt to log in.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#isLoginAttempt(java.lang.String)">isLoginAttempt</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> authzHeader)</CODE> |
| |
| <BR> |
| Default implementation that returns <code>true</code> if the specified <code>authzHeader</code> |
| starts with the same (case-insensitive) characters specified by the |
| <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthzScheme()"><CODE>authzScheme</CODE></A>, <code>false</code> otherwise.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#isLoginRequest(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">isLoginRequest</A></B>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</A> request, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</A> response)</CODE> |
| |
| <BR> |
| Delegates to <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#isLoginAttempt(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><CODE>isLoginAttempt</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">onAccessDenied</A></B>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</A> request, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</A> response)</CODE> |
| |
| <BR> |
| Processes unauthenticated requests.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#sendChallenge(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">sendChallenge</A></B>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</A> request, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</A> response)</CODE> |
| |
| <BR> |
| Builds the challenge for authorization by setting a HTTP <code>401</code> (Unauthorized) status as well as the |
| response's <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#AUTHENTICATE_HEADER"><CODE>AUTHENTICATE_HEADER</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#setApplicationName(java.lang.String)">setApplicationName</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> applicationName)</CODE> |
| |
| <BR> |
| Sets the name to use in the ServletResponse's <b><code>WWW-Authenticate</code></b> header.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#setAuthcScheme(java.lang.String)">setAuthcScheme</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> authcScheme)</CODE> |
| |
| <BR> |
| Sets the HTTP <b><code>WWW-Authenticate</code></b> header scheme that this filter will use when sending the |
| HTTP Basic challenge response.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#setAuthzScheme(java.lang.String)">setAuthzScheme</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> authzScheme)</CODE> |
| |
| <BR> |
| Sets the HTTP <b><code>Authorization</code></b> header value that this filter will respond to as indicating a |
| login request.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.web.filter.authc.AuthenticatingFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.shiro.web.filter.authc.<A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticatingFilter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#cleanup(javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.Exception)">cleanup</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#createToken(java.lang.String, java.lang.String, boolean, java.lang.String)">createToken</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#createToken(java.lang.String, java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletResponse)">createToken</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#executeLogin(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">executeLogin</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#getHost(javax.servlet.ServletRequest)">getHost</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#isAccessAllowed(javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.Object)">isAccessAllowed</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#isPermissive(java.lang.Object)">isPermissive</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#isRememberMe(javax.servlet.ServletRequest)">isRememberMe</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#onLoginFailure(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationException, javax.servlet.ServletRequest, javax.servlet.ServletResponse)">onLoginFailure</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#onLoginSuccess(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.subject.Subject, javax.servlet.ServletRequest, javax.servlet.ServletResponse)">onLoginSuccess</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.web.filter.authc.AuthenticationFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.shiro.web.filter.authc.<A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticationFilter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html#getSuccessUrl()">getSuccessUrl</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html#issueSuccessRedirect(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">issueSuccessRedirect</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html#setSuccessUrl(java.lang.String)">setSuccessUrl</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.web.filter.AccessControlFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.shiro.web.filter.<A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html" title="class in org.apache.shiro.web.filter">AccessControlFilter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#getLoginUrl()">getLoginUrl</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#getSubject(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">getSubject</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.Object)">onAccessDenied</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#onPreHandle(javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.Object)">onPreHandle</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#redirectToLogin(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">redirectToLogin</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#saveRequest(javax.servlet.ServletRequest)">saveRequest</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#saveRequestAndRedirectToLogin(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">saveRequestAndRedirectToLogin</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#setLoginUrl(java.lang.String)">setLoginUrl</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.web.filter.PathMatchingFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.shiro.web.filter.<A HREF="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html" title="class in org.apache.shiro.web.filter">PathMatchingFilter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#getPathWithinApplication(javax.servlet.ServletRequest)">getPathWithinApplication</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String, java.lang.Object)">isEnabled</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#pathsMatch(java.lang.String, javax.servlet.ServletRequest)">pathsMatch</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#pathsMatch(java.lang.String, java.lang.String)">pathsMatch</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#preHandle(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">preHandle</A>, <A HREF="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html#processPathConfig(java.lang.String, java.lang.String)">processPathConfig</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.web.servlet.AdviceFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.shiro.web.servlet.<A HREF="../../../../../../org/apache/shiro/web/servlet/AdviceFilter.html" title="class in org.apache.shiro.web.servlet">AdviceFilter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/shiro/web/servlet/AdviceFilter.html#afterCompletion(javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.Exception)">afterCompletion</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/AdviceFilter.html#doFilterInternal(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)">doFilterInternal</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/AdviceFilter.html#executeChain(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)">executeChain</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/AdviceFilter.html#postHandle(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">postHandle</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.web.servlet.OncePerRequestFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.shiro.web.servlet.<A HREF="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html" title="class in org.apache.shiro.web.servlet">OncePerRequestFilter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)">doFilter</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#getAlreadyFilteredAttributeName()">getAlreadyFilteredAttributeName</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#isEnabled()">isEnabled</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">isEnabled</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#setEnabled(boolean)">setEnabled</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#shouldNotFilter(javax.servlet.ServletRequest)">shouldNotFilter</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.web.servlet.NameableFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.shiro.web.servlet.<A HREF="../../../../../../org/apache/shiro/web/servlet/NameableFilter.html" title="class in org.apache.shiro.web.servlet">NameableFilter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/shiro/web/servlet/NameableFilter.html#getName()">getName</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/NameableFilter.html#setName(java.lang.String)">setName</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/NameableFilter.html#toStringBuilder()">toStringBuilder</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.web.servlet.AbstractFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.shiro.web.servlet.<A HREF="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html" title="class in org.apache.shiro.web.servlet">AbstractFilter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#destroy()">destroy</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#getFilterConfig()">getFilterConfig</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#getInitParam(java.lang.String)">getInitParam</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#init(javax.servlet.FilterConfig)">init</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#onFilterConfigSet()">onFilterConfigSet</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#setFilterConfig(javax.servlet.FilterConfig)">setFilterConfig</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.web.servlet.ServletContextSupport"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.shiro.web.servlet.<A HREF="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html" title="class in org.apache.shiro.web.servlet">ServletContextSupport</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#getContextAttribute(java.lang.String)">getContextAttribute</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#getContextInitParam(java.lang.String)">getContextInitParam</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#getServletContext()">getServletContext</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#removeContextAttribute(java.lang.String)">removeContextAttribute</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#setContextAttribute(java.lang.String, java.lang.Object)">setContextAttribute</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#setServletContext(javax.servlet.ServletContext)">setServletContext</A>, <A HREF="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#toString()">toString</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="AUTHORIZATION_HEADER"><!-- --></A><H3> |
| AUTHORIZATION_HEADER</H3> |
| <PRE> |
| protected static final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.72"><B>AUTHORIZATION_HEADER</B></A></PRE> |
| <DL> |
| <DD>HTTP Authorization header, equal to <code>Authorization</code> |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter.AUTHORIZATION_HEADER">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="AUTHENTICATE_HEADER"><!-- --></A><H3> |
| AUTHENTICATE_HEADER</H3> |
| <PRE> |
| protected static final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.77"><B>AUTHENTICATE_HEADER</B></A></PRE> |
| <DL> |
| <DD>HTTP Authentication header, equal to <code>WWW-Authenticate</code> |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter.AUTHENTICATE_HEADER">Constant Field Values</A></DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="BasicHttpAuthenticationFilter()"><!-- --></A><H3> |
| BasicHttpAuthenticationFilter</H3> |
| <PRE> |
| public <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.62"><B>BasicHttpAuthenticationFilter</B></A>()</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getApplicationName()"><!-- --></A><H3> |
| getApplicationName</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.105"><B>getApplicationName</B></A>()</PRE> |
| <DL> |
| <DD>Returns the name to use in the ServletResponse's <b><code>WWW-Authenticate</code></b> header. |
| <p/> |
| Per RFC 2617, this name name is displayed to the end user when they are asked to authenticate. Unless overridden |
| by the <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#setApplicationName(java.lang.String)"><CODE>setApplicationName(String)</CODE></A> method, the default value is 'application'. |
| <p/> |
| Please see <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#setApplicationName(java.lang.String)"><CODE>setApplicationName(String)</CODE></A> for an example of how this functions. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the name to use in the ServletResponse's 'WWW-Authenticate' header.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setApplicationName(java.lang.String)"><!-- --></A><H3> |
| setApplicationName</H3> |
| <PRE> |
| public void <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.126"><B>setApplicationName</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> applicationName)</PRE> |
| <DL> |
| <DD>Sets the name to use in the ServletResponse's <b><code>WWW-Authenticate</code></b> header. |
| <p/> |
| Per RFC 2617, this name name is displayed to the end user when they are asked to authenticate. Unless overridden |
| by this method, the default value is "application" |
| <p/> |
| For example, setting this property to the value <b><code>Awesome Webapp</code></b> will result in the |
| following header: |
| <p/> |
| <code>WWW-Authenticate: Basic realm="<b>Awesome Webapp</b>"</code> |
| <p/> |
| Side note: As you can see from the header text, the HTTP Basic specification calls |
| this the authentication 'realm', but we call this the 'applicationName' instead to avoid confusion with |
| Shiro's Realm constructs. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>applicationName</CODE> - the name to use in the ServletResponse's 'WWW-Authenticate' header.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAuthzScheme()"><!-- --></A><H3> |
| getAuthzScheme</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.139"><B>getAuthzScheme</B></A>()</PRE> |
| <DL> |
| <DD>Returns the HTTP <b><code>Authorization</code></b> header value that this filter will respond to as indicating |
| a login request. |
| <p/> |
| Unless overridden by the <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#setAuthzScheme(java.lang.String)"><CODE>setAuthzScheme(String)</CODE></A> method, the |
| default value is <code>BASIC</code>. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the Http 'Authorization' header value that this filter will respond to as indicating a login request</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAuthzScheme(java.lang.String)"><!-- --></A><H3> |
| setAuthzScheme</H3> |
| <PRE> |
| public void <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.152"><B>setAuthzScheme</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> authzScheme)</PRE> |
| <DL> |
| <DD>Sets the HTTP <b><code>Authorization</code></b> header value that this filter will respond to as indicating a |
| login request. |
| <p/> |
| Unless overridden by this method, the default value is <code>BASIC</code> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>authzScheme</CODE> - the HTTP <code>Authorization</code> header value that this filter will respond to as |
| indicating a login request.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAuthcScheme()"><!-- --></A><H3> |
| getAuthcScheme</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.164"><B>getAuthcScheme</B></A>()</PRE> |
| <DL> |
| <DD>Returns the HTTP <b><code>WWW-Authenticate</code></b> header scheme that this filter will use when sending |
| the HTTP Basic challenge response. The default value is <code>BASIC</code>. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the HTTP <code>WWW-Authenticate</code> header scheme that this filter will use when sending the HTTP |
| Basic challenge response.<DT><B>See Also:</B><DD><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#sendChallenge(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><CODE>sendChallenge(javax.servlet.ServletRequest, javax.servlet.ServletResponse)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAuthcScheme(java.lang.String)"><!-- --></A><H3> |
| setAuthcScheme</H3> |
| <PRE> |
| public void <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.176"><B>setAuthcScheme</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> authcScheme)</PRE> |
| <DL> |
| <DD>Sets the HTTP <b><code>WWW-Authenticate</code></b> header scheme that this filter will use when sending the |
| HTTP Basic challenge response. The default value is <code>BASIC</code>. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>authcScheme</CODE> - the HTTP <code>WWW-Authenticate</code> header scheme that this filter will use when |
| sending the Http Basic challenge response.<DT><B>See Also:</B><DD><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#sendChallenge(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><CODE>sendChallenge(javax.servlet.ServletRequest, javax.servlet.ServletResponse)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><!-- --></A><H3> |
| onAccessDenied</H3> |
| <PRE> |
| protected boolean <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.187"><B>onAccessDenied</B></A>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</A> request, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</A> response) |
| throws <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Processes unauthenticated requests. It handles the two-stage request/challenge authentication protocol. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">onAccessDenied</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html" title="class in org.apache.shiro.web.filter">AccessControlFilter</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - incoming ServletRequest<DD><CODE>response</CODE> - outgoing ServletResponse |
| <DT><B>Returns:</B><DD>true if the request should be processed; false if the request should not continue to be processed |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - if there is an error processing the request.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isLoginAttempt(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><!-- --></A><H3> |
| isLoginAttempt</H3> |
| <PRE> |
| protected boolean <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.210"><B>isLoginAttempt</B></A>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</A> request, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</A> response)</PRE> |
| <DL> |
| <DD>Determines whether the incoming request is an attempt to log in. |
| <p/> |
| The default implementation obtains the value of the request's |
| <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#AUTHORIZATION_HEADER"><CODE>AUTHORIZATION_HEADER</CODE></A>, and if it is not <code>null</code>, delegates |
| to <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#isLoginAttempt(java.lang.String)"><CODE>isLoginAttempt(authzHeaderValue)</CODE></A>. If the header is <code>null</code>, |
| <code>false</code> is returned. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - incoming ServletRequest<DD><CODE>response</CODE> - outgoing ServletResponse |
| <DT><B>Returns:</B><DD>true if the incoming request is an attempt to log in based, false otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isLoginRequest(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><!-- --></A><H3> |
| isLoginRequest</H3> |
| <PRE> |
| protected final boolean <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.219"><B>isLoginRequest</B></A>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</A> request, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</A> response)</PRE> |
| <DL> |
| <DD>Delegates to <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#isLoginAttempt(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><CODE>isLoginAttempt</CODE></A>. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html#isLoginRequest(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">isLoginRequest</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html" title="class in org.apache.shiro.web.filter">AccessControlFilter</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the incoming <code>ServletRequest</code><DD><CODE>response</CODE> - the outgoing <code>ServletResponse</code> |
| <DT><B>Returns:</B><DD><code>true</code> if the incoming request is a login request, <code>false</code> otherwise.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAuthzHeader(javax.servlet.ServletRequest)"><!-- --></A><H3> |
| getAuthzHeader</H3> |
| <PRE> |
| protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.234"><B>getAuthzHeader</B></A>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</A> request)</PRE> |
| <DL> |
| <DD>Returns the <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#AUTHORIZATION_HEADER"><CODE>AUTHORIZATION_HEADER</CODE></A> from the specified ServletRequest. |
| <p/> |
| This implementation merely casts the request to an <code>HttpServletRequest</code> and returns the header: |
| <p/> |
| <code>HttpServletRequest httpRequest = <A HREF="../../../../../../org/apache/shiro/web/util/WebUtils.html#toHttp(javax.servlet.ServletRequest)"><CODE>toHttp(reaquest)</CODE></A>;<br/> |
| return httpRequest.getHeader(<A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#AUTHORIZATION_HEADER"><CODE>AUTHORIZATION_HEADER</CODE></A>);</code> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the incoming <code>ServletRequest</code> |
| <DT><B>Returns:</B><DD>the <code>Authorization</code> header's value.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isLoginAttempt(java.lang.String)"><!-- --></A><H3> |
| isLoginAttempt</H3> |
| <PRE> |
| protected boolean <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.254"><B>isLoginAttempt</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> authzHeader)</PRE> |
| <DL> |
| <DD>Default implementation that returns <code>true</code> if the specified <code>authzHeader</code> |
| starts with the same (case-insensitive) characters specified by the |
| <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthzScheme()"><CODE>authzScheme</CODE></A>, <code>false</code> otherwise. |
| <p/> |
| That is: |
| <p/> |
| <code>String authzScheme = getAuthzScheme().toLowerCase();<br/> |
| return authzHeader.toLowerCase().startsWith(authzScheme);</code> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>authzHeader</CODE> - the 'Authorization' header value (guaranteed to be non-null if the |
| <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#isLoginAttempt(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><CODE>isLoginAttempt(javax.servlet.ServletRequest, javax.servlet.ServletResponse)</CODE></A> method is not overriden). |
| <DT><B>Returns:</B><DD><code>true</code> if the authzHeader value matches that configured as defined by |
| the <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthzScheme()"><CODE>authzScheme</CODE></A>.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="sendChallenge(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><!-- --></A><H3> |
| sendChallenge</H3> |
| <PRE> |
| protected boolean <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.272"><B>sendChallenge</B></A>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</A> request, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</A> response)</PRE> |
| <DL> |
| <DD>Builds the challenge for authorization by setting a HTTP <code>401</code> (Unauthorized) status as well as the |
| response's <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#AUTHENTICATE_HEADER"><CODE>AUTHENTICATE_HEADER</CODE></A>. |
| <p/> |
| The header value constructed is equal to: |
| <p/> |
| <code><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthcScheme()"><CODE>getAuthcScheme()</CODE></A> + " realm=\"" + <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getApplicationName()"><CODE>getApplicationName()</CODE></A> + "\"";</code> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - incoming ServletRequest, ignored by this implementation<DD><CODE>response</CODE> - outgoing ServletResponse |
| <DT><B>Returns:</B><DD>false - this sends the challenge to be sent back</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createToken(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><!-- --></A><H3> |
| createToken</H3> |
| <PRE> |
| protected <A HREF="../../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</A> <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.299"><B>createToken</B></A>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</A> request, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</A> response)</PRE> |
| <DL> |
| <DD>Creates an AuthenticationToken for use during login attempt with the provided credentials in the http header. |
| <p/> |
| This implementation: |
| <ol><li>acquires the username and password based on the request's |
| <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthzHeader(javax.servlet.ServletRequest)"><CODE>authorization header</CODE></A> via the |
| <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getPrincipalsAndCredentials(java.lang.String, javax.servlet.ServletRequest)"><CODE>getPrincipalsAndCredentials</CODE></A> method</li> |
| <li>The return value of that method is converted to an <code>AuthenticationToken</code> via the |
| <A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#createToken(java.lang.String, java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><CODE>createToken</CODE></A> method</li> |
| <li>The created <code>AuthenticationToken</code> is returned.</li> |
| </ol> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#createToken(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">createToken</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticatingFilter</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - incoming ServletRequest<DD><CODE>response</CODE> - outgoing ServletResponse |
| <DT><B>Returns:</B><DD>the AuthenticationToken used to execute the login attempt</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrincipalsAndCredentials(java.lang.String, javax.servlet.ServletRequest)"><!-- --></A><H3> |
| getPrincipalsAndCredentials</H3> |
| <PRE> |
| protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.338"><B>getPrincipalsAndCredentials</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> authorizationHeader, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</A> request)</PRE> |
| <DL> |
| <DD>Returns the username obtained from the |
| <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthzHeader(javax.servlet.ServletRequest)"><CODE>authorizationHeader</CODE></A>. |
| <p/> |
| Once the <code>authzHeader</code> is split per the RFC (based on the space character ' '), the resulting split tokens |
| are translated into the username/password pair by the |
| <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getPrincipalsAndCredentials(java.lang.String, java.lang.String)"><CODE>getPrincipalsAndCredentials(scheme,encoded)</CODE></A> method. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>authorizationHeader</CODE> - the authorization header obtained from the request.<DD><CODE>request</CODE> - the incoming ServletRequest |
| <DT><B>Returns:</B><DD>the username (index 0)/password pair (index 1) submitted by the user for the given header value and request.<DT><B>See Also:</B><DD><A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthzHeader(javax.servlet.ServletRequest)"><CODE>getAuthzHeader(javax.servlet.ServletRequest)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrincipalsAndCredentials(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| getPrincipalsAndCredentials</H3> |
| <PRE> |
| protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] <A HREF="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.365"><B>getPrincipalsAndCredentials</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> scheme, |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> encoded)</PRE> |
| <DL> |
| <DD>Returns the username and password pair based on the specified <code>encoded</code> String obtained from |
| the request's authorization header. |
| <p/> |
| Per RFC 2617, the default implementation first Base64 decodes the string and then splits the resulting decoded |
| string into two based on the ":" character. That is: |
| <p/> |
| <code>String decoded = Base64.decodeToString(encoded);<br/> |
| return decoded.split(":");</code> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>scheme</CODE> - the <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthcScheme()"><CODE>authcScheme</CODE></A> found in the request |
| <A HREF="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthzHeader(javax.servlet.ServletRequest)"><CODE>authzHeader</CODE></A>. It is ignored by this implementation, |
| but available to overriding implementations should they find it useful.<DD><CODE>encoded</CODE> - the Base64-encoded username:password value found after the scheme in the header |
| <DT><B>Returns:</B><DD>the username (index 0)/password (index 1) pair obtained from the encoded header data.</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BasicHttpAuthenticationFilter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/apache/shiro/web/filter/authc/FormAuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="BasicHttpAuthenticationFilter.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2004-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
