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