| <!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.util.Map;</a> |
| <span class="sourceLineNo">022</span><a id="line.22"></a> |
| <span class="sourceLineNo">023</span><a id="line.23">/**</a> |
| <span class="sourceLineNo">024</span><a id="line.24"> * EXPERIMENTAL - DO NOT USE YET</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * <p/></a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * A {@code PrincipalMap} is map of all of a subject's principals - its identifying attributes like username, userId,</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * etc.</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * <p/></a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * The {@link Map} methods allow you to interact with a unified representation of</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * all of the Subject's principals, even if they came from different realms. You can think of the {@code Map} methods</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * as the general purpose API for a Subject's principals. That is, you can access a principal generally:</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * <pre></a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * Object principal = subject.getPrincipals().get(principalName);</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * </pre></a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * For example, to get the Subject's username (if the</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * username principal indeed exists and was populated by a Realm), you can do the following:</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * <pre></a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * String username = (String)subject.getPrincipals().get("username");</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * </pre></a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * <h3>Multi-Realm Environments</h3></a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * If your application uses multiple realms, the {@code Map} methods reflect</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * the the aggregate principals from <em>all</em> realms that authenticated the owning {@code Subject}.</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * <p/></a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * But in these multi-realm environments, it is often convenient or necessary to acquire only the principals contributed</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * by a specific realm (often in a realm implementation itself). This {@code PrincipalMap} interface satisfies</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * those needs by providing additional realm-specific accessor/mutator methods.</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> *</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * @author Les Hazlewood</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * @since 1.2</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> */</a> |
| <span class="sourceLineNo">051</span><a id="line.51">public interface PrincipalMap extends PrincipalCollection, Map<String,Object> {</a> |
| <span class="sourceLineNo">052</span><a id="line.52"></a> |
| <span class="sourceLineNo">053</span><a id="line.53"> Map<String,Object> getRealmPrincipals(String realmName);</a> |
| <span class="sourceLineNo">054</span><a id="line.54"></a> |
| <span class="sourceLineNo">055</span><a id="line.55"> Map<String,Object> setRealmPrincipals(String realmName, Map<String,Object> principals);</a> |
| <span class="sourceLineNo">056</span><a id="line.56"></a> |
| <span class="sourceLineNo">057</span><a id="line.57"> Object setRealmPrincipal(String realmName, String principalName, Object principal);</a> |
| <span class="sourceLineNo">058</span><a id="line.58"></a> |
| <span class="sourceLineNo">059</span><a id="line.59"> Object getRealmPrincipal(String realmName, String realmPrincipal);</a> |
| <span class="sourceLineNo">060</span><a id="line.60"></a> |
| <span class="sourceLineNo">061</span><a id="line.61"> Object removeRealmPrincipal(String realmName, String principalName);</a> |
| <span class="sourceLineNo">062</span><a id="line.62"></a> |
| <span class="sourceLineNo">063</span><a id="line.63">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
