blob: 7d28b831afc94243f023eff7f7fe63477ad15ab2 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Classes (Apache Shiro :: Lang 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="All Classes (Apache Shiro :: Lang 1.10.1 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":2,"i1":2,"i2":1,"i3":2,"i4":2,"i5":2,"i6":8,"i7":2,"i8":2,"i9":1,"i10":1,"i11":2,"i12":2,"i13":1,"i14":8,"i15":2,"i16":1,"i17":2,"i18":8,"i19":1,"i20":8,"i21":2,"i22":2,"i23":2,"i24":8,"i25":2};
var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"],8:["t4","Exception Summary"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
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>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>
<main role="main">
<div class="header">
<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
</div>
<div class="allClassesContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span id="t0" class="activeTableTab"><span>All Classes</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Interface Summary</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Class Summary</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Exception Summary</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><a href="org/apache/shiro/util/Assert.html" title="class in org.apache.shiro.util">Assert</a></td>
<th class="colLast" scope="row">
<div class="block">Assertion utility class that assists in validating arguments.</div>
</th>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><a href="org/apache/shiro/codec/Base64.html" title="class in org.apache.shiro.codec">Base64</a></td>
<th class="colLast" scope="row">
<div class="block">Provides <a href="http://en.wikipedia.org/wiki/Base64">Base 64</a> encoding and decoding as defined by
<a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>.</div>
</th>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><a href="org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a></td>
<th class="colLast" scope="row">
<div class="block">A <code>ByteSource</code> wraps a byte array and provides additional encoding operations.</div>
</th>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><a href="org/apache/shiro/util/ByteSource.Util.html" title="class in org.apache.shiro.util">ByteSource.Util</a></td>
<th class="colLast" scope="row">
<div class="block">Utility class that can construct ByteSource instances.</div>
</th>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><a href="org/apache/shiro/io/ClassResolvingObjectInputStream.html" title="class in org.apache.shiro.io">ClassResolvingObjectInputStream</a></td>
<th class="colLast" scope="row">
<div class="block">Enables correct ClassLoader lookup in various environments (e.g.</div>
</th>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><a href="org/apache/shiro/util/ClassUtils.html" title="class in org.apache.shiro.util">ClassUtils</a></td>
<th class="colLast" scope="row">
<div class="block">Utility method library used to conveniently interact with <code>Class</code>es, such as acquiring them from the
application <code>ClassLoader</code>s and instantiating Objects from them.</div>
</th>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><a href="org/apache/shiro/codec/CodecException.html" title="class in org.apache.shiro.codec">CodecException</a></td>
<th class="colLast" scope="row">
<div class="block">Root exception related to issues during encoding or decoding.</div>
</th>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><a href="org/apache/shiro/codec/CodecSupport.html" title="class in org.apache.shiro.codec">CodecSupport</a></td>
<th class="colLast" scope="row">
<div class="block">Base abstract class that provides useful encoding and decoding operations, especially for character data.</div>
</th>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><a href="org/apache/shiro/io/DefaultSerializer.html" title="class in org.apache.shiro.io">DefaultSerializer</a>&lt;<a href="org/apache/shiro/io/DefaultSerializer.html" title="type parameter in DefaultSerializer">T</a>&gt;</td>
<th class="colLast" scope="row">
<div class="block">Serializer implementation that uses the default JVM serialization mechanism (Object Input/Output Streams).</div>
</th>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><a href="org/apache/shiro/util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a></td>
<th class="colLast" scope="row">
<div class="block">Shiro container-agnostic interface that indicates that this object requires a callback during destruction.</div>
</th>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><a href="org/apache/shiro/util/Factory.html" title="interface in org.apache.shiro.util">Factory</a>&lt;<a href="org/apache/shiro/util/Factory.html" title="type parameter in Factory">T</a>&gt;</td>
<th class="colLast" scope="row">
<div class="block">Generics-aware interface supporting the
<a href="http://en.wikipedia.org/wiki/Factory_method_pattern">Factory Method</a> design pattern.</div>
</th>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><a href="org/apache/shiro/codec/H64.html" title="class in org.apache.shiro.codec">H64</a></td>
<th class="colLast" scope="row">
<div class="block">Codec for <a href="http://en.wikipedia.org/wiki/Crypt_(Unix)">Unix Crypt</a>-style encoding.</div>
</th>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><a href="org/apache/shiro/codec/Hex.html" title="class in org.apache.shiro.codec">Hex</a></td>
<th class="colLast" scope="row">
<div class="block"><a href="http://en.wikipedia.org/wiki/Hexadecimal">Hexadecimal</a> encoder and decoder.</div>
</th>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><a href="org/apache/shiro/util/Initializable.html" title="interface in org.apache.shiro.util">Initializable</a></td>
<th class="colLast" scope="row">
<div class="block">Shiro container-agnostic interface that indicates that this object requires initialization.</div>
</th>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><a href="org/apache/shiro/util/InstantiationException.html" title="class in org.apache.shiro.util">InstantiationException</a></td>
<th class="colLast" scope="row">
<div class="block">Runtime exception thrown by the framework when unable to instantiate a Class via reflection.</div>
</th>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><a href="org/apache/shiro/util/LifecycleUtils.html" title="class in org.apache.shiro.util">LifecycleUtils</a></td>
<th class="colLast" scope="row">
<div class="block">Utility class to help call <a href="org/apache/shiro/util/Initializable.html#init()"><code>Initializable.init()</code></a> and
<a href="org/apache/shiro/util/Destroyable.html#destroy()"><code>Destroyable.destroy()</code></a> methods cleanly on any object.</div>
</th>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><a href="org/apache/shiro/util/Nameable.html" title="interface in org.apache.shiro.util">Nameable</a></td>
<th class="colLast" scope="row">
<div class="block">Interface implemented by components that can be named, such as via configuration, and wish to have that name
set once it has been configured.</div>
</th>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><a href="org/apache/shiro/io/ResourceUtils.html" title="class in org.apache.shiro.io">ResourceUtils</a></td>
<th class="colLast" scope="row">
<div class="block">Static helper methods for loading <code>Stream</code>-backed resources.</div>
</th>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><a href="org/apache/shiro/io/SerializationException.html" title="class in org.apache.shiro.io">SerializationException</a></td>
<th class="colLast" scope="row">
<div class="block">Root exception for problems either serializing or de-serializing data.</div>
</th>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><a href="org/apache/shiro/io/Serializer.html" title="interface in org.apache.shiro.io">Serializer</a>&lt;<a href="org/apache/shiro/io/Serializer.html" title="type parameter in Serializer">T</a>&gt;</td>
<th class="colLast" scope="row">
<div class="block">A <code>Serializer</code> converts objects to raw binary data and vice versa, enabling persistent storage
of objects to files, HTTP cookies, or other mechanism.</div>
</th>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><a href="org/apache/shiro/ShiroException.html" title="class in org.apache.shiro">ShiroException</a></td>
<th class="colLast" scope="row">
<div class="block">Root exception for all Shiro runtime exceptions.</div>
</th>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><a href="org/apache/shiro/util/SimpleByteSource.html" title="class in org.apache.shiro.util">SimpleByteSource</a></td>
<th class="colLast" scope="row">
<div class="block">Very simple <a href="org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util"><code>ByteSource</code></a> implementation that maintains an internal <code>byte[]</code> array and uses the
<a href="org/apache/shiro/codec/Hex.html" title="class in org.apache.shiro.codec"><code>Hex</code></a> and <a href="org/apache/shiro/codec/Base64.html" title="class in org.apache.shiro.codec"><code>Base64</code></a> codec classes to support the
<a href="org/apache/shiro/util/SimpleByteSource.html#toHex()"><code>toHex()</code></a> and <a href="org/apache/shiro/util/SimpleByteSource.html#toBase64()"><code>toBase64()</code></a> implementations.</div>
</th>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><a href="org/apache/shiro/util/SoftHashMap.html" title="class in org.apache.shiro.util">SoftHashMap</a>&lt;<a href="org/apache/shiro/util/SoftHashMap.html" title="type parameter in SoftHashMap">K</a>,&#8203;<a href="org/apache/shiro/util/SoftHashMap.html" title="type parameter in SoftHashMap">V</a>&gt;</td>
<th class="colLast" scope="row">
<div class="block">A <code><em>Soft</em>HashMap</code> is a memory-constrained map that stores its <em>values</em> in
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ref/SoftReference.html?is-external=true" title="class or interface in java.lang.ref" class="externalLink"><code>SoftReference</code></a>s.</div>
</th>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><a href="org/apache/shiro/util/StringUtils.html" title="class in org.apache.shiro.util">StringUtils</a></td>
<th class="colLast" scope="row">
<div class="block">Simple utility class for String operations useful across the framework.</div>
</th>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><a href="org/apache/shiro/util/UnknownClassException.html" title="class in org.apache.shiro.util">UnknownClassException</a></td>
<th class="colLast" scope="row">
<div class="block">The Shiro framework's <code>RuntimeException</code> equivalent of the JDK's
<code>ClassNotFoundException</code>, to maintain a RuntimeException paradigm.</div>
</th>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><a href="org/apache/shiro/io/XmlSerializer.html" title="class in org.apache.shiro.io">XmlSerializer</a></td>
<th class="colLast" scope="row">Deprecated.
<div class="deprecationComment">This class should not be used directly because of unsecure XMLEncoder/XMLDecoder usage.</div>
</th>
</tr>
</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>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>