| <!DOCTYPE HTML> |
| <html lang="fr"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">/*</a> |
| <span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> *</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> */</a> |
| <span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.subject;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import java.io.Serializable;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import java.util.Collection;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import java.util.List;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import java.util.Set;</a> |
| <span class="sourceLineNo">025</span><a id="line.25"></a> |
| <span class="sourceLineNo">026</span><a id="line.26">/**</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * A collection of all principals associated with a corresponding {@link Subject Subject}. A <em>principal</em> is</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * just a security term for an identifying attribute, such as a username or user id or social security number or</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * anything else that can be considered an 'identifying' attribute for a {@code Subject}.</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * <p/></a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * A PrincipalCollection organizes its internal principals based on the {@code Realm} where they came from when the</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * Subject was first created. To obtain the principal(s) for a specific Realm, see the {@link #fromRealm} method. You</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * can also see which realms contributed to this collection via the {@link #getRealmNames() getRealmNames()} method.</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> *</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * @see #getPrimaryPrincipal()</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * @see #fromRealm(String realmName)</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * @see #getRealmNames()</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * @since 0.9</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> */</a> |
| <span class="sourceLineNo">040</span><a id="line.40">public interface PrincipalCollection extends Iterable, Serializable {</a> |
| <span class="sourceLineNo">041</span><a id="line.41"></a> |
| <span class="sourceLineNo">042</span><a id="line.42"> /**</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * Returns the primary principal used application-wide to uniquely identify the owning account/Subject.</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * <p/></a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * The value is usually always a uniquely identifying attribute specific to the data source that retrieved the</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * account data. Some examples:</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * <ul></a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * <li>a {@link java.util.UUID UUID}</li></a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * <li>a {@code long} value such as a surrogate primary key in a relational database</li></a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * <li>an LDAP UUID or static DN</li></a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * <li>a String username unique across all user accounts</li></a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * </ul></a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * <h3>Multi-Realm Applications</h3></a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * In a single-{@code Realm} application, typically there is only ever one unique principal to retain and that</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * is the value returned from this method. However, in a multi-{@code Realm} application, where the</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * {@code PrincipalCollection} might retain principals across more than one realm, the value returned from this</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * method should be the single principal that uniquely identifies the subject for the entire application.</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * <p/></a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * That value is of course application specific, but most applications will typically choose one of the primary</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * principals from one of the {@code Realm}s.</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * <p/></a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * Shiro's default implementations of this interface make this</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * assumption by usually simply returning {@link #iterator()}.{@link java.util.Iterator#next() next()}, which just</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * returns the first returned principal obtained from the first consulted/configured {@code Realm} during the</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * authentication attempt. This means in a multi-{@code Realm} application, {@code Realm} configuration order</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * matters if you want to retain this default heuristic.</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * <p/></a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * If this heuristic is not sufficient, most Shiro end-users will need to implement a custom</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * {@link org.apache.shiro.authc.pam.AuthenticationStrategy}. An {@code AuthenticationStrategy} has exact control</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * over the {@link PrincipalCollection} returned at the end of an authentication attempt via the</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * <code>AuthenticationStrategy#{@link org.apache.shiro.authc.pam.AuthenticationStrategy#afterAllAttempts(org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo) afterAllAttempts}</code></a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * implementation.</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> *</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> * @return the primary principal used to uniquely identify the owning account/Subject</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * @since 1.0</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> */</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> Object getPrimaryPrincipal();</a> |
| <span class="sourceLineNo">078</span><a id="line.78"></a> |
| <span class="sourceLineNo">079</span><a id="line.79"> /**</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * Returns the first discovered principal assignable from the specified type, or {@code null} if there are none</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * of the specified type.</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> * <p/></a> |
| <span class="sourceLineNo">083</span><a id="line.83"> * Note that this will return {@code null} if the 'owning' subject has not yet logged in.</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> *</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> * @param type the type of the principal that should be returned.</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * @return a principal of the specified type or {@code null} if there isn't one of the specified type.</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> */</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> <T> T oneByType(Class<T> type);</a> |
| <span class="sourceLineNo">089</span><a id="line.89"></a> |
| <span class="sourceLineNo">090</span><a id="line.90"> /**</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> * Returns all principals assignable from the specified type, or an empty Collection if no principals of that</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> * type are contained.</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> * <p/></a> |
| <span class="sourceLineNo">094</span><a id="line.94"> * Note that this will return an empty Collection if the 'owning' subject has not yet logged in.</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> *</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> * @param type the type of the principals that should be returned.</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> * @return a Collection of principals that are assignable from the specified type, or</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> * an empty Collection if no principals of this type are associated.</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> */</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> <T> Collection<T> byType(Class<T> type);</a> |
| <span class="sourceLineNo">101</span><a id="line.101"></a> |
| <span class="sourceLineNo">102</span><a id="line.102"> /**</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> * Returns a single Subject's principals retrieved from all configured Realms as a List, or an empty List if</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> * there are not any principals.</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> * <p/></a> |
| <span class="sourceLineNo">106</span><a id="line.106"> * Note that this will return an empty List if the 'owning' subject has not yet logged in.</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> *</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> * @return a single Subject's principals retrieved from all configured Realms as a List.</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> */</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> List asList();</a> |
| <span class="sourceLineNo">111</span><a id="line.111"></a> |
| <span class="sourceLineNo">112</span><a id="line.112"> /**</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> * Returns a single Subject's principals retrieved from all configured Realms as a Set, or an empty Set if there</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> * are not any principals.</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> * <p/></a> |
| <span class="sourceLineNo">116</span><a id="line.116"> * Note that this will return an empty Set if the 'owning' subject has not yet logged in.</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> *</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * @return a single Subject's principals retrieved from all configured Realms as a Set.</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> */</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> Set asSet();</a> |
| <span class="sourceLineNo">121</span><a id="line.121"></a> |
| <span class="sourceLineNo">122</span><a id="line.122"> /**</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> * Returns a single Subject's principals retrieved from the specified Realm <em>only</em> as a Collection, or an empty</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> * Collection if there are not any principals from that realm.</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> * <p/></a> |
| <span class="sourceLineNo">126</span><a id="line.126"> * Note that this will return an empty Collection if the 'owning' subject has not yet logged in.</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> *</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> * @param realmName the name of the Realm from which the principals were retrieved.</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> * @return the Subject's principals from the specified Realm only as a Collection or an empty Collection if there</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> * are not any principals from that realm.</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> */</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> Collection fromRealm(String realmName);</a> |
| <span class="sourceLineNo">133</span><a id="line.133"></a> |
| <span class="sourceLineNo">134</span><a id="line.134"> /**</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> * Returns the realm names that this collection has principals for.</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> *</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> * @return the names of realms that this collection has one or more principals for.</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> */</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> Set<String> getRealmNames();</a> |
| <span class="sourceLineNo">140</span><a id="line.140"></a> |
| <span class="sourceLineNo">141</span><a id="line.141"> /**</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> * Returns {@code true} if this collection is empty, {@code false} otherwise.</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> *</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> * @return {@code true} if this collection is empty, {@code false} otherwise.</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> */</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> boolean isEmpty();</a> |
| <span class="sourceLineNo">147</span><a id="line.147">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
