Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.3 / apidocs / src-html / org / apache / shiro / subject / PrincipalMap.html
blob: e6c4fdf9349871d39f9a5ee9109265e66e662442 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a>
<FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a>
<FONT color="green">017</FONT> * under the License.<a name="line.17"></a>
<FONT color="green">018</FONT> */<a name="line.18"></a>
<FONT color="green">019</FONT> package org.apache.shiro.subject;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import java.util.Map;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> /**<a name="line.23"></a>
<FONT color="green">024</FONT> * EXPERIMENTAL - DO NOT USE YET<a name="line.24"></a>
<FONT color="green">025</FONT> * &lt;p/&gt;<a name="line.25"></a>
<FONT color="green">026</FONT> * A {@code PrincipalMap} is map of all of a subject's principals - its identifying attributes like username, userId,<a name="line.26"></a>
<FONT color="green">027</FONT> * etc.<a name="line.27"></a>
<FONT color="green">028</FONT> * &lt;p/&gt;<a name="line.28"></a>
<FONT color="green">029</FONT> * The {@link Map} methods allow you to interact with a unified representation of<a name="line.29"></a>
<FONT color="green">030</FONT> * all of the Subject's principals, even if they came from different realms. You can think of the {@code Map} methods<a name="line.30"></a>
<FONT color="green">031</FONT> * as the general purpose API for a Subject's principals. That is, you can access a principal generally:<a name="line.31"></a>
<FONT color="green">032</FONT> * &lt;pre&gt;<a name="line.32"></a>
<FONT color="green">033</FONT> * Object principal = subject.getPrincipals().get(principalName);<a name="line.33"></a>
<FONT color="green">034</FONT> * &lt;/pre&gt;<a name="line.34"></a>
<FONT color="green">035</FONT> * For example, to get the Subject's username (if the<a name="line.35"></a>
<FONT color="green">036</FONT> * username principal indeed exists and was populated by a Realm), you can do the following:<a name="line.36"></a>
<FONT color="green">037</FONT> * &lt;pre&gt;<a name="line.37"></a>
<FONT color="green">038</FONT> * String username = (String)subject.getPrincipals().get("username");<a name="line.38"></a>
<FONT color="green">039</FONT> * &lt;/pre&gt;<a name="line.39"></a>
<FONT color="green">040</FONT> * &lt;h3&gt;Multi-Realm Environments&lt;/h3&gt;<a name="line.40"></a>
<FONT color="green">041</FONT> * If your application uses multiple realms, the {@code Map} methods reflect<a name="line.41"></a>
<FONT color="green">042</FONT> * the the aggregate principals from &lt;em&gt;all&lt;/em&gt; realms that authenticated the owning {@code Subject}.<a name="line.42"></a>
<FONT color="green">043</FONT> * &lt;p/&gt;<a name="line.43"></a>
<FONT color="green">044</FONT> * But in these multi-realm environments, it is often convenient or necessary to acquire only the principals contributed<a name="line.44"></a>
<FONT color="green">045</FONT> * by a specific realm (often in a realm implementation itself). This {@code PrincipalMap} interface satisfies<a name="line.45"></a>
<FONT color="green">046</FONT> * those needs by providing additional realm-specific accessor/mutator methods.<a name="line.46"></a>
<FONT color="green">047</FONT> *<a name="line.47"></a>
<FONT color="green">048</FONT> * @author Les Hazlewood<a name="line.48"></a>
<FONT color="green">049</FONT> * @since 1.2<a name="line.49"></a>
<FONT color="green">050</FONT> */<a name="line.50"></a>
<FONT color="green">051</FONT> public interface PrincipalMap extends PrincipalCollection, Map&lt;String,Object&gt; {<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> Map&lt;String,Object&gt; getRealmPrincipals(String realmName);<a name="line.53"></a>
<FONT color="green">054</FONT> <a name="line.54"></a>
<FONT color="green">055</FONT> Map&lt;String,Object&gt; setRealmPrincipals(String realmName, Map&lt;String,Object&gt; principals);<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> Object setRealmPrincipal(String realmName, String principalName, Object principal);<a name="line.57"></a>
<FONT color="green">058</FONT> <a name="line.58"></a>
<FONT color="green">059</FONT> Object getRealmPrincipal(String realmName, String realmPrincipal);<a name="line.59"></a>
<FONT color="green">060</FONT> <a name="line.60"></a>
<FONT color="green">061</FONT> Object removeRealmPrincipal(String realmName, String principalName);<a name="line.61"></a>
<FONT color="green">062</FONT> <a name="line.62"></a>
<FONT color="green">063</FONT> }<a name="line.63"></a>
</PRE>
</BODY>
</HTML>