| <!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>AuthenticationInfo xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/shiro/authc/AuthenticationInfo.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> |
| <a name="20" href="#20">20</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.authc; |
| <a name="21" href="#21">21</a> |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection; |
| <a name="23" href="#23">23</a> |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.Serializable; |
| <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"> * <code>AuthenticationInfo</code> represents a Subject's (aka user's) stored account information relevant to the</em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * authentication/log-in process only.</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * It is important to understand the difference between this interface and the</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * {@link AuthenticationToken AuthenticationToken} interface. <code>AuthenticationInfo</code> implementations</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * represent already-verified and stored account data, whereas an <code>AuthenticationToken</code> represents data</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * submitted for any given login attempt (which may or may not successfully match the verified and stored account</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <code>AuthenticationInfo</code>).</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * Because the act of authentication (log-in) is orthogonal to authorization (access control), this interface is</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * intended to represent only the account data needed by Shiro during an authentication attempt. Shiro also</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * has a parallel {@link org.apache.shiro.authz.AuthorizationInfo AuthorizationInfo} interface for use during the</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * authorization process that references access control data such as roles and permissions.</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * But because many if not most {@link org.apache.shiro.realm.Realm Realm}s store both sets of data for a Subject, it might be</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * convenient for a <code>Realm</code> implementation to utilize an implementation of the {@link Account Account}</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * interface instead, which is a convenience interface that combines both <code>AuthenticationInfo</code> and</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <code>AuthorizationInfo</code>. Whether you choose to implement these two interfaces separately or implement the one</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * <code>Account</code> interface for a given <code>Realm</code> is entirely based on your application's needs or your</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * preferences.</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * <p><b>Pleae note:</b> Since Shiro sometimes logs authentication operations, please ensure your AuthenticationInfo's</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * <code>toString()</code> implementation does <em>not</em> print out account credentials (password, etc), as these might be viewable to</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * someone reading your logs. This is good practice anyway, and account credentials should rarely (if ever) be printed</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * out for any reason. If you're using Shiro's default implementations of this interface, they only ever print the</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * account {@link #getPrincipals() principals}, so you do not need to do anything additional.</p></em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.authz.AuthorizationInfo AuthorizationInfo</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * @see Account</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="58" href="#58">58</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> <strong class="jxr_keyword">extends</strong> Serializable { |
| <a name="59" href="#59">59</a> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Returns all principals associated with the corresponding Subject. Each principal is an identifying piece of</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * information useful to the application such as a username, or user id, a given name, etc - anything useful</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * to the application to identify the current <code>Subject</code>.</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * The returned PrincipalCollection should <em>not</em> contain any credentials used to verify principals, such</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * as passwords, private keys, etc. Those should be instead returned by {@link #getCredentials() getCredentials()}.</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * @return all principals associated with the corresponding Subject.</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="70" href="#70">70</a> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> getPrincipals(); |
| <a name="71" href="#71">71</a> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * Returns the credentials associated with the corresponding Subject. A credential verifies one or more of the</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * {@link #getPrincipals() principals} associated with the Subject, such as a password or private key. Credentials</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * are used by Shiro particularly during the authentication process to ensure that submitted credentials</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * during a login attempt match exactly the credentials here in the <code>AuthenticationInfo</code> instance.</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * @return the credentials associated with the corresponding Subject.</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="80" href="#80">80</a> Object getCredentials(); |
| <a name="81" href="#81">81</a> |
| <a name="82" href="#82">82</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
