| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <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><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>package org.apache.shiro.authc;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.subject.PrincipalCollection;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.io.Serializable;<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> * <code>AuthenticationInfo</code> represents a Subject's (aka user's) stored account information relevant to the<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * authentication/log-in process only.<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * <p/><a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * It is important to understand the difference between this interface and the<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * {@link AuthenticationToken AuthenticationToken} interface. <code>AuthenticationInfo</code> implementations<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * represent already-verified and stored account data, whereas an <code>AuthenticationToken</code> represents data<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * submitted for any given login attempt (which may or may not successfully match the verified and stored account<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <code>AuthenticationInfo</code>).<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <p/><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * Because the act of authentication (log-in) is orthogonal to authorization (access control), this interface is<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * intended to represent only the account data needed by Shiro during an authentication attempt. Shiro also<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * has a parallel {@link org.apache.shiro.authz.AuthorizationInfo AuthorizationInfo} interface for use during the<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * authorization process that references access control data such as roles and permissions.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <p/><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * 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<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * convenient for a <code>Realm</code> implementation to utilize an implementation of the {@link Account Account}<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * interface instead, which is a convenience interface that combines both <code>AuthenticationInfo</code> and<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <code>AuthorizationInfo</code>. Whether you choose to implement these two interfaces separately or implement the one<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <code>Account</code> interface for a given <code>Realm</code> is entirely based on your application's needs or your<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * preferences.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <p/><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <p><b>Pleae note:</b> Since Shiro sometimes logs authentication operations, please ensure your AuthenticationInfo's<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <code>toString()</code> implementation does <em>not</em> print out account credentials (password, etc), as these might be viewable to<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * someone reading your logs. This is good practice anyway, and account credentials should rarely (if ever) be printed<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * out for any reason. If you're using Shiro's default implementations of this interface, they only ever print the<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * account {@link #getPrincipals() principals}, so you do not need to do anything additional.</p><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> *<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * @see org.apache.shiro.authz.AuthorizationInfo AuthorizationInfo<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * @see Account<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @since 0.9<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> */<a name="line.57"></a> |
| <span class="sourceLineNo">058</span>public interface AuthenticationInfo extends Serializable {<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> /**<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * Returns all principals associated with the corresponding Subject. Each principal is an identifying piece of<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * information useful to the application such as a username, or user id, a given name, etc - anything useful<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * to the application to identify the current <code>Subject</code>.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * <p/><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * The returned PrincipalCollection should <em>not</em> contain any credentials used to verify principals, such<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * as passwords, private keys, etc. Those should be instead returned by {@link #getCredentials() getCredentials()}.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> *<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @return all principals associated with the corresponding Subject.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> */<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> PrincipalCollection getPrincipals();<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> /**<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * Returns the credentials associated with the corresponding Subject. A credential verifies one or more of the<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * {@link #getPrincipals() principals} associated with the Subject, such as a password or private key. Credentials<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * are used by Shiro particularly during the authentication process to ensure that submitted credentials<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * during a login attempt match exactly the credentials here in the <code>AuthenticationInfo</code> instance.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> *<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @return the credentials associated with the corresponding Subject.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> Object getCredentials();<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span>}<a name="line.82"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
