blob: 2d934086a9a312410f4e834b3ecb756b9c083676 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.6) on Mon Mar 23 13:34:45 EDT 2020 -->
<title>Uses of Interface org.apache.shiro.aop.MethodInterceptor (Apache Shiro :: Core 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="Uses of Interface org.apache.shiro.aop.MethodInterceptor (Apache Shiro :: Core 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><a href="../package-summary.html">Package</a></li>
<li><a href="../MethodInterceptor.html" title="interface in org.apache.shiro.aop">Class</a></li>
<li class="navBarCell1Rev">Use</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&nbsp;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">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h2 title="Uses of Interface org.apache.shiro.aop.MethodInterceptor" class="title">Uses of Interface<br>org.apache.shiro.aop.MethodInterceptor</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="../MethodInterceptor.html" title="interface in org.apache.shiro.aop">MethodInterceptor</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.shiro.aop">org.apache.shiro.aop</a></th>
<td class="colLast">
<div class="block">Components used to support the framework's AOP/interception support classes.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.shiro.authz.aop">org.apache.shiro.authz.aop</a></th>
<td class="colLast">
<div class="block">Contains AOP implementation support classes specifically used for authorization operations, particularly supporting
AOP Method Interceptors and JSR-175 metadata Annotations.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList">
<section role="region"><a id="org.apache.shiro.aop">
<!-- -->
</a>
<h3>Uses of <a href="../MethodInterceptor.html" title="interface in org.apache.shiro.aop">MethodInterceptor</a> in <a href="../package-summary.html">org.apache.shiro.aop</a></h3>
<table class="useSummary">
<caption><span>Classes in <a href="../package-summary.html">org.apache.shiro.aop</a> that implement <a href="../MethodInterceptor.html" title="interface in org.apache.shiro.aop">MethodInterceptor</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../AnnotationMethodInterceptor.html" title="class in org.apache.shiro.aop">AnnotationMethodInterceptor</a></span></code></th>
<td class="colLast">
<div class="block">MethodInterceptor that inspects a specific annotation on the method invocation before continuing
its execution.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../MethodInterceptorSupport.html" title="class in org.apache.shiro.aop">MethodInterceptorSupport</a></span></code></th>
<td class="colLast">
<div class="block">This class is an abstraction of AOP method interceptor behavior specific to Shiro that
leaves AOP implementation specifics to be handled by subclass implementations.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section role="region"><a id="org.apache.shiro.authz.aop">
<!-- -->
</a>
<h3>Uses of <a href="../MethodInterceptor.html" title="interface in org.apache.shiro.aop">MethodInterceptor</a> in <a href="../../authz/aop/package-summary.html">org.apache.shiro.authz.aop</a></h3>
<table class="useSummary">
<caption><span>Classes in <a href="../../authz/aop/package-summary.html">org.apache.shiro.authz.aop</a> that implement <a href="../MethodInterceptor.html" title="interface in org.apache.shiro.aop">MethodInterceptor</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../authz/aop/AnnotationsAuthorizingMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">AnnotationsAuthorizingMethodInterceptor</a></span></code></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">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../authz/aop/AuthenticatedAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">AuthenticatedAnnotationMethodInterceptor</a></span></code></th>
<td class="colLast">
<div class="block">Checks to see if a @<a href="../../authz/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="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../authz/aop/AuthorizingAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">AuthorizingAnnotationMethodInterceptor</a></span></code></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">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../authz/aop/AuthorizingMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">AuthorizingMethodInterceptor</a></span></code></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">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../authz/aop/GuestAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">GuestAnnotationMethodInterceptor</a></span></code></th>
<td class="colLast">
<div class="block">Checks to see if a @<a href="../../authz/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">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../authz/aop/PermissionAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">PermissionAnnotationMethodInterceptor</a></span></code></th>
<td class="colLast">
<div class="block">Checks to see if a @<a href="../../authz/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">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../authz/aop/RoleAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">RoleAnnotationMethodInterceptor</a></span></code></th>
<td class="colLast">
<div class="block">Checks to see if a @<a href="../../authz/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="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../authz/aop/UserAnnotationMethodInterceptor.html" title="class in org.apache.shiro.authz.aop">UserAnnotationMethodInterceptor</a></span></code></th>
<td class="colLast">
<div class="block">Checks to see if a @<a href="../../authz/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>
</section>
</li>
</ul>
</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><a href="../package-summary.html">Package</a></li>
<li><a href="../MethodInterceptor.html" title="interface in org.apache.shiro.aop">Class</a></li>
<li class="navBarCell1Rev">Use</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&nbsp;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 &#169; 2004&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>