blob: 3d0ebea3cb9f497612cdb1299651667cd76b0565 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.shiro.authz.permission (Apache Shiro 1.10.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<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.5.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.permission (Apache Shiro 1.10.0 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"><!-- Matomo --> <script> var _paq = window._paq = window._paq || []; /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ /* We explicitly disable cookie tracking to avoid privacy issues */ _paq.push(['disableCookies']); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="//matomo.privacy.apache.org/"; _paq.push(['setTrackerUrl', u+'matomo.php']); _paq.push(['setSiteId', '2']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Matomo Code -->
<!-- ========= 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&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">
<h1 title="Package" class="title">Package&nbsp;org.apache.shiro.authz.permission</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Support and default implementations for Shiro's <a href="../Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a>
interface.
<p/>
Also note the <a href="PermissionResolver.html" title="interface in org.apache.shiro.authz.permission"><code>PermissionResolver</code></a> interface, as
it plays an important part in many of Shiro's <a href="../../realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a> implementations
and AOP support.</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PermissionResolver.html" title="interface in org.apache.shiro.authz.permission">PermissionResolver</a></th>
<td class="colLast">
<div class="block">A <code>PermisisonResolver</code> resolves a String value and converts it into a
<a href="../Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a> instance.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PermissionResolverAware.html" title="interface in org.apache.shiro.authz.permission">PermissionResolverAware</a></th>
<td class="colLast">
<div class="block">Interface implemented by a component that wishes to use any application-configured <tt>PermissionResolver</tt> that
might already exist instead of potentially creating one itself.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RolePermissionResolver.html" title="interface in org.apache.shiro.authz.permission">RolePermissionResolver</a></th>
<td class="colLast">
<div class="block">A RolePermissionResolver resolves a String value and converts it into a Collection of
<a href="../Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a> instances.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RolePermissionResolverAware.html" title="interface in org.apache.shiro.authz.permission">RolePermissionResolverAware</a></th>
<td class="colLast">
<div class="block">Interface implemented by a component that wishes to use any application-configured <tt>RolePermissionResolver</tt> that
might already exist instead of potentially creating one itself.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</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="AllPermission.html" title="class in org.apache.shiro.authz.permission">AllPermission</a></th>
<td class="colLast">
<div class="block">An all <tt>AllPermission</tt> instance is one that always implies any other permission; that is, its
<a href="AllPermission.html#implies(org.apache.shiro.authz.Permission)"><code>implies</code></a> method always returns <tt>true</tt>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DomainPermission.html" title="class in org.apache.shiro.authz.permission">DomainPermission</a></th>
<td class="colLast">
<div class="block">Provides a base Permission class from which type-safe/domain-specific subclasses may extend.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="WildcardPermission.html" title="class in org.apache.shiro.authz.permission">WildcardPermission</a></th>
<td class="colLast">
<div class="block">A <code>WildcardPermission</code> is a very flexible permission construct supporting multiple levels of
permission matching.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="WildcardPermissionResolver.html" title="class in org.apache.shiro.authz.permission">WildcardPermissionResolver</a></th>
<td class="colLast">
<div class="block"><tt>PermissionResolver</tt> implementation that returns a new <a href="WildcardPermission.html" title="class in org.apache.shiro.authz.permission"><code>WildcardPermission</code></a>
based on the input string.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="InvalidPermissionStringException.html" title="class in org.apache.shiro.authz.permission">InvalidPermissionStringException</a></th>
<td class="colLast">
<div class="block">Thrown by <a href="PermissionResolver.html#resolvePermission(java.lang.String)"><code>PermissionResolver.resolvePermission(String)</code></a> when the String being parsed is not
valid for that resolver.</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&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;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>