| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.6) on Mon Mar 23 13:31:56 EDT 2020 --> |
| <title>org.apache.shiro.authz.aop (Apache Shiro 1.5.2 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-03-23"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.shiro.authz.aop (Apache Shiro 1.5.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.shiro.authz.aop</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">Contains AOP implementation support classes specifically used for authorization operations, particularly supporting |
| AOP Method Interceptors and JSR-175 metadata Annotations.</div> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AnnotationsAuthorizingMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">AnnotationsAuthorizingMethodInterceptor</a></th> |
| <td class="colLast"> |
| <div class="block">An <tt>AnnotationsAuthorizingMethodInterceptor</tt> is a MethodInterceptor that asserts a given method is authorized |
| to execute based on one or more configured <tt>AuthorizingAnnotationMethodInterceptor</tt>s.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AuthenticatedAnnotationHandler.html" title="class in org.apache.shiro.authz.aop">AuthenticatedAnnotationHandler</a></th> |
| <td class="colLast"> |
| <div class="block">Handles <a href="../annotation/RequiresAuthentication.html" title="annotation in org.apache.shiro.authz.annotation"><code>RequiresAuthentication</code></a> annotations and ensures the calling subject is |
| authenticated before allowing access.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AuthenticatedAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">AuthenticatedAnnotationMethodInterceptor</a></th> |
| <td class="colLast"> |
| <div class="block">Checks to see if a @<a href="../annotation/RequiresAuthentication.html" title="annotation in org.apache.shiro.authz.annotation"><code>RequiresAuthenticated</code></a> annotation |
| is declared, and if so, ensures the calling |
| <code>Subject</code>.<a href="../../subject/Subject.html#isAuthenticated()"><code>isAuthenticated()</code></a> before invoking |
| the method.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AuthorizingAnnotationHandler.html" title="class in org.apache.shiro.authz.aop">AuthorizingAnnotationHandler</a></th> |
| <td class="colLast"> |
| <div class="block">An AnnotationHandler that executes authorization (access control) behavior based on directive(s) found in a |
| JSR-175 Annotation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AuthorizingAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">AuthorizingAnnotationMethodInterceptor</a></th> |
| <td class="colLast"> |
| <div class="block">An <tt>AnnotationMethodInterceptor</tt> that asserts the calling code is authorized to execute the method |
| before allowing the invocation to continue by inspecting code annotations to perform an access control check.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AuthorizingMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">AuthorizingMethodInterceptor</a></th> |
| <td class="colLast"> |
| <div class="block">Basic abstract class to support intercepting methods that perform authorization (access control) checks.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="GuestAnnotationHandler.html" title="class in org.apache.shiro.authz.aop">GuestAnnotationHandler</a></th> |
| <td class="colLast"> |
| <div class="block">Checks to see if a @<a href="../annotation/RequiresGuest.html" title="annotation in org.apache.shiro.authz.annotation"><code>RequiresGuest</code></a> annotation |
| is declared, and if so, ensures the calling <code>Subject</code> does <em>not</em> |
| have an <a href="../../subject/Subject.html#getPrincipal()"><code>identity</code></a> before invoking the method.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="GuestAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">GuestAnnotationMethodInterceptor</a></th> |
| <td class="colLast"> |
| <div class="block">Checks to see if a @<a href="../annotation/RequiresGuest.html" title="annotation in org.apache.shiro.authz.annotation"><code>RequiresGuest</code></a> annotation |
| is declared, and if so, ensures the calling <code>Subject</code> does <em>not</em> |
| have an <a href="../../subject/Subject.html#getPrincipal()"><code>identity</code></a> before invoking the method.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PermissionAnnotationHandler.html" title="class in org.apache.shiro.authz.aop">PermissionAnnotationHandler</a></th> |
| <td class="colLast"> |
| <div class="block">Checks to see if a @<a href="../annotation/RequiresPermissions.html" title="annotation in org.apache.shiro.authz.annotation"><code>RequiresPermissions</code></a> annotation is |
| declared, and if so, performs a permission check to see if the calling <code>Subject</code> is allowed continued |
| access.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="PermissionAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">PermissionAnnotationMethodInterceptor</a></th> |
| <td class="colLast"> |
| <div class="block">Checks to see if a @<a href="../annotation/RequiresPermissions.html" title="annotation in org.apache.shiro.authz.annotation"><code>RequiresPermissions</code></a> annotation is declared, and if so, performs |
| a permission check to see if the calling <code>Subject</code> is allowed to call the method.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RoleAnnotationHandler.html" title="class in org.apache.shiro.authz.aop">RoleAnnotationHandler</a></th> |
| <td class="colLast"> |
| <div class="block">Checks to see if a @<a href="../annotation/RequiresRoles.html" title="annotation in org.apache.shiro.authz.annotation"><code>RequiresRoles</code></a> annotation is declared, and if so, performs |
| a role check to see if the calling <code>Subject</code> is allowed to proceed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RoleAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">RoleAnnotationMethodInterceptor</a></th> |
| <td class="colLast"> |
| <div class="block">Checks to see if a @<a href="../annotation/RequiresRoles.html" title="annotation in org.apache.shiro.authz.annotation"><code>RequiresRoles</code></a> annotation is declared, and if so, performs |
| a role check to see if the calling <code>Subject</code> is allowed to invoke the method.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="UserAnnotationHandler.html" title="class in org.apache.shiro.authz.aop">UserAnnotationHandler</a></th> |
| <td class="colLast"> |
| <div class="block">Checks to see if a @<a href="../annotation/RequiresUser.html" title="annotation in org.apache.shiro.authz.annotation"><code>RequiresUser</code></a> annotation |
| is declared, and if so, ensures the calling <code>Subject</code> is <em>either</em> |
| <a href="../../subject/Subject.html#isAuthenticated()"><code>authenticated</code></a> <b><em>or</em></b> remembered via remember |
| me services before allowing access.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="UserAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">UserAnnotationMethodInterceptor</a></th> |
| <td class="colLast"> |
| <div class="block">Checks to see if a @<a href="../annotation/RequiresUser.html" title="annotation in org.apache.shiro.authz.annotation"><code>RequiresUser</code></a> annotation |
| is declared, and if so, ensures the calling <code>Subject</code> is <em>either</em> |
| <a href="../../subject/Subject.html#isAuthenticated()"><code>authenticated</code></a> <b><em>or</em></b> remembered via remember |
| me services before invoking the method.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
