blob: 4880bf41ae9a64a0adbc8ae5ff5848dca943f29b [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a>
<FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a>
<FONT color="green">017</FONT> * under the License.<a name="line.17"></a>
<FONT color="green">018</FONT> */<a name="line.18"></a>
<FONT color="green">019</FONT> package org.apache.shiro.session;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> /**<a name="line.21"></a>
<FONT color="green">022</FONT> * Interface to be implemented by components that wish to be notified of events that occur during a<a name="line.22"></a>
<FONT color="green">023</FONT> * {@link Session Session}'s life cycle.<a name="line.23"></a>
<FONT color="green">024</FONT> *<a name="line.24"></a>
<FONT color="green">025</FONT> * @since 0.9<a name="line.25"></a>
<FONT color="green">026</FONT> */<a name="line.26"></a>
<FONT color="green">027</FONT> public interface SessionListener {<a name="line.27"></a>
<FONT color="green">028</FONT> <a name="line.28"></a>
<FONT color="green">029</FONT> /**<a name="line.29"></a>
<FONT color="green">030</FONT> * Notification callback that occurs when the corresponding Session has started.<a name="line.30"></a>
<FONT color="green">031</FONT> *<a name="line.31"></a>
<FONT color="green">032</FONT> * @param session the session that has started.<a name="line.32"></a>
<FONT color="green">033</FONT> */<a name="line.33"></a>
<FONT color="green">034</FONT> void onStart(Session session);<a name="line.34"></a>
<FONT color="green">035</FONT> <a name="line.35"></a>
<FONT color="green">036</FONT> /**<a name="line.36"></a>
<FONT color="green">037</FONT> * Notification callback that occurs when the corresponding Session has stopped, either programmatically via<a name="line.37"></a>
<FONT color="green">038</FONT> * {@link Session#stop} or automatically upon a subject logging out.<a name="line.38"></a>
<FONT color="green">039</FONT> *<a name="line.39"></a>
<FONT color="green">040</FONT> * @param session the session that has stopped.<a name="line.40"></a>
<FONT color="green">041</FONT> */<a name="line.41"></a>
<FONT color="green">042</FONT> void onStop(Session session);<a name="line.42"></a>
<FONT color="green">043</FONT> <a name="line.43"></a>
<FONT color="green">044</FONT> /**<a name="line.44"></a>
<FONT color="green">045</FONT> * Notification callback that occurs when the corresponding Session has expired.<a name="line.45"></a>
<FONT color="green">046</FONT> * &lt;p/&gt;<a name="line.46"></a>
<FONT color="green">047</FONT> * &lt;b&gt;Note&lt;/b&gt;: this method is almost never called at the exact instant that the {@code Session} expires. Almost all<a name="line.47"></a>
<FONT color="green">048</FONT> * session management systems, including Shiro's implementations, lazily validate sessions - either when they<a name="line.48"></a>
<FONT color="green">049</FONT> * are accessed or during a regular validation interval. It would be too resource intensive to monitor every<a name="line.49"></a>
<FONT color="green">050</FONT> * single session instance to know the exact instant it expires.<a name="line.50"></a>
<FONT color="green">051</FONT> * &lt;p/&gt;<a name="line.51"></a>
<FONT color="green">052</FONT> * If you need to perform time-based logic when a session expires, it is best to write it based on the<a name="line.52"></a>
<FONT color="green">053</FONT> * session's {@link org.apache.shiro.session.Session#getLastAccessTime() lastAccessTime} and &lt;em&gt;not&lt;/em&gt; the time<a name="line.53"></a>
<FONT color="green">054</FONT> * when this method is called.<a name="line.54"></a>
<FONT color="green">055</FONT> *<a name="line.55"></a>
<FONT color="green">056</FONT> * @param session the session that has expired.<a name="line.56"></a>
<FONT color="green">057</FONT> */<a name="line.57"></a>
<FONT color="green">058</FONT> void onExpiration(Session session);<a name="line.58"></a>
<FONT color="green">059</FONT> }<a name="line.59"></a>
</PRE>
</BODY>
</HTML>