| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Copyright 2008 Les Hazlewood<a name="line.2"></a> |
| <FONT color="green">003</FONT> *<a name="line.3"></a> |
| <FONT color="green">004</FONT> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a> |
| <FONT color="green">005</FONT> * you may not use this file except in compliance with the License.<a name="line.5"></a> |
| <FONT color="green">006</FONT> * You may obtain a copy of the License at<a name="line.6"></a> |
| <FONT color="green">007</FONT> *<a name="line.7"></a> |
| <FONT color="green">008</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a> |
| <FONT color="green">011</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a> |
| <FONT color="green">012</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a> |
| <FONT color="green">013</FONT> * See the License for the specific language governing permissions and<a name="line.13"></a> |
| <FONT color="green">014</FONT> * limitations under the License.<a name="line.14"></a> |
| <FONT color="green">015</FONT> */<a name="line.15"></a> |
| <FONT color="green">016</FONT> package org.apache.shiro.session.mgt;<a name="line.16"></a> |
| <FONT color="green">017</FONT> <a name="line.17"></a> |
| <FONT color="green">018</FONT> import java.io.Serializable;<a name="line.18"></a> |
| <FONT color="green">019</FONT> <a name="line.19"></a> |
| <FONT color="green">020</FONT> /**<a name="line.20"></a> |
| <FONT color="green">021</FONT> * A {@code SessionKey} is a key that allows look-up of any particular {@link org.apache.shiro.session.Session Session}<a name="line.21"></a> |
| <FONT color="green">022</FONT> * instance. This is not to be confused what is probably better recognized as a session <em>attribute</em> key - a key<a name="line.22"></a> |
| <FONT color="green">023</FONT> * that is used to acquire a session attribute via the<a name="line.23"></a> |
| <FONT color="green">024</FONT> * {@link org.apache.shiro.session.Session#getAttribute(Object) Session.getAttribute} method. A {@code SessionKey}<a name="line.24"></a> |
| <FONT color="green">025</FONT> * looks up a Session object directly.<a name="line.25"></a> |
| <FONT color="green">026</FONT> * <p/><a name="line.26"></a> |
| <FONT color="green">027</FONT> * While a {@code SessionKey} allows lookup of <em>any</em> Session that might exist, this is not something in practice<a name="line.27"></a> |
| <FONT color="green">028</FONT> * done too often by most Shiro end-users. Instead, it is usually more convenient to acquire the currently executing<a name="line.28"></a> |
| <FONT color="green">029</FONT> * {@code Subject}'s session via the {@link org.apache.shiro.subject.Subject#getSession} method. This interface and<a name="line.29"></a> |
| <FONT color="green">030</FONT> * its usages are best suited for framework development.<a name="line.30"></a> |
| <FONT color="green">031</FONT> *<a name="line.31"></a> |
| <FONT color="green">032</FONT> * @since 1.0<a name="line.32"></a> |
| <FONT color="green">033</FONT> */<a name="line.33"></a> |
| <FONT color="green">034</FONT> public interface SessionKey {<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> * Returns the id of the session to acquire.<a name="line.37"></a> |
| <FONT color="green">038</FONT> * <p/><a name="line.38"></a> |
| <FONT color="green">039</FONT> * Acquiring sessions by ID only is a suitable strategy when sessions are natively managed by Shiro directly.<a name="line.39"></a> |
| <FONT color="green">040</FONT> * For example, the Servlet specification does not have an API that allows session acquisition by session ID, so<a name="line.40"></a> |
| <FONT color="green">041</FONT> * the session ID alone is not sufficient for ServletContainer-based SessionManager implementations.<a name="line.41"></a> |
| <FONT color="green">042</FONT> *<a name="line.42"></a> |
| <FONT color="green">043</FONT> * @return the id of the session to acquire.<a name="line.43"></a> |
| <FONT color="green">044</FONT> */<a name="line.44"></a> |
| <FONT color="green">045</FONT> Serializable getSessionId();<a name="line.45"></a> |
| <FONT color="green">046</FONT> }<a name="line.46"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
