| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="fr"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_201) on Sat May 02 22:20:04 CEST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>BasicHttpAuthenticationFilter (Apache Shiro 1.5.3 API)</title> |
| <meta name="date" content="2020-05-02"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="BasicHttpAuthenticationFilter (Apache Shiro 1.5.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/BasicHttpAuthenticationFilter.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/shiro/web/filter/authc/BearerHttpAuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html" target="_top">Frames</a></li> |
| <li><a href="BasicHttpAuthenticationFilter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.shiro.web.filter.authc</div> |
| <h2 title="Class BasicHttpAuthenticationFilter" class="title">Class BasicHttpAuthenticationFilter</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.ServletContextSupport</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.AbstractFilter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/shiro/web/servlet/NameableFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.NameableFilter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.OncePerRequestFilter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/shiro/web/servlet/AdviceFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.AdviceFilter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html" title="class in org.apache.shiro.web.filter">org.apache.shiro.web.filter.PathMatchingFilter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html" title="class in org.apache.shiro.web.filter">org.apache.shiro.web.filter.AccessControlFilter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><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></li> |
| <li> |
| <ul class="inheritance"> |
| <li><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></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javaee/5/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> |
| <br> |
| <pre>public class <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.64">BasicHttpAuthenticationFilter</a> |
| extends <a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html" title="class in org.apache.shiro.web.filter.authc">AuthenticatingFilter</a></pre> |
| <div class="block">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></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.9</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://tools.ietf.org/html/rfc2617">RFC 2617</a>, |
| <a href="http://en.wikipedia.org/wiki/Basic_access_authentication">Basic Access Authentication</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#AUTHENTICATE_HEADER">AUTHENTICATE_HEADER</a></span></code> |
| <div class="block">HTTP Authentication header, equal to <code>WWW-Authenticate</code></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#AUTHORIZATION_HEADER">AUTHORIZATION_HEADER</a></span></code> |
| <div class="block">HTTP Authorization header, equal to <code>Authorization</code></div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.web.filter.authc.AuthenticatingFilter"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#PERMISSIVE">PERMISSIVE</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.web.filter.authc.AuthenticationFilter"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html#DEFAULT_SUCCESS_URL">DEFAULT_SUCCESS_URL</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.web.filter.AccessControlFilter"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.web.filter.PathMatchingFilter"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.web.servlet.OncePerRequestFilter"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <code><a href="../../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#ALREADY_FILTERED_SUFFIX">ALREADY_FILTERED_SUFFIX</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.web.servlet.AbstractFilter"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <code><a href="../../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#filterConfig">filterConfig</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#BasicHttpAuthenticationFilter--">BasicHttpAuthenticationFilter</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#createToken-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">createToken</a></span>(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</code> |
| <div class="block">Creates an AuthenticationToken for use during login attempt with the provided credentials in the http header.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getApplicationName--">getApplicationName</a></span>()</code> |
| <div class="block">Returns the name to use in the ServletResponse's <b><code>WWW-Authenticate</code></b> header.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthcScheme--">getAuthcScheme</a></span>()</code> |
| <div class="block">Returns the HTTP <b><code>WWW-Authenticate</code></b> header scheme that this filter will use when sending |
| the HTTP Basic challenge response.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthzHeader-javax.servlet.ServletRequest-">getAuthzHeader</a></span>(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request)</code> |
| <div class="block">Returns the <a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#AUTHORIZATION_HEADER"><code>AUTHORIZATION_HEADER</code></a> from the specified ServletRequest.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthzScheme--">getAuthzScheme</a></span>()</code> |
| <div class="block">Returns the HTTP <b><code>Authorization</code></b> header value that this filter will respond to as indicating |
| a login request.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getPrincipalsAndCredentials-java.lang.String-javax.servlet.ServletRequest-">getPrincipalsAndCredentials</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authorizationHeader, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request)</code> |
| <div class="block">Returns the username obtained from the |
| <a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthzHeader-javax.servlet.ServletRequest-"><code>authorizationHeader</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getPrincipalsAndCredentials-java.lang.String-java.lang.String-">getPrincipalsAndCredentials</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> scheme, |
| <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoded)</code> |
| <div class="block">Returns the username and password pair based on the specified <code>encoded</code> String obtained from |
| the request's authorization header.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#isAccessAllowed-javax.servlet.ServletRequest-javax.servlet.ServletResponse-java.lang.Object-">isAccessAllowed</a></span>(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response, |
| <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> mappedValue)</code> |
| <div class="block">The Basic authentication filter can be configured with a list of HTTP methods to which it should apply.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#isLoginAttempt-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">isLoginAttempt</a></span>(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</code> |
| <div class="block">Determines whether the incoming request is an attempt to log in.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#isLoginAttempt-java.lang.String-">isLoginAttempt</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authzHeader)</code> |
| <div class="block">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.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#isLoginRequest-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">isLoginRequest</a></span>(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</code> |
| <div class="block">Delegates to <a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#isLoginAttempt-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>isLoginAttempt</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#onAccessDenied-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">onAccessDenied</a></span>(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</code> |
| <div class="block">Processes unauthenticated requests.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#sendChallenge-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">sendChallenge</a></span>(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</code> |
| <div class="block">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>.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#setApplicationName-java.lang.String-">setApplicationName</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationName)</code> |
| <div class="block">Sets the name to use in the ServletResponse's <b><code>WWW-Authenticate</code></b> header.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#setAuthcScheme-java.lang.String-">setAuthcScheme</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authcScheme)</code> |
| <div class="block">Sets the HTTP <b><code>WWW-Authenticate</code></b> header scheme that this filter will use when sending the |
| HTTP Basic challenge response.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#setAuthzScheme-java.lang.String-">setAuthzScheme</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authzScheme)</code> |
| <div class="block">Sets the HTTP <b><code>Authorization</code></b> header value that this filter will respond to as indicating a |
| login request.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.filter.authc.AuthenticatingFilter"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <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#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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.filter.authc.AuthenticationFilter"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.filter.AccessControlFilter"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.filter.PathMatchingFilter"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.servlet.AdviceFilter"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.servlet.OncePerRequestFilter"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.servlet.NameableFilter"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.servlet.AbstractFilter"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.servlet.ServletContextSupport"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.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="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.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="https://docs.oracle.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></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="AUTHORIZATION_HEADER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>AUTHORIZATION_HEADER</h4> |
| <pre>protected static final <a href="https://docs.oracle.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/HttpAuthenticationFilter.html#line.59">AUTHORIZATION_HEADER</a></pre> |
| <div class="block">HTTP Authorization header, equal to <code>Authorization</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter.AUTHORIZATION_HEADER">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="AUTHENTICATE_HEADER"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AUTHENTICATE_HEADER</h4> |
| <pre>protected static final <a href="https://docs.oracle.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/HttpAuthenticationFilter.html#line.64">AUTHENTICATE_HEADER</a></pre> |
| <div class="block">HTTP Authentication header, equal to <code>WWW-Authenticate</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter.AUTHENTICATE_HEADER">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="BasicHttpAuthenticationFilter--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BasicHttpAuthenticationFilter</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#line.72">BasicHttpAuthenticationFilter</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="createToken-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createToken</h4> |
| <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.93">createToken</a>(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</pre> |
| <div class="block">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></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - incoming ServletRequest</dd> |
| <dd><code>response</code> - outgoing ServletResponse</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the AuthenticationToken used to execute the login attempt</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPrincipalsAndCredentials-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrincipalsAndCredentials</h4> |
| <pre>protected <a href="https://docs.oracle.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.133">getPrincipalsAndCredentials</a>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> scheme, |
| <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoded)</pre> |
| <div class="block">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></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <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> |
| <dd><code>encoded</code> - the Base64-encoded username:password value found after the scheme in the header</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the username (index 0)/password (index 1) pair obtained from the encoded header data.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getApplicationName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getApplicationName</h4> |
| <pre>public <a href="https://docs.oracle.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/HttpAuthenticationFilter.html#line.92">getApplicationName</a>()</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name to use in the ServletResponse's 'WWW-Authenticate' header.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setApplicationName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setApplicationName</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/HttpAuthenticationFilter.html#line.113">setApplicationName</a>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationName)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>applicationName</code> - the name to use in the ServletResponse's 'WWW-Authenticate' header.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAuthzScheme--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthzScheme</h4> |
| <pre>public <a href="https://docs.oracle.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/HttpAuthenticationFilter.html#line.126">getAuthzScheme</a>()</pre> |
| <div class="block">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>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Http 'Authorization' header value that this filter will respond to as indicating a login request</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAuthzScheme-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAuthzScheme</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/HttpAuthenticationFilter.html#line.139">setAuthzScheme</a>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authzScheme)</pre> |
| <div class="block">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></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>authzScheme</code> - the HTTP <code>Authorization</code> header value that this filter will respond to as |
| indicating a login request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAuthcScheme--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthcScheme</h4> |
| <pre>public <a href="https://docs.oracle.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/HttpAuthenticationFilter.html#line.151">getAuthcScheme</a>()</pre> |
| <div class="block">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>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the HTTP <code>WWW-Authenticate</code> header scheme that this filter will use when sending the HTTP |
| Basic challenge response.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAuthcScheme-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAuthcScheme</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/HttpAuthenticationFilter.html#line.163">setAuthcScheme</a>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authcScheme)</pre> |
| <div class="block">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>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>authcScheme</code> - the HTTP <code>WWW-Authenticate</code> header scheme that this filter will use when |
| sending the Http Basic challenge response.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAccessAllowed-javax.servlet.ServletRequest-javax.servlet.ServletResponse-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAccessAllowed</h4> |
| <pre>protected boolean <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/HttpAuthenticationFilter.html#line.180">isAccessAllowed</a>(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response, |
| <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> mappedValue)</pre> |
| <div class="block">The Basic authentication filter can be configured with a list of HTTP methods to which it should apply. This |
| method ensures that authentication is <em>only</em> required for those HTTP methods specified. For example, |
| if you had the configuration: |
| <pre> |
| [urls] |
| /basic/** = authcBasic[POST,PUT,DELETE] |
| </pre> |
| then a GET request would not required authentication but a POST would.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html#isAccessAllowed-javax.servlet.ServletRequest-javax.servlet.ServletResponse-java.lang.Object-">isAccessAllowed</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></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The current HTTP servlet request.</dd> |
| <dd><code>response</code> - The current HTTP servlet response.</dd> |
| <dd><code>mappedValue</code> - The array of configured HTTP methods as strings. This is empty if no methods are configured.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if request should be allowed access</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onAccessDenied-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onAccessDenied</h4> |
| <pre>protected boolean <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/HttpAuthenticationFilter.html#line.227">onAccessDenied</a>(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response) |
| throws <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Processes unauthenticated requests. It handles the two-stage request/challenge authentication protocol.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <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></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - incoming ServletRequest</dd> |
| <dd><code>response</code> - outgoing ServletResponse</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the request should be processed; false if the request should not continue to be processed</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.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.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isLoginAttempt-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLoginAttempt</h4> |
| <pre>protected boolean <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/HttpAuthenticationFilter.html#line.250">isLoginAttempt</a>(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - incoming ServletRequest</dd> |
| <dd><code>response</code> - outgoing ServletResponse</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the incoming request is an attempt to log in based, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isLoginRequest-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLoginRequest</h4> |
| <pre>protected final boolean <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/HttpAuthenticationFilter.html#line.259">isLoginRequest</a>(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</pre> |
| <div class="block">Delegates to <a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#isLoginAttempt-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>isLoginAttempt</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <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></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - the incoming <code>ServletRequest</code></dd> |
| <dd><code>response</code> - the outgoing <code>ServletResponse</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the incoming request is a login request, <code>false</code> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAuthzHeader-javax.servlet.ServletRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthzHeader</h4> |
| <pre>protected <a href="https://docs.oracle.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/HttpAuthenticationFilter.html#line.274">getAuthzHeader</a>(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request)</pre> |
| <div class="block">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></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - the incoming <code>ServletRequest</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Authorization</code> header's value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isLoginAttempt-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLoginAttempt</h4> |
| <pre>protected boolean <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/HttpAuthenticationFilter.html#line.294">isLoginAttempt</a>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authzHeader)</pre> |
| <div class="block">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></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <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(ServletRequest, ServletResponse)</code></a> method is not overriden).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <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>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendChallenge-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendChallenge</h4> |
| <pre>protected boolean <a href="../../../../../../src-html/org/apache/shiro/web/filter/authc/HttpAuthenticationFilter.html#line.312">sendChallenge</a>(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</pre> |
| <div class="block">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></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - incoming ServletRequest, ignored by this implementation</dd> |
| <dd><code>response</code> - outgoing ServletResponse</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>false - this sends the challenge to be sent back</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPrincipalsAndCredentials-java.lang.String-javax.servlet.ServletRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getPrincipalsAndCredentials</h4> |
| <pre>protected <a href="https://docs.oracle.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/HttpAuthenticationFilter.html#line.375">getPrincipalsAndCredentials</a>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authorizationHeader, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>authorizationHeader</code> - the authorization header obtained from the request.</dd> |
| <dd><code>request</code> - the incoming ServletRequest</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the username (index 0)/password pair (index 1) submitted by the user for the given header value and request.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html#getAuthzHeader-javax.servlet.ServletRequest-"><code>getAuthzHeader(ServletRequest)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/BasicHttpAuthenticationFilter.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/shiro/web/filter/authc/BearerHttpAuthenticationFilter.html" title="class in org.apache.shiro.web.filter.authc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html" target="_top">Frames</a></li> |
| <li><a href="BasicHttpAuthenticationFilter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |