| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> |
| <title>AuthorizationInfo xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/shiro/authz/AuthorizationInfo.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.authz; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.io.Serializable; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.Collection; |
| <a name="23" href="#23">23</a> |
| <a name="24" href="#24">24</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * <code>AuthorizationInfo</code> represents a single Subject's stored authorization data (roles, permissions, etc)</em> |
| <a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * used during authorization (access control) checks only.</em> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * Roles are represented as a <code>Collection</code> of Strings</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * ({@link java.util.Collection Collection}<{@link String String}>), typically each element being the Role name.</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * {@link Permission Permission}s are provided in two ways:</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <li>A <code>Collection</code> of Strings, where each String can usually be converted into <code>Permission</code></em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * objects by a <code>Realm</code>'s</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authz.permission.PermissionResolver PermissionResolver}</li></em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * <li>A <code>Collection</code> of {@link Permission Permission} objects</li></em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * Both permission collections together represent the total aggregate collection of permissions. You may use one</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * or both depending on your preference and needs.</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * Because the act of authorization (access control) is orthoganal to authentication (log-in), this interface is</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * intended to represent only the account data needed by Shiro during an access control check</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * (role, permission, etc). Shiro also has a parallel</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.AuthenticationInfo AuthenticationInfo} interface for use during the authentication</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * process that represents identity data such as principals and credentials.</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * Because many if not most {@link org.apache.shiro.realm.Realm Realm}s store both sets of data for a Subject, it might be</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * convenient for a <code>Realm</code> implementation to utilize an implementation of the</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.Account Account} interface instead, which is a convenience interface that combines both</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * <code>AuthenticationInfo</code> and <code>AuthorizationInfo</code>. Whether you choose to implement these two</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * interfaces separately or implement the one <code>Account</code> interface for a given <code>Realm</code> is</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * entirely based on your application's needs or your preferences.</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.authc.AuthenticationInfo AuthenticationInfo</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.authc.Account</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="58" href="#58">58</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/shiro/authz/AuthorizationInfo.html">AuthorizationInfo</a> <strong class="jxr_keyword">extends</strong> Serializable { |
| <a name="59" href="#59">59</a> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Returns the names of all roles assigned to a corresponding Subject.</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @return the names of all roles assigned to a corresponding Subject.</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="65" href="#65">65</a> Collection<String> getRoles(); |
| <a name="66" href="#66">66</a> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * Returns all string-based permissions assigned to the corresponding Subject. The permissions here plus those</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * returned from {@link #getObjectPermissions() getObjectPermissions()} represent the total set of permissions</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * assigned. The aggregate set is used to perform a permission authorization check.</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * This method is a convenience mechanism that allows Realms to represent permissions as Strings if they choose.</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * When performing a security check, a <code>Realm</code> usually converts these strings to object</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * {@link Permission Permission}s via an internal</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authz.permission.PermissionResolver PermissionResolver}</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * in order to perform the actual permission check. This is not a requirement of course, since <code>Realm</code>s</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * can perform security checks in whatever manner deemed necessary, but this explains the conversion mechanism that</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * most Shiro Realms execute for string-based permission checks.</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @return all string-based permissions assigned to the corresponding Subject.</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="82" href="#82">82</a> Collection<String> getStringPermissions(); |
| <a name="83" href="#83">83</a> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * Returns all type-safe {@link Permission Permission}s assigned to the corresponding Subject. The permissions</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * returned from this method plus any returned from {@link #getStringPermissions() getStringPermissions()}</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * represent the total set of permissions. The aggregate set is used to perform a permission authorization check.</em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @return all type-safe {@link Permission Permission}s assigned to the corresponding Subject.</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="91" href="#91">91</a> Collection<Permission> getObjectPermissions(); |
| <a name="92" href="#92">92</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
| |
