| <!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>package org.apache.shiro.authc;<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><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>/**<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * <p>An <tt>AuthenticationToken</tt> is a consolidation of an account's principals and supporting<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * credentials submitted by a user during an authentication attempt.<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * <p/><a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * <p>The token is submitted to an {@link Authenticator Authenticator} via the<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * {@link Authenticator#authenticate(AuthenticationToken) authenticate(token)} method. The<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * Authenticator then executes the authentication/log-in process.<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * <p/><a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * <p>Common implementations of an <tt>AuthenticationToken</tt> would have username/password<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * pairs, X.509 Certificate, PGP key, or anything else you can think of. The token can be<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * anything needed by an {@link Authenticator} to authenticate properly.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <p/><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <p>Because applications represent user data and credentials in different ways, implementations<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * of this interface are application-specific. You are free to acquire a user's principals and<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * credentials however you wish (e.g. web form, Swing form, fingerprint identification, etc) and<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * then submit them to the Shiro framework in the form of an implementation of this<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * interface.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <p/><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <p>If your application's authentication process is username/password based<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * (like most), instead of implementing this interface yourself, take a look at the<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * {@link UsernamePasswordToken UsernamePasswordToken} class, as it is probably sufficient for your needs.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <p/><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <p>RememberMe services are enabled for a token if they implement a sub-interface of this one, called<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * {@link RememberMeAuthenticationToken RememberMeAuthenticationToken}. Implement that interfac if you need<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * RememberMe services (the <tt>UsernamePasswordToken</tt> already implements this interface).<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <p/><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <p>If you are familiar with JAAS, an <tt>AuthenticationToken</tt> replaces the concept of a<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * {@link javax.security.auth.callback.Callback}, and defines meaningful behavior<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * (<tt>Callback</tt> is just a marker interface, and of little use). We<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * also think the name <em>AuthenticationToken</em> more accurately reflects its true purpose<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * in a login framework, whereas <em>Callback</em> is less obvious.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> *<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * @see RememberMeAuthenticationToken<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @see HostAuthenticationToken<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @see UsernamePasswordToken<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @since 0.1<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span>public interface AuthenticationToken extends Serializable {<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /**<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * Returns the account identity submitted during the authentication process.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * <p/><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * <p>Most application authentications are username/password based and have this<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * object represent a username. If this is the case for your application,<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * take a look at the {@link UsernamePasswordToken UsernamePasswordToken}, as it is probably<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * sufficient for your use.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <p/><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * <p>Ultimately, the object returned is application specific and can represent<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * any account identity (user id, X.509 certificate, etc).<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> *<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @return the account identity submitted during the authentication process.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * @see UsernamePasswordToken<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> */<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> Object getPrincipal();<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> /**<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * Returns the credentials submitted by the user during the authentication process that verifies<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * the submitted {@link #getPrincipal() account identity}.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * <p/><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * <p>Most application authentications are username/password based and have this object<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * represent a submitted password. If this is the case for your application,<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * take a look at the {@link UsernamePasswordToken UsernamePasswordToken}, as it is probably<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * sufficient for your use.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * <p/><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * <p>Ultimately, the credentials Object returned is application specific and can represent<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * any credential mechanism.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> *<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @return the credential submitted by the user during the authentication process.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> */<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> Object getCredentials();<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span>}<a name="line.94"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
