| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_25) on Wed May 25 23:25:54 EDT 2016 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>AuthorizationInfo (Apache Shiro 1.2.5 API)</title> |
| <meta name="date" content="2016-05-25"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AuthorizationInfo (Apache Shiro 1.2.5 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AuthorizationInfo.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"> |
| <li><a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/authz/Authorizer.html" title="interface in org.apache.shiro.authz"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/authz/AuthorizationInfo.html" target="_top">Frames</a></li> |
| <li><a href="AuthorizationInfo.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.shiro.authz</div> |
| <h2 title="Interface AuthorizationInfo" class="title">Interface AuthorizationInfo</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/shiro/authc/Account.html" title="interface in org.apache.shiro.authc">Account</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/shiro/authc/SimpleAccount.html" title="class in org.apache.shiro.authc">SimpleAccount</a>, <a href="../../../../org/apache/shiro/authz/SimpleAuthorizationInfo.html" title="class in org.apache.shiro.authz">SimpleAuthorizationInfo</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../src-html/org/apache/shiro/authz/AuthorizationInfo.html#line.58">AuthorizationInfo</a> |
| extends <a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> |
| <div class="block"><code>AuthorizationInfo</code> represents a single Subject's stored authorization data (roles, permissions, etc) |
| used during authorization (access control) checks only. |
| <p/> |
| Roles are represented as a <code>Collection</code> of Strings |
| (<a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a>>), typically each element being the Role name. |
| <p/> |
| <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a>s are provided in two ways: |
| <ul> |
| <li>A <code>Collection</code> of Strings, where each String can usually be converted into <code>Permission</code> |
| objects by a <code>Realm</code>'s |
| <a href="../../../../org/apache/shiro/authz/permission/PermissionResolver.html" title="interface in org.apache.shiro.authz.permission"><code>PermissionResolver</code></a></li> |
| <li>A <code>Collection</code> of <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a> objects</li> |
| </ul> |
| Both permission collections together represent the total aggregate collection of permissions. You may use one |
| or both depending on your preference and needs. |
| <p/> |
| Because the act of authorization (access control) is orthoganal to authentication (log-in), this interface is |
| intended to represent only the account data needed by Shiro during an access control check |
| (role, permission, etc). Shiro also has a parallel |
| <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a> interface for use during the authentication |
| process that represents identity data such as principals and credentials. |
| <p/> |
| Because many if not most <a href="../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a>s store both sets of data for a Subject, it might be |
| convenient for a <code>Realm</code> implementation to utilize an implementation of the |
| <a href="../../../../org/apache/shiro/authc/Account.html" title="interface in org.apache.shiro.authc"><code>Account</code></a> interface instead, which is a convenience interface that combines both |
| <code>AuthenticationInfo</code> and <code>AuthorizationInfo</code>. Whether you choose to implement these two |
| interfaces separately or implement the one <code>Account</code> interface for a given <code>Realm</code> is |
| entirely based on your application's needs or your preferences.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.9</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc"><code>AuthenticationInfo</code></a>, |
| <a href="../../../../org/apache/shiro/authc/Account.html" title="interface in org.apache.shiro.authc"><code>Account</code></a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/AuthorizationInfo.html#getObjectPermissions()">getObjectPermissions</a></strong>()</code> |
| <div class="block">Returns all type-safe <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a>s assigned to the corresponding Subject.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/AuthorizationInfo.html#getRoles()">getRoles</a></strong>()</code> |
| <div class="block">Returns the names of all roles assigned to a corresponding Subject.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/AuthorizationInfo.html#getStringPermissions()">getStringPermissions</a></strong>()</code> |
| <div class="block">Returns all string-based permissions assigned to the corresponding Subject.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getRoles()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRoles</h4> |
| <pre><a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../src-html/org/apache/shiro/authz/AuthorizationInfo.html#line.65">getRoles</a>()</pre> |
| <div class="block">Returns the names of all roles assigned to a corresponding Subject.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the names of all roles assigned to a corresponding Subject.</dd></dl> |
| </li> |
| </ul> |
| <a name="getStringPermissions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStringPermissions</h4> |
| <pre><a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../src-html/org/apache/shiro/authz/AuthorizationInfo.html#line.82">getStringPermissions</a>()</pre> |
| <div class="block">Returns all string-based permissions assigned to the corresponding Subject. The permissions here plus those |
| returned from <a href="../../../../org/apache/shiro/authz/AuthorizationInfo.html#getObjectPermissions()"><code>getObjectPermissions()</code></a> represent the total set of permissions |
| assigned. The aggregate set is used to perform a permission authorization check. |
| <p/> |
| This method is a convenience mechanism that allows Realms to represent permissions as Strings if they choose. |
| When performing a security check, a <code>Realm</code> usually converts these strings to object |
| <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a>s via an internal |
| <a href="../../../../org/apache/shiro/authz/permission/PermissionResolver.html" title="interface in org.apache.shiro.authz.permission"><code>PermissionResolver</code></a> |
| in order to perform the actual permission check. This is not a requirement of course, since <code>Realm</code>s |
| can perform security checks in whatever manner deemed necessary, but this explains the conversion mechanism that |
| most Shiro Realms execute for string-based permission checks.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>all string-based permissions assigned to the corresponding Subject.</dd></dl> |
| </li> |
| </ul> |
| <a name="getObjectPermissions()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getObjectPermissions</h4> |
| <pre><a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>> <a href="../../../../src-html/org/apache/shiro/authz/AuthorizationInfo.html#line.91">getObjectPermissions</a>()</pre> |
| <div class="block">Returns all type-safe <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a>s assigned to the corresponding Subject. The permissions |
| returned from this method plus any returned from <a href="../../../../org/apache/shiro/authz/AuthorizationInfo.html#getStringPermissions()"><code>getStringPermissions()</code></a> |
| represent the total set of permissions. The aggregate set is used to perform a permission authorization check.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>all type-safe <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a>s assigned to the corresponding Subject.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AuthorizationInfo.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"> |
| <li><a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/authz/Authorizer.html" title="interface in org.apache.shiro.authz"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/authz/AuthorizationInfo.html" target="_top">Frames</a></li> |
| <li><a href="AuthorizationInfo.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |