| <!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.session.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.session.Session;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.session.SessionException;</a> |
| <span class="sourceLineNo">023</span><a id="line.23"></a> |
| <span class="sourceLineNo">024</span><a id="line.24">/**</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * A SessionManager manages the creation, maintenance, and clean-up of all application</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * {@link org.apache.shiro.session.Session Session}s.</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> *</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * @since 0.1</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> */</a> |
| <span class="sourceLineNo">030</span><a id="line.30">public interface SessionManager {</a> |
| <span class="sourceLineNo">031</span><a id="line.31"></a> |
| <span class="sourceLineNo">032</span><a id="line.32"> /**</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * Starts a new session based on the specified contextual initialization data, which can be used by the underlying</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * implementation to determine how exactly to create the internal Session instance.</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * <p/></a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * This method is mainly used in framework development, as the implementation will often relay the argument</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * to an underlying {@link SessionFactory} which could use the context to construct the internal Session</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * instance in a specific manner. This allows pluggable {@link org.apache.shiro.session.Session Session} creation</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * logic by simply injecting a {@code SessionFactory} into the {@code SessionManager} instance.</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> *</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * @param context the contextual initialization data that can be used by the implementation or underlying</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * {@link SessionFactory} when instantiating the internal {@code Session} instance.</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * @return the newly created session.</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * @see SessionFactory#createSession(SessionContext)</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * @since 1.0</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> */</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> Session start(SessionContext context);</a> |
| <span class="sourceLineNo">048</span><a id="line.48"></a> |
| <span class="sourceLineNo">049</span><a id="line.49"> /**</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * Retrieves the session corresponding to the specified contextual data (such as a session ID if applicable), or</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * {@code null} if no Session could be found. If a session is found but invalid (stopped or expired), a</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * {@link SessionException} will be thrown.</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> *</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * @param key the Session key to use to look-up the Session</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * @return the {@code Session} instance corresponding to the given lookup key or {@code null} if no session</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * could be acquired.</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * @throws SessionException if a session was found but it was invalid (stopped/expired).</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"> Session getSession(SessionKey key) throws SessionException;</a> |
| <span class="sourceLineNo">061</span><a id="line.61">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
