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