| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_65) on Tue Feb 25 18:15:54 EST 2014 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| org.apache.shiro.util (Apache Shiro 1.2.3 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2014-02-25"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.shiro.util (Apache Shiro 1.2.3 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/shiro/tools/hasher/package-summary.html"><B>PREV PACKAGE</B></A> |
| <A HREF="../../../../org/apache/shiro/web/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/shiro/util/package-summary.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <H2> |
| Package org.apache.shiro.util |
| </H2> |
| Your run-of-the-mill 'util' pacakge 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). |
| <P> |
| <B>See:</B> |
| <BR> |
| <A HREF="#package_description"><B>Description</B></A> |
| <P> |
| |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Interface Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</A></B></TD> |
| <TD>A <code>ByteSource</code> wraps a byte array and provides additional encoding operations.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</A></B></TD> |
| <TD>Shiro container-agnostic interface that indicates that this object requires a callback during destruction.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/Factory.html" title="interface in org.apache.shiro.util">Factory<T></A></B></TD> |
| <TD>Generics-aware interface supporting the |
| <a href="http://en.wikipedia.org/wiki/Factory_method_pattern">Factory Method</a> design pattern.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/Initializable.html" title="interface in org.apache.shiro.util">Initializable</A></B></TD> |
| <TD>Shiro container-agnostic interface that indicates that this object requires initialization.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/Nameable.html" title="interface in org.apache.shiro.util">Nameable</A></B></TD> |
| <TD>Interface implemented by components that can be named, such as via configuration, and wish to have that name |
| set once it has been configured.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/PatternMatcher.html" title="interface in org.apache.shiro.util">PatternMatcher</A></B></TD> |
| <TD>Interface for components that can match source strings against a specified pattern string.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/ThreadState.html" title="interface in org.apache.shiro.util">ThreadState</A></B></TD> |
| <TD>A <code>ThreadState</code> instance manages any state that might need to be bound and/or restored during a thread's |
| execution.</TD> |
| </TR> |
| </TABLE> |
| |
| |
| <P> |
| |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Class Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/AbstractFactory.html" title="class in org.apache.shiro.util">AbstractFactory<T></A></B></TD> |
| <TD>TODO - Class JavaDoc</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/AntPathMatcher.html" title="class in org.apache.shiro.util">AntPathMatcher</A></B></TD> |
| <TD>PathMatcher implementation for Ant-style path patterns.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/ByteSource.Util.html" title="class in org.apache.shiro.util">ByteSource.Util</A></B></TD> |
| <TD>Utility class that can construct ByteSource instances.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/ClassUtils.html" title="class in org.apache.shiro.util">ClassUtils</A></B></TD> |
| <TD>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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/CollectionUtils.html" title="class in org.apache.shiro.util">CollectionUtils</A></B></TD> |
| <TD>Static helper class for use dealing with Collections.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/JavaEnvironment.html" title="class in org.apache.shiro.util">JavaEnvironment</A></B></TD> |
| <TD>Internal helper class used to find the Java/JDK version |
| that Shiro is operating within, to allow for automatically |
| adapting to the present platform's capabilities.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/JdbcUtils.html" title="class in org.apache.shiro.util">JdbcUtils</A></B></TD> |
| <TD>A set of static helper methods for managing JDBC API objects.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/LifecycleUtils.html" title="class in org.apache.shiro.util">LifecycleUtils</A></B></TD> |
| <TD>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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/MapContext.html" title="class in org.apache.shiro.util">MapContext</A></B></TD> |
| <TD>A <code>MapContext</code> provides a common base for context-based data storage in a <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/PermissionUtils.html" title="class in org.apache.shiro.util">PermissionUtils</A></B></TD> |
| <TD>Utility class to help with String-to-Permission object resolution.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/RegExPatternMatcher.html" title="class in org.apache.shiro.util">RegExPatternMatcher</A></B></TD> |
| <TD><code>PatternMatcher</code> implementation that uses standard <A HREF="http://java.sun.com/javase/6/docs/api/java/util/regex/package-summary.html?is-external=true"><CODE>java.util.regex</CODE></A> objects.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/SimpleByteSource.html" title="class in org.apache.shiro.util">SimpleByteSource</A></B></TD> |
| <TD>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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/SoftHashMap.html" title="class in org.apache.shiro.util">SoftHashMap<K,V></A></B></TD> |
| <TD>A <code><em>Soft</em>HashMap</code> is a memory-constrained map that stores its <em>values</em> in |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/ref/SoftReference.html?is-external=true" title="class or interface in java.lang.ref"><CODE>SoftReference</CODE></A>s.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/StringUtils.html" title="class in org.apache.shiro.util">StringUtils</A></B></TD> |
| <TD>Simple utility class for String operations useful across the framework.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/ThreadContext.html" title="class in org.apache.shiro.util">ThreadContext</A></B></TD> |
| <TD>A ThreadContext provides a means of binding and unbinding objects to the |
| current thread based on key/value pairs.</TD> |
| </TR> |
| </TABLE> |
| |
| |
| <P> |
| |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Exception Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/InstantiationException.html" title="class in org.apache.shiro.util">InstantiationException</A></B></TD> |
| <TD>Runtime exception thrown by the framework when unable to instantiate a Class via reflection.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/UnavailableConstructorException.html" title="class in org.apache.shiro.util">UnavailableConstructorException</A></B></TD> |
| <TD>Exception thrown when attempting to instantiate a Class via reflection, but a suitable constructor (depending |
| on the number of expected arguments) doesn't exist or cannot be obtained.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/shiro/util/UnknownClassException.html" title="class in org.apache.shiro.util">UnknownClassException</A></B></TD> |
| <TD>The Shiro framework's <code>RuntimeException</code> equivalent of the JDK's |
| <code>ClassNotFoundException</code>, to maintain a RuntimeException paradigm.</TD> |
| </TR> |
| </TABLE> |
| |
| |
| <P> |
| <A NAME="package_description"><!-- --></A><H2> |
| Package org.apache.shiro.util Description |
| </H2> |
| |
| <P> |
| Your run-of-the-mill 'util' pacakge 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). |
| <P> |
| |
| <P> |
| <DL> |
| </DL> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/shiro/tools/hasher/package-summary.html"><B>PREV PACKAGE</B></A> |
| <A HREF="../../../../org/apache/shiro/web/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/shiro/util/package-summary.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2004-2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
