blob: 5474515e0f12112f5d464b24eadae8b45a8b3195 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Overview (Apache Shiro :: Core 1.10.1 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.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.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.6.0.min.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Overview (Apache Shiro :: Core 1.10.1 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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>
<div class="header">
<h1 class="title">Apache Shiro :: Core 1.10.1 API</h1>
</div>
<main role="main">
<div class="contentContainer">
<table class="overviewSummary">
<caption><span>Packages</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" id="i0">
<th class="colFirst" scope="row"><a href="org/apache/shiro/package-summary.html">org.apache.shiro</a></th>
<td class="colLast">
<div class="block">This package primarily exists as a root classpath distinction, but it does contain two core classes widely used
by applications, <a href="org/apache/shiro/SecurityUtils.html" title="class in org.apache.shiro"><code>SecurityUtils</code></a> and
<code>ShiroException</code>.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<th class="colFirst" scope="row"><a href="org/apache/shiro/aop/package-summary.html">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="altColor" id="i2">
<th class="colFirst" scope="row"><a href="org/apache/shiro/authc/package-summary.html">org.apache.shiro.authc</a></th>
<td class="colLast">
<div class="block">Core interfaces and exceptions concerning Authentication (the act of logging-in).</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<th class="colFirst" scope="row"><a href="org/apache/shiro/authc/credential/package-summary.html">org.apache.shiro.authc.credential</a></th>
<td class="colLast">
<div class="block">Support for validating <em>credentials</em> (such as passwords or X509 certificates) during
authentication via the <a href="org/apache/shiro/authc/credential/CredentialsMatcher.html" title="interface in org.apache.shiro.authc.credential"><code>CredentialsMatcher</code></a>
interface and its supporting implementations.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<th class="colFirst" scope="row"><a href="org/apache/shiro/authc/pam/package-summary.html">org.apache.shiro.authc.pam</a></th>
<td class="colLast">
<div class="block">Support for <em>PAM</em>, or <b>P</b>luggable <b>A</b>uthentication <b>M</b>odules, which is
the capability to authenticate a user against multiple configurable (pluggable) <em>modules</em> (Shiro
calls these <a href="org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a>s).</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<th class="colFirst" scope="row"><a href="org/apache/shiro/authz/package-summary.html">org.apache.shiro.authz</a></th>
<td class="colLast">
<div class="block">Core interfaces and exceptions supporting Authorization (access control).</div>
</td>
</tr>
<tr class="altColor" id="i6">
<th class="colFirst" scope="row"><a href="org/apache/shiro/authz/annotation/package-summary.html">org.apache.shiro.authz.annotation</a></th>
<td class="colLast">
<div class="block">Annotations used to restrict which classes, instances, or methods may be accessed or invoked depending on the
caller's access abilities or authentication state.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<th class="colFirst" scope="row"><a href="org/apache/shiro/authz/aop/package-summary.html">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>
<tr class="altColor" id="i8">
<th class="colFirst" scope="row"><a href="org/apache/shiro/authz/permission/package-summary.html">org.apache.shiro.authz.permission</a></th>
<td class="colLast">
<div class="block">Support and default implementations for Shiro's <a href="org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a>
interface.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<th class="colFirst" scope="row"><a href="org/apache/shiro/concurrent/package-summary.html">org.apache.shiro.concurrent</a></th>
<td class="colLast">
<div class="block"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Executor</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>ExecutorService</code></a>,
and <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>ScheduledExecutorService</code></a> implementations for transparent
<a href="org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> association with threads in an asynchronous execution environment.</div>
</td>
</tr>
<tr class="altColor" id="i10">
<th class="colFirst" scope="row"><a href="org/apache/shiro/config/package-summary.html">org.apache.shiro.config</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i11">
<th class="colFirst" scope="row"><a href="org/apache/shiro/dao/package-summary.html">org.apache.shiro.dao</a></th>
<td class="colLast">
<div class="block">Package containing various components useful when building Data Access Objects (DAOs), including a generic
Data Access Exception hierarchy.</div>
</td>
</tr>
<tr class="altColor" id="i12">
<th class="colFirst" scope="row"><a href="org/apache/shiro/env/package-summary.html">org.apache.shiro.env</a></th>
<td class="colLast">
<div class="block">Concepts used to represent Shiro's aggregate state in an application.</div>
</td>
</tr>
<tr class="rowColor" id="i13">
<th class="colFirst" scope="row"><a href="org/apache/shiro/jndi/package-summary.html">org.apache.shiro.jndi</a></th>
<td class="colLast">
<div class="block">Enables accessing objects located in JNDI that might be useful when configuring a Shiro-enabled application.</div>
</td>
</tr>
<tr class="altColor" id="i14">
<th class="colFirst" scope="row"><a href="org/apache/shiro/ldap/package-summary.html">org.apache.shiro.ldap</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i15">
<th class="colFirst" scope="row"><a href="org/apache/shiro/mgt/package-summary.html">org.apache.shiro.mgt</a></th>
<td class="colLast">
<div class="block">Provides the master <a href="org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> interface and a default implementation
hierarchy for managing all aspects of Shiro's functionality in an application.</div>
</td>
</tr>
<tr class="altColor" id="i16">
<th class="colFirst" scope="row"><a href="org/apache/shiro/realm/package-summary.html">org.apache.shiro.realm</a></th>
<td class="colLast">
<div class="block">Components and sub-packages used in supporting the core <a href="org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a> interface.</div>
</td>
</tr>
<tr class="rowColor" id="i17">
<th class="colFirst" scope="row"><a href="org/apache/shiro/realm/activedirectory/package-summary.html">org.apache.shiro.realm.activedirectory</a></th>
<td class="colLast">
<div class="block">Realms that acquire security data from a Microsoft Active Directory.</div>
</td>
</tr>
<tr class="altColor" id="i18">
<th class="colFirst" scope="row"><a href="org/apache/shiro/realm/jdbc/package-summary.html">org.apache.shiro.realm.jdbc</a></th>
<td class="colLast">
<div class="block">Realms that acquire security data from an RDBMS (Relational Database Management System) using the
JDBC API.</div>
</td>
</tr>
<tr class="rowColor" id="i19">
<th class="colFirst" scope="row"><a href="org/apache/shiro/realm/jndi/package-summary.html">org.apache.shiro.realm.jndi</a></th>
<td class="colLast">
<div class="block">Support for acquiring Realms from JNDI, particularly useful for configuring Shiro in JEE or EJB environments.</div>
</td>
</tr>
<tr class="altColor" id="i20">
<th class="colFirst" scope="row"><a href="org/apache/shiro/realm/ldap/package-summary.html">org.apache.shiro.realm.ldap</a></th>
<td class="colLast">
<div class="block">Realms that acquire security data from an LDAP (Lightweight Directory Access Protocol) server
utilizing LDAP/Naming APIs.</div>
</td>
</tr>
<tr class="rowColor" id="i21">
<th class="colFirst" scope="row"><a href="org/apache/shiro/realm/text/package-summary.html">org.apache.shiro.realm.text</a></th>
<td class="colLast">
<div class="block">Realms that acquire security data from text-based data sources such as <code>File</code>s or
text streams.</div>
</td>
</tr>
<tr class="altColor" id="i22">
<th class="colFirst" scope="row"><a href="org/apache/shiro/session/package-summary.html">org.apache.shiro.session</a></th>
<td class="colLast">
<div class="block">Components related to managing sessions, the time-based data contexts in which a Subject
interacts with an application.</div>
</td>
</tr>
<tr class="rowColor" id="i23">
<th class="colFirst" scope="row"><a href="org/apache/shiro/session/mgt/package-summary.html">org.apache.shiro.session.mgt</a></th>
<td class="colLast">
<div class="block"><a href="org/apache/shiro/session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>SessionManager</code></a> components supporting enterprise session management.</div>
</td>
</tr>
<tr class="altColor" id="i24">
<th class="colFirst" scope="row"><a href="org/apache/shiro/session/mgt/eis/package-summary.html">org.apache.shiro.session.mgt.eis</a></th>
<td class="colLast">
<div class="block">EIS (Enterprise Information System)-tier components that can perform CRUD operations for sessions
using any EIS API.</div>
</td>
</tr>
<tr class="rowColor" id="i25">
<th class="colFirst" scope="row"><a href="org/apache/shiro/subject/package-summary.html">org.apache.shiro.subject</a></th>
<td class="colLast">
<div class="block">Components supporting the <a href="org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> interface, the most important concept in
Shiro's API.</div>
</td>
</tr>
<tr class="altColor" id="i26">
<th class="colFirst" scope="row"><a href="org/apache/shiro/subject/support/package-summary.html">org.apache.shiro.subject.support</a></th>
<td class="colLast">
<div class="block">Concrete support implementations of most of the <code>org.apache.shiro.subject</code> interfaces.</div>
</td>
</tr>
<tr class="rowColor" id="i27">
<th class="colFirst" scope="row"><a href="org/apache/shiro/util/package-summary.html">org.apache.shiro.util</a></th>
<td class="colLast">
<div class="block">Your run-of-the-mill 'util' package for components and logic widely used across the framework that can't
find their home into a proper OO hierarchy (or, most likely for things used across many hierarchies).</div>
</td>
</tr>
</tbody>
</table>
</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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>