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