| <!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>PrincipalCollection xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/shiro/subject/PrincipalCollection.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.subject; |
| <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> <strong class="jxr_keyword">import</strong> java.util.List; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Set; |
| <a name="25" href="#25">25</a> |
| <a name="26" href="#26">26</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * A collection of all principals associated with a corresponding {@link Subject Subject}. A <em>principal</em> is</em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * just a security term for an identifying attribute, such as a username or user id or social security number or</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * anything else that can be considered an 'identifying' attribute for a {@code Subject}.</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"> * A PrincipalCollection organizes its internal principals based on the {@code Realm} where they came from when the</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Subject was first created. To obtain the principal(s) for a specific Realm, see the {@link #fromRealm} method. You</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * can also see which realms contributed to this collection via the {@link #getRealmNames() getRealmNames()} method.</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @see #getPrimaryPrincipal()</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * @see #fromRealm(String realmName)</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @see #getRealmNames()</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="40" href="#40">40</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> <strong class="jxr_keyword">extends</strong> Iterable, Serializable { |
| <a name="41" href="#41">41</a> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * Returns the primary principal used application-wide to uniquely identify the owning account/Subject.</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * The value is usually always a uniquely identifying attribute specific to the data source that retrieved the</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * account data. Some examples:</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * <li>a {@link java.util.UUID UUID}</li></em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * <li>a {@code long} value such as a surrogate primary key in a relational database</li></em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * <li>an LDAP UUID or static DN</li></em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * <li>a String username unique across all user accounts</li></em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * <h3>Multi-Realm Applications</h3></em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * In a single-{@code Realm} application, typically there is only ever one unique principal to retain and that</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * is the value returned from this method. However, in a multi-{@code Realm} application, where the</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * {@code PrincipalCollection} might retain principals across more than one realm, the value returned from this</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * method should be the single principal that uniquely identifies the subject for the entire application.</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * That value is of course application specific, but most applications will typically choose one of the primary</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * principals from one of the {@code Realm}s.</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * Shiro's default implementations of this interface make this</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * assumption by usually simply returning {@link #iterator()}.{@link java.util.Iterator#next() next()}, which just</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * returns the first returned principal obtained from the first consulted/configured {@code Realm} during the</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * authentication attempt. This means in a multi-{@code Realm} application, {@code Realm} configuraiton order</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * matters if you want to retain this default heuristic.</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * If this heuristic is not sufficient, most Shiro end-users will need to implement a custom</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.pam.AuthenticationStrategy}. An {@code AuthenticationStrategy} has exact control</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * over the {@link PrincipalCollection} returned at the end of an authentication attempt via the</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * <code>AuthenticationStrategy#{@link org.apache.shiro.authc.pam.AuthenticationStrategy#afterAllAttempts(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo) afterAllAttempts}</code></em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * implementation.</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @return the primary principal used to uniquely identify the owning account/Subject</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="77" href="#77">77</a> Object getPrimaryPrincipal(); |
| <a name="78" href="#78">78</a> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Returns the first discovered principal assignable from the specified type, or {@code null} if there are none</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * of the specified type.</em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * Note that this will return {@code null} if the 'owning' subject has not yet logged in.</em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @param type the type of the principal that should be returned.</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * @return a principal of the specified type or {@code null} if there isn't one of the specified type.</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="88" href="#88">88</a> <T> T oneByType(Class<T> type); |
| <a name="89" href="#89">89</a> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * Returns all principals assignable from the specified type, or an empty Collection if no principals of that</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * type are contained.</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * Note that this will return an empty Collection if the 'owning' subject has not yet logged in.</em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * @param type the type of the principals that should be returned.</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @return a Collection of principals that are assignable from the specified type, or</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * an empty Collection if no principals of this type are associated.</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="100" href="#100">100</a> <T> Collection<T> byType(Class<T> type); |
| <a name="101" href="#101">101</a> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * Returns a single Subject's principals retrieved from all configured Realms as a List, or an empty List if</em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * there are not any principals.</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * Note that this will return an empty List if the 'owning' subject has not yet logged in.</em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * @return a single Subject's principals retrieved from all configured Realms as a List.</em> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="110" href="#110">110</a> List asList(); |
| <a name="111" href="#111">111</a> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * Returns a single Subject's principals retrieved from all configured Realms as a Set, or an empty Set if there</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * are not any principals.</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * Note that this will return an empty Set if the 'owning' subject has not yet logged in.</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * @return a single Subject's principals retrieved from all configured Realms as a Set.</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="120" href="#120">120</a> Set asSet(); |
| <a name="121" href="#121">121</a> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * Returns a single Subject's principals retrieved from the specified Realm <em>only</em> as a Collection, or an empty</em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * Collection if there are not any principals from that realm.</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * Note that this will return an empty Collection if the 'owning' subject has not yet logged in.</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * @param realmName the name of the Realm from which the principals were retrieved.</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * @return the Subject's principals from the specified Realm only as a Collection or an empty Collection if there</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * are not any principals from that realm.</em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="132" href="#132">132</a> Collection fromRealm(String realmName); |
| <a name="133" href="#133">133</a> |
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * Returns the realm names that this collection has principals for.</em> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * @return the names of realms that this collection has one or more principals for.</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="139" href="#139">139</a> Set<String> getRealmNames(); |
| <a name="140" href="#140">140</a> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * Returns {@code true} if this collection is empty, {@code false} otherwise.</em> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * @return {@code true} if this collection is empty, {@code false} otherwise.</em> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="146" href="#146">146</a> <strong class="jxr_keyword">boolean</strong> isEmpty(); |
| <a name="147" href="#147">147</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
