blob: 2b04cc2e270716ee38e7ae86fb5d314c80400177 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (11.0.4) on Fri Jan 24 17:07:14 CET 2020 -->
<title>org.apache.shiro.util (Apache Shiro 1.5.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-01-24">
<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.util (Apache Shiro 1.5.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">
<!-- ========= 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.util</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<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>
</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="ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a></th>
<td class="colLast">
<div class="block">A <code>ByteSource</code> wraps a byte array and provides additional encoding operations.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a></th>
<td class="colLast">
<div class="block">Shiro container-agnostic interface that indicates that this object requires a callback during destruction.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Factory.html" title="interface in org.apache.shiro.util">Factory</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">Generics-aware interface supporting the
<a href="http://en.wikipedia.org/wiki/Factory_method_pattern">Factory Method</a> design pattern.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Initializable.html" title="interface in org.apache.shiro.util">Initializable</a></th>
<td class="colLast">
<div class="block">Shiro container-agnostic interface that indicates that this object requires initialization.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Nameable.html" title="interface in org.apache.shiro.util">Nameable</a></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PatternMatcher.html" title="interface in org.apache.shiro.util">PatternMatcher</a></th>
<td class="colLast">
<div class="block">Interface for components that can match source strings against a specified pattern string.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ThreadState.html" title="interface in org.apache.shiro.util">ThreadState</a></th>
<td class="colLast">
<div class="block">A <code>ThreadState</code> instance manages any state that might need to be bound and/or restored during a thread's
execution.</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="AbstractFactory.html" title="class in org.apache.shiro.util">AbstractFactory</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">TODO - Class JavaDoc</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AntPathMatcher.html" title="class in org.apache.shiro.util">AntPathMatcher</a></th>
<td class="colLast">
<div class="block">PathMatcher implementation for Ant-style path patterns.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Assert.html" title="class in org.apache.shiro.util">Assert</a></th>
<td class="colLast">
<div class="block">Assertion utility class that assists in validating arguments.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ByteSource.Util.html" title="class in org.apache.shiro.util">ByteSource.Util</a></th>
<td class="colLast">
<div class="block">Utility class that can construct ByteSource instances.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ClassUtils.html" title="class in org.apache.shiro.util">ClassUtils</a></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CollectionUtils.html" title="class in org.apache.shiro.util">CollectionUtils</a></th>
<td class="colLast">
<div class="block">Static helper class for use dealing with Collections.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JavaEnvironment.html" title="class in org.apache.shiro.util">JavaEnvironment</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">This class is no longer used in Shiro and will be removed in the next major version.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JdbcUtils.html" title="class in org.apache.shiro.util">JdbcUtils</a></th>
<td class="colLast">
<div class="block">A set of static helper methods for managing JDBC API objects.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LifecycleUtils.html" title="class in org.apache.shiro.util">LifecycleUtils</a></th>
<td class="colLast">
<div class="block">Utility class to help call <a href="Initializable.html#init()"><code>Initializable.init()</code></a> and
<a href="Destroyable.html#destroy()"><code>Destroyable.destroy()</code></a> methods cleanly on any object.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MapContext.html" title="class in org.apache.shiro.util">MapContext</a></th>
<td class="colLast">
<div class="block">A <code>MapContext</code> provides a common base for context-based data storage in a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PermissionUtils.html" title="class in org.apache.shiro.util">PermissionUtils</a></th>
<td class="colLast">
<div class="block">Utility class to help with String-to-Permission object resolution.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RegExPatternMatcher.html" title="class in org.apache.shiro.util">RegExPatternMatcher</a></th>
<td class="colLast">
<div class="block"><code>PatternMatcher</code> implementation that uses standard <a href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/package-summary.html?is-external=true" class="externalLink"><code>java.util.regex</code></a> objects.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SimpleByteSource.html" title="class in org.apache.shiro.util">SimpleByteSource</a></th>
<td class="colLast">
<div class="block">Very simple <a href="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="../codec/Hex.html" title="class in org.apache.shiro.codec"><code>Hex</code></a> and <a href="../codec/Base64.html" title="class in org.apache.shiro.codec"><code>Base64</code></a> codec classes to support the
<a href="SimpleByteSource.html#toHex()"><code>toHex()</code></a> and <a href="SimpleByteSource.html#toBase64()"><code>toBase64()</code></a> implementations.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SoftHashMap.html" title="class in org.apache.shiro.util">SoftHashMap</a>&lt;K,&#8203;V&gt;</th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="StringUtils.html" title="class in org.apache.shiro.util">StringUtils</a></th>
<td class="colLast">
<div class="block">Simple utility class for String operations useful across the framework.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ThreadContext.html" title="class in org.apache.shiro.util">ThreadContext</a></th>
<td class="colLast">
<div class="block">A ThreadContext provides a means of binding and unbinding objects to the
current thread based on key/value pairs.</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="InstantiationException.html" title="class in org.apache.shiro.util">InstantiationException</a></th>
<td class="colLast">
<div class="block">Runtime exception thrown by the framework when unable to instantiate a Class via reflection.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="UnknownClassException.html" title="class in org.apache.shiro.util">UnknownClassException</a></th>
<td class="colLast">
<div class="block">The Shiro framework's <code>RuntimeException</code> equivalent of the JDK's
<code>ClassNotFoundException</code>, to maintain a RuntimeException paradigm.</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;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>