| <!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_21) on Thu May 30 15:02:17 PDT 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>Authorizer (Apache Shiro 1.2.2 API)</title> |
| <meta name="date" content="2013-05-30"> |
| <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="Authorizer (Apache Shiro 1.2.2 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/Authorizer.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/AuthorizationInfo.html" title="interface in org.apache.shiro.authz"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/authz/HostUnauthorizedException.html" title="class 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/Authorizer.html" target="_top">Frames</a></li> |
| <li><a href="Authorizer.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 Authorizer" class="title">Interface Authorizer</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a>, <a href="../../../../org/apache/shiro/web/mgt/WebSecurityManager.html" title="interface in org.apache.shiro.web.mgt">WebSecurityManager</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/shiro/realm/ldap/AbstractLdapRealm.html" title="class in org.apache.shiro.realm.ldap">AbstractLdapRealm</a>, <a href="../../../../org/apache/shiro/realm/activedirectory/ActiveDirectoryRealm.html" title="class in org.apache.shiro.realm.activedirectory">ActiveDirectoryRealm</a>, <a href="../../../../org/apache/shiro/mgt/AuthenticatingSecurityManager.html" title="class in org.apache.shiro.mgt">AuthenticatingSecurityManager</a>, <a href="../../../../org/apache/shiro/realm/AuthorizingRealm.html" title="class in org.apache.shiro.realm">AuthorizingRealm</a>, <a href="../../../../org/apache/shiro/mgt/AuthorizingSecurityManager.html" title="class in org.apache.shiro.mgt">AuthorizingSecurityManager</a>, <a href="../../../../org/apache/shiro/mgt/CachingSecurityManager.html" title="class in org.apache.shiro.mgt">CachingSecurityManager</a>, <a href="../../../../org/apache/shiro/cas/CasRealm.html" title="class in org.apache.shiro.cas">CasRealm</a>, <a href="../../../../org/apache/shiro/mgt/DefaultSecurityManager.html" title="class in org.apache.shiro.mgt">DefaultSecurityManager</a>, <a href="../../../../org/apache/shiro/web/mgt/DefaultWebSecurityManager.html" title="class in org.apache.shiro.web.mgt">DefaultWebSecurityManager</a>, <a href="../../../../org/apache/shiro/realm/text/IniRealm.html" title="class in org.apache.shiro.realm.text">IniRealm</a>, <a href="../../../../org/apache/shiro/realm/jdbc/JdbcRealm.html" title="class in org.apache.shiro.realm.jdbc">JdbcRealm</a>, <a href="../../../../org/apache/shiro/realm/ldap/JndiLdapRealm.html" title="class in org.apache.shiro.realm.ldap">JndiLdapRealm</a>, <a href="../../../../org/apache/shiro/authz/ModularRealmAuthorizer.html" title="class in org.apache.shiro.authz">ModularRealmAuthorizer</a>, <a href="../../../../org/apache/shiro/realm/text/PropertiesRealm.html" title="class in org.apache.shiro.realm.text">PropertiesRealm</a>, <a href="../../../../org/apache/shiro/mgt/RealmSecurityManager.html" title="class in org.apache.shiro.mgt">RealmSecurityManager</a>, <a href="../../../../org/apache/shiro/mgt/SessionsSecurityManager.html" title="class in org.apache.shiro.mgt">SessionsSecurityManager</a>, <a href="../../../../org/apache/shiro/realm/SimpleAccountRealm.html" title="class in org.apache.shiro.realm">SimpleAccountRealm</a>, <a href="../../../../org/apache/shiro/realm/text/TextConfigurationRealm.html" title="class in org.apache.shiro.realm.text">TextConfigurationRealm</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.48">Authorizer</a></pre> |
| <div class="block">An <tt>Authorizer</tt> performs authorization (access control) operations for any given Subject |
| (aka 'application user'). |
| |
| <p>Each method requires a subject principal to perform the action for the corresponding Subject/user. |
| |
| <p>This principal argument is usually an object representing a user database primary key or a String username or |
| something similar that uniquely identifies an application user. The runtime value of the this principal |
| is application-specific and provided by the application's configured Realms. |
| |
| <p>Note that there are many *Permission methods in this interface overloaded to accept String arguments instead of |
| <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a> instances. They are a convenience allowing the caller to use a String representation of |
| a <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a> if desired. Most implementations of this interface will simply convert these |
| String values to <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a> instances and then just call the corresponding type-safe method. |
| (Shiro's default implementations do String-to-Permission conversion for these methods using |
| <a href="../../../../org/apache/shiro/authz/permission/PermissionResolver.html" title="interface in org.apache.shiro.authz.permission"><code>PermissionResolver</code></a>s.) |
| |
| <p>These overloaded *Permission methods <em>do</em> forego type-saftey for the benefit of convenience and simplicity, |
| so you should choose which ones to use based on your preferences and needs.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.1</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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#checkPermission(org.apache.shiro.subject.PrincipalCollection, org.apache.shiro.authz.Permission)">checkPermission</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a> permission)</code> |
| <div class="block">Ensures a subject/user <a href="../../../../org/apache/shiro/authz/Permission.html#implies(org.apache.shiro.authz.Permission)"><code>Permission.implies(Permission)</code></a> implies} the specified <tt>Permission</tt>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#checkPermission(org.apache.shiro.subject.PrincipalCollection, java.lang.String)">checkPermission</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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> permission)</code> |
| <div class="block">Ensures the corresponding Subject/user implies the specified permission String.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#checkPermissions(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)">checkPermissions</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>> permissions)</code> |
| <div class="block">Ensures the corresponding Subject/user |
| <a href="../../../../org/apache/shiro/authz/Permission.html#implies(org.apache.shiro.authz.Permission)"><code>implies</code></a> all of the |
| specified permission strings.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#checkPermissions(org.apache.shiro.subject.PrincipalCollection, java.lang.String...)">checkPermissions</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>... permissions)</code> |
| <div class="block">Ensures the corresponding Subject/user |
| <a href="../../../../org/apache/shiro/authz/Permission.html#implies(org.apache.shiro.authz.Permission)"><code>implies</code></a> all of the |
| specified permission strings.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#checkRole(org.apache.shiro.subject.PrincipalCollection, java.lang.String)">checkRole</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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> roleIdentifier)</code> |
| <div class="block">Asserts the corresponding Subject/user has the specified role by returning quietly if they do or throwing an |
| <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz"><code>AuthorizationException</code></a> if they do not.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#checkRoles(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)">checkRoles</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>> roleIdentifiers)</code> |
| <div class="block">Asserts the corresponding Subject/user has all of the specified roles by returning quietly if they do or |
| throwing an <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz"><code>AuthorizationException</code></a> if they do not.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#checkRoles(org.apache.shiro.subject.PrincipalCollection, java.lang.String...)">checkRoles</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>... roleIdentifiers)</code> |
| <div class="block">Same as <a href="../../../../org/apache/shiro/authz/Authorizer.html#checkRoles(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)"><code>checkRoles(PrincipalCollection subjectPrincipal, Collection<String> roleIdentifiers)</code></a> but doesn't require a collection |
| as an argument.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#hasAllRoles(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)">hasAllRoles</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>> roleIdentifiers)</code> |
| <div class="block">Returns <tt>true</tt> if the corresponding Subject/user has all of the specified roles, <tt>false</tt> otherwise.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#hasRole(org.apache.shiro.subject.PrincipalCollection, java.lang.String)">hasRole</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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> roleIdentifier)</code> |
| <div class="block">Returns <tt>true</tt> if the corresponding Subject/user has the specified role, <tt>false</tt> otherwise.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#hasRoles(org.apache.shiro.subject.PrincipalCollection, java.util.List)">hasRoles</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <a href="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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>> roleIdentifiers)</code> |
| <div class="block">Checks if the corresponding Subject/user has the specified roles, returning a boolean array indicating |
| which roles are associated with the given subject.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#isPermitted(org.apache.shiro.subject.PrincipalCollection, java.util.List)">isPermitted</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <a href="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>> permissions)</code> |
| <div class="block">Checks if the corresponding Subject/user implies the given Permissions and returns a boolean array indicating |
| which permissions are implied.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#isPermitted(org.apache.shiro.subject.PrincipalCollection, org.apache.shiro.authz.Permission)">isPermitted</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a> permission)</code> |
| <div class="block">Returns <tt>true</tt> if the corresponding subject/user is permitted to perform an action or access a resource |
| summarized by the specified permission.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#isPermitted(org.apache.shiro.subject.PrincipalCollection, java.lang.String...)">isPermitted</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>... permissions)</code> |
| <div class="block">Checks if the corresponding Subject implies the given permission strings and returns a boolean array |
| indicating which permissions are implied.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#isPermitted(org.apache.shiro.subject.PrincipalCollection, java.lang.String)">isPermitted</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals, |
| <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> permission)</code> |
| <div class="block">Returns <tt>true</tt> if the corresponding subject/user is permitted to perform an action or access a resource |
| summarized by the specified permission string.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#isPermittedAll(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)">isPermittedAll</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>> permissions)</code> |
| <div class="block">Returns <tt>true</tt> if the corresponding Subject/user implies all of the specified permissions, <tt>false</tt> |
| otherwise.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/authz/Authorizer.html#isPermittedAll(org.apache.shiro.subject.PrincipalCollection, java.lang.String...)">isPermittedAll</a></strong>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>... permissions)</code> |
| <div class="block">Returns <tt>true</tt> if the corresponding Subject/user implies all of the specified permission strings, |
| <tt>false</tt> otherwise.</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="isPermitted(org.apache.shiro.subject.PrincipalCollection, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPermitted</h4> |
| <pre>boolean <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.63">isPermitted</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals, |
| <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> permission)</pre> |
| <div class="block">Returns <tt>true</tt> if the corresponding subject/user is permitted to perform an action or access a resource |
| summarized by the specified permission string. |
| |
| <p>This is an overloaded method for the corresponding type-safe <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a> variant. |
| Please see the class-level JavaDoc for more information on these String-based permission methods.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>principals</code> - the application-specific subject/user identifier.</dd><dd><code>permission</code> - the String representation of a Permission that is being checked.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the corresponding Subject/user is permitted, false otherwise.</dd><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/authz/Authorizer.html#isPermitted(org.apache.shiro.subject.PrincipalCollection, org.apache.shiro.authz.Permission)"><code>isPermitted(PrincipalCollection principals,Permission permission)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="isPermitted(org.apache.shiro.subject.PrincipalCollection, org.apache.shiro.authz.Permission)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPermitted</h4> |
| <pre>boolean <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.76">isPermitted</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a> permission)</pre> |
| <div class="block">Returns <tt>true</tt> if the corresponding subject/user is permitted to perform an action or access a resource |
| summarized by the specified permission. |
| |
| <p>More specifically, this method determines if any <tt>Permission</tt>s associated |
| with the subject <a href="../../../../org/apache/shiro/authz/Permission.html#implies(org.apache.shiro.authz.Permission)"><code>imply</code></a> the specified permission.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectPrincipal</code> - the application-specific subject/user identifier.</dd><dd><code>permission</code> - the permission that is being checked.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the corresponding Subject/user is permitted, false otherwise.</dd></dl> |
| </li> |
| </ul> |
| <a name="isPermitted(org.apache.shiro.subject.PrincipalCollection, java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPermitted</h4> |
| <pre>boolean[] <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.93">isPermitted</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>... permissions)</pre> |
| <div class="block">Checks if the corresponding Subject implies the given permission strings and returns a boolean array |
| indicating which permissions are implied. |
| |
| <p>This is an overloaded method for the corresponding type-safe <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a> variant. |
| Please see the class-level JavaDoc for more information on these String-based permission methods.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectPrincipal</code> - the application-specific subject/user identifier.</dd><dd><code>permissions</code> - the String representations of the Permissions that are being checked.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an array of booleans whose indices correspond to the index of the |
| permissions in the given list. A true value at an index indicates the user is permitted for |
| for the associated <tt>Permission</tt> string in the list. A false value at an index |
| indicates otherwise.</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.9</dd></dl> |
| </li> |
| </ul> |
| <a name="isPermitted(org.apache.shiro.subject.PrincipalCollection, java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPermitted</h4> |
| <pre>boolean[] <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.113">isPermitted</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <a href="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a>> permissions)</pre> |
| <div class="block">Checks if the corresponding Subject/user implies the given Permissions and returns a boolean array indicating |
| which permissions are implied. |
| |
| <p>More specifically, this method should determine if each <tt>Permission</tt> in |
| the array is <a href="../../../../org/apache/shiro/authz/Permission.html#implies(org.apache.shiro.authz.Permission)"><code>implied</code></a> by permissions |
| already associated with the subject. |
| |
| <p>This is primarily a performance-enhancing method to help reduce the number of |
| <a href="../../../../org/apache/shiro/authz/Authorizer.html#isPermitted(org.apache.shiro.subject.PrincipalCollection, java.lang.String)"><code>isPermitted(org.apache.shiro.subject.PrincipalCollection, java.lang.String)</code></a> invocations over the wire in client/server systems.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectPrincipal</code> - the application-specific subject/user identifier.</dd><dd><code>permissions</code> - the permissions that are being checked.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an array of booleans whose indices correspond to the index of the |
| permissions in the given list. A true value at an index indicates the user is permitted for |
| for the associated <tt>Permission</tt> object in the list. A false value at an index |
| indicates otherwise.</dd></dl> |
| </li> |
| </ul> |
| <a name="isPermittedAll(org.apache.shiro.subject.PrincipalCollection, java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPermittedAll</h4> |
| <pre>boolean <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.128">isPermittedAll</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>... permissions)</pre> |
| <div class="block">Returns <tt>true</tt> if the corresponding Subject/user implies all of the specified permission strings, |
| <tt>false</tt> otherwise. |
| |
| <p>This is an overloaded method for the corresponding type-safe <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a> variant. |
| Please see the class-level JavaDoc for more information on these String-based permission methods.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectPrincipal</code> - the application-specific subject/user identifier.</dd><dd><code>permissions</code> - the String representations of the Permissions that are being checked.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the user has all of the specified permissions, false otherwise.</dd><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/authz/Authorizer.html#isPermittedAll(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)"><code>isPermittedAll(PrincipalCollection,Collection)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="isPermittedAll(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPermittedAll</h4> |
| <pre>boolean <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.141">isPermittedAll</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>> permissions)</pre> |
| <div class="block">Returns <tt>true</tt> if the corresponding Subject/user implies all of the specified permissions, <tt>false</tt> |
| otherwise. |
| |
| <p>More specifically, this method determines if all of the given <tt>Permission</tt>s are |
| <a href="../../../../org/apache/shiro/authz/Permission.html#implies(org.apache.shiro.authz.Permission)"><code>implied by</code></a> permissions already associated with the subject.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectPrincipal</code> - the application-specific subject/user identifier.</dd><dd><code>permissions</code> - the permissions to check.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the user has all of the specified permissions, false otherwise.</dd></dl> |
| </li> |
| </ul> |
| <a name="checkPermission(org.apache.shiro.subject.PrincipalCollection, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkPermission</h4> |
| <pre>void <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.158">checkPermission</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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> permission) |
| throws <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></pre> |
| <div class="block">Ensures the corresponding Subject/user implies the specified permission String. |
| |
| <p>If the subject's existing associated permissions do not <a href="../../../../org/apache/shiro/authz/Permission.html#implies(org.apache.shiro.authz.Permission)"><code>Permission.implies(Permission)</code></a> imply} |
| the given permission, an <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz"><code>AuthorizationException</code></a> will be thrown. |
| |
| <p>This is an overloaded method for the corresponding type-safe <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a> variant. |
| Please see the class-level JavaDoc for more information on these String-based permission methods.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectPrincipal</code> - the application-specific subject/user identifier.</dd><dd><code>permission</code> - the String representation of the Permission to check.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></code> - if the user does not have the permission.</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.9</dd></dl> |
| </li> |
| </ul> |
| <a name="checkPermission(org.apache.shiro.subject.PrincipalCollection, org.apache.shiro.authz.Permission)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkPermission</h4> |
| <pre>void <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.170">checkPermission</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz">Permission</a> permission) |
| throws <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></pre> |
| <div class="block">Ensures a subject/user <a href="../../../../org/apache/shiro/authz/Permission.html#implies(org.apache.shiro.authz.Permission)"><code>Permission.implies(Permission)</code></a> implies} the specified <tt>Permission</tt>. |
| If the subject's exisiting associated permissions do not <a href="../../../../org/apache/shiro/authz/Permission.html#implies(org.apache.shiro.authz.Permission)"><code>Permission.implies(Permission)</code></a> imply} |
| the given permission, an <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz"><code>AuthorizationException</code></a> will be thrown.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectPrincipal</code> - the application-specific subject/user identifier.</dd><dd><code>permission</code> - the Permission to check.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></code> - if the user does not have the permission.</dd></dl> |
| </li> |
| </ul> |
| <a name="checkPermissions(org.apache.shiro.subject.PrincipalCollection, java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkPermissions</h4> |
| <pre>void <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.189">checkPermissions</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>... permissions) |
| throws <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></pre> |
| <div class="block">Ensures the corresponding Subject/user |
| <a href="../../../../org/apache/shiro/authz/Permission.html#implies(org.apache.shiro.authz.Permission)"><code>implies</code></a> all of the |
| specified permission strings. |
| |
| If the subject's exisiting associated permissions do not |
| <a href="../../../../org/apache/shiro/authz/Permission.html#implies(org.apache.shiro.authz.Permission)"><code>imply</code></a> all of the given permissions, |
| an <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz"><code>AuthorizationException</code></a> will be thrown. |
| |
| <p>This is an overloaded method for the corresponding type-safe <a href="../../../../org/apache/shiro/authz/Permission.html" title="interface in org.apache.shiro.authz"><code>Permission</code></a> variant. |
| Please see the class-level JavaDoc for more information on these String-based permission methods.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectPrincipal</code> - the application-specific subject/user identifier.</dd><dd><code>permissions</code> - the string representations of Permissions to check.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></code> - if the user does not have all of the given permissions.</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.9</dd></dl> |
| </li> |
| </ul> |
| <a name="checkPermissions(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkPermissions</h4> |
| <pre>void <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.204">checkPermissions</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>> permissions) |
| throws <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></pre> |
| <div class="block">Ensures the corresponding Subject/user |
| <a href="../../../../org/apache/shiro/authz/Permission.html#implies(org.apache.shiro.authz.Permission)"><code>implies</code></a> all of the |
| specified permission strings. |
| |
| If the subject's exisiting associated permissions do not |
| <a href="../../../../org/apache/shiro/authz/Permission.html#implies(org.apache.shiro.authz.Permission)"><code>imply</code></a> all of the given permissions, |
| an <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz"><code>AuthorizationException</code></a> will be thrown.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectPrincipal</code> - the application-specific subject/user identifier.</dd><dd><code>permissions</code> - the Permissions to check.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></code> - if the user does not have all of the given permissions.</dd></dl> |
| </li> |
| </ul> |
| <a name="hasRole(org.apache.shiro.subject.PrincipalCollection, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasRole</h4> |
| <pre>boolean <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.213">hasRole</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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> roleIdentifier)</pre> |
| <div class="block">Returns <tt>true</tt> if the corresponding Subject/user has the specified role, <tt>false</tt> otherwise.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectPrincipal</code> - the application-specific subject/user identifier.</dd><dd><code>roleIdentifier</code> - the application-specific role identifier (usually a role id or role name).</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if the corresponding subject has the specified role, <tt>false</tt> otherwise.</dd></dl> |
| </li> |
| </ul> |
| <a name="hasRoles(org.apache.shiro.subject.PrincipalCollection, java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasRoles</h4> |
| <pre>boolean[] <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.228">hasRoles</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <a href="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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>> roleIdentifiers)</pre> |
| <div class="block">Checks if the corresponding Subject/user has the specified roles, returning a boolean array indicating |
| which roles are associated with the given subject. |
| |
| <p>This is primarily a performance-enhancing method to help reduce the number of |
| <a href="../../../../org/apache/shiro/authz/Authorizer.html#hasRole(org.apache.shiro.subject.PrincipalCollection, java.lang.String)"><code>hasRole(org.apache.shiro.subject.PrincipalCollection, java.lang.String)</code></a> invocations over the wire in client/server systems.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectPrincipal</code> - the application-specific subject/user identifier.</dd><dd><code>roleIdentifiers</code> - the application-specific role identifiers to check (usually role ids or role names).</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an array of booleans whose indices correspond to the index of the |
| roles in the given identifiers. A true value indicates the user has the |
| role at that index. False indicates the user does not have the role at that index.</dd></dl> |
| </li> |
| </ul> |
| <a name="hasAllRoles(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasAllRoles</h4> |
| <pre>boolean <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.237">hasAllRoles</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>> roleIdentifiers)</pre> |
| <div class="block">Returns <tt>true</tt> if the corresponding Subject/user has all of the specified roles, <tt>false</tt> otherwise.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectPrincipal</code> - the application-specific subject/user identifier.</dd><dd><code>roleIdentifiers</code> - the application-specific role identifiers to check (usually role ids or role names).</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the user has all the roles, false otherwise.</dd></dl> |
| </li> |
| </ul> |
| <a name="checkRole(org.apache.shiro.subject.PrincipalCollection, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkRole</h4> |
| <pre>void <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.248">checkRole</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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> roleIdentifier) |
| throws <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></pre> |
| <div class="block">Asserts the corresponding Subject/user has the specified role by returning quietly if they do or throwing an |
| <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz"><code>AuthorizationException</code></a> if they do not.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectPrincipal</code> - the application-specific subject/user identifier.</dd><dd><code>roleIdentifier</code> - the application-specific role identifier (usually a role id or role name ).</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></code> - if the user does not have the role.</dd></dl> |
| </li> |
| </ul> |
| <a name="checkRoles(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkRoles</h4> |
| <pre>void <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.259">checkRoles</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>> roleIdentifiers) |
| throws <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></pre> |
| <div class="block">Asserts the corresponding Subject/user has all of the specified roles by returning quietly if they do or |
| throwing an <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz"><code>AuthorizationException</code></a> if they do not.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectPrincipal</code> - the application-specific subject/user identifier.</dd><dd><code>roleIdentifiers</code> - the application-specific role identifiers to check (usually role ids or role names).</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></code> - if the user does not have all of the specified roles.</dd></dl> |
| </li> |
| </ul> |
| <a name="checkRoles(org.apache.shiro.subject.PrincipalCollection, java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>checkRoles</h4> |
| <pre>void <a href="../../../../src-html/org/apache/shiro/authz/Authorizer.html#line.275">checkRoles</a>(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> subjectPrincipal, |
| <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>... roleIdentifiers) |
| throws <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></pre> |
| <div class="block">Same as <a href="../../../../org/apache/shiro/authz/Authorizer.html#checkRoles(org.apache.shiro.subject.PrincipalCollection, java.util.Collection)"><code>checkRoles(PrincipalCollection subjectPrincipal, Collection<String> roleIdentifiers)</code></a> but doesn't require a collection |
| as an argument. |
| Asserts the corresponding Subject/user has all of the specified roles by returning quietly if they do or |
| throwing an <a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz"><code>AuthorizationException</code></a> if they do not.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectPrincipal</code> - the application-specific subject/user identifier.</dd><dd><code>roleIdentifiers</code> - the application-specific role identifiers to check (usually role ids or role names).</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></code> - if the user does not have all of the specified roles.</dd><dt><span class="strong">Since:</span></dt> |
| <dd>1.1.0</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/Authorizer.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/AuthorizationInfo.html" title="interface in org.apache.shiro.authz"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/authz/HostUnauthorizedException.html" title="class 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/Authorizer.html" target="_top">Frames</a></li> |
| <li><a href="Authorizer.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-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
| |
