| <!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.mgt;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.shiro.authc.AuthenticationException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.authc.AuthenticationInfo;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.authc.AuthenticationToken;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.subject.PrincipalCollection;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.subject.Subject;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.shiro.subject.SubjectContext;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span><a name="line.27"></a> |
| <span class="sourceLineNo">028</span>/**<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * A RememberMeManager is responsible for remembering a Subject's identity across that Subject's sessions with<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * the application.<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> *<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * @since 0.9<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> */<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>public interface RememberMeManager {<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> /**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Based on the specified subject context map being used to build a Subject instance, returns any previously<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * remembered principals for the subject for automatic identity association (aka 'Remember Me').<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <p/><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * The context map is usually populated by a {@link Subject.Builder} implementation.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * See the {@link SubjectFactory} class constants for Shiro's known map keys.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> *<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @param subjectContext the contextual data, usually provided by a {@link Subject.Builder} implementation, that<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * is being used to construct a {@link Subject} instance.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * @return he remembered principals or {@code null} if none could be acquired.<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * @since 1.0<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> */<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> PrincipalCollection getRememberedPrincipals(SubjectContext subjectContext);<a name="line.48"></a> |
| <span class="sourceLineNo">049</span><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> /**<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * Forgets any remembered identity corresponding to the subject context map being used to build a subject instance.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <p/><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * The context map is usually populated by a {@link Subject.Builder} implementation.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * See the {@link SubjectFactory} class constants for Shiro's known map keys.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> *<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @param subjectContext the contextual data, usually provided by a {@link Subject.Builder} implementation, that<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * is being used to construct a {@link Subject} instance.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @since 1.0<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> void forgetIdentity(SubjectContext subjectContext);<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> * Reacts to a successful authentication attempt, typically saving the principals to be retrieved ('remembered')<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * for future system access.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> *<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param subject the subject that executed a successful authentication attempt<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @param token the authentication token submitted resulting in a successful authentication attempt<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @param info the authenticationInfo returned as a result of the successful authentication attempt<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @since 1.0<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> void onSuccessfulLogin(Subject subject, AuthenticationToken token, AuthenticationInfo info);<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> /**<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * Reacts to a failed authentication attempt, typically by forgetting any previously remembered principals for the<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * Subject.<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> *<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @param subject the subject that executed the failed authentication attempt<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param token the authentication token submitted resulting in the failed authentication attempt<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @param ae the authentication exception thrown as a result of the failed authentication attempt<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @since 1.0<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> */<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> void onFailedLogin(Subject subject, AuthenticationToken token, AuthenticationException ae);<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> /**<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * Reacts to a Subject logging out of the application, typically by forgetting any previously remembered<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * principals for the Subject.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> *<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * @param subject the subject logging out.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @since 1.0<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> */<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> void onLogout(Subject subject);<a name="line.91"></a> |
| <span class="sourceLineNo">092</span>}<a name="line.92"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
