| <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.mgt;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import java.io.Serializable;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import java.util.Map;<a name="line.22"></a> |
| <FONT color="green">023</FONT> <a name="line.23"></a> |
| <FONT color="green">024</FONT> /**<a name="line.24"></a> |
| <FONT color="green">025</FONT> * A {@code SessionContext} is a 'bucket' of data presented to a {@link SessionFactory SessionFactory} which interprets<a name="line.25"></a> |
| <FONT color="green">026</FONT> * this data to construct {@link org.apache.shiro.session.Session Session} instances. It is essentially a Map of data<a name="line.26"></a> |
| <FONT color="green">027</FONT> * with a few additional type-safe methods for easy retrieval of objects commonly used to construct Subject instances.<a name="line.27"></a> |
| <FONT color="green">028</FONT> * <p/><a name="line.28"></a> |
| <FONT color="green">029</FONT> * While this interface contains type-safe setters and getters for common data types, the map can contain anything<a name="line.29"></a> |
| <FONT color="green">030</FONT> * additional that might be needed by the {@code SessionFactory} implementation to construct {@code Session} instances.<a name="line.30"></a> |
| <FONT color="green">031</FONT> * <p/><a name="line.31"></a> |
| <FONT color="green">032</FONT> * <b>USAGE</b>: Most Shiro end-users will never use a {@code SubjectContext} instance directly and instead will call<a name="line.32"></a> |
| <FONT color="green">033</FONT> * the {@code Subject.}{@link org.apache.shiro.subject.Subject#getSession() getSession()} or<a name="line.33"></a> |
| <FONT color="green">034</FONT> * {@code Subject.}{@link org.apache.shiro.subject.Subject#getSession(boolean) getSession(boolean)} methods (which<a name="line.34"></a> |
| <FONT color="green">035</FONT> * will usually use {@code SessionContext} instances to start a session with the application's<a name="line.35"></a> |
| <FONT color="green">036</FONT> * {@link SessionManager SessionManager}.<a name="line.36"></a> |
| <FONT color="green">037</FONT> *<a name="line.37"></a> |
| <FONT color="green">038</FONT> * @see org.apache.shiro.session.mgt.SessionManager#start SessionManager.start(SessionContext)<a name="line.38"></a> |
| <FONT color="green">039</FONT> * @see org.apache.shiro.session.mgt.SessionFactory SessionFactory<a name="line.39"></a> |
| <FONT color="green">040</FONT> * @since 1.0<a name="line.40"></a> |
| <FONT color="green">041</FONT> */<a name="line.41"></a> |
| <FONT color="green">042</FONT> public interface SessionContext extends Map<String, Object> {<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> * Sets the originating host name or IP address (as a String) from where the {@code Subject} is initiating the<a name="line.45"></a> |
| <FONT color="green">046</FONT> * {@code Session}.<a name="line.46"></a> |
| <FONT color="green">047</FONT> * <p/><a name="line.47"></a> |
| <FONT color="green">048</FONT> * In web-based systems, this host can be inferred from the incoming request, e.g.<a name="line.48"></a> |
| <FONT color="green">049</FONT> * {@code javax.servlet.ServletRequest#getRemoteAddr()} or {@code javax.servlet.ServletRequest#getRemoteHost()}<a name="line.49"></a> |
| <FONT color="green">050</FONT> * methods, or in socket-based systems, it can be obtained via inspecting the socket<a name="line.50"></a> |
| <FONT color="green">051</FONT> * initiator's host IP.<a name="line.51"></a> |
| <FONT color="green">052</FONT> * <p/><a name="line.52"></a> |
| <FONT color="green">053</FONT> * Most secure environments <em>should</em> specify a valid, non-{@code null} {@code host}, since knowing the<a name="line.53"></a> |
| <FONT color="green">054</FONT> * {@code host} allows for more flexibility when securing a system: by requiring an host, access control policies<a name="line.54"></a> |
| <FONT color="green">055</FONT> * can also ensure access is restricted to specific client <em>locations</em> in addition to {@code Subject}<a name="line.55"></a> |
| <FONT color="green">056</FONT> * principals, if so desired.<a name="line.56"></a> |
| <FONT color="green">057</FONT> * <p/><a name="line.57"></a> |
| <FONT color="green">058</FONT> * <b>Caveat</b> - if clients to your system are on a<a name="line.58"></a> |
| <FONT color="green">059</FONT> * public network (as would be the case for a public web site), odds are high the clients can be<a name="line.59"></a> |
| <FONT color="green">060</FONT> * behind a NAT (Network Address Translation) router or HTTP proxy server. If so, all clients<a name="line.60"></a> |
| <FONT color="green">061</FONT> * accessing your system behind that router or proxy will have the same originating host.<a name="line.61"></a> |
| <FONT color="green">062</FONT> * If your system is configured to allow only one session per host, then the next request from a<a name="line.62"></a> |
| <FONT color="green">063</FONT> * different NAT or proxy client will fail and access will be denied for that client. Just be<a name="line.63"></a> |
| <FONT color="green">064</FONT> * aware that host-based security policies are best utilized in LAN or private WAN environments<a name="line.64"></a> |
| <FONT color="green">065</FONT> * when you can be ensure clients will not share IPs or be behind such NAT routers or<a name="line.65"></a> |
| <FONT color="green">066</FONT> * proxy servers.<a name="line.66"></a> |
| <FONT color="green">067</FONT> *<a name="line.67"></a> |
| <FONT color="green">068</FONT> * @param host the originating host name or IP address (as a String) from where the {@code Subject} is<a name="line.68"></a> |
| <FONT color="green">069</FONT> * initiating the {@code Session}.<a name="line.69"></a> |
| <FONT color="green">070</FONT> * @since 1.0<a name="line.70"></a> |
| <FONT color="green">071</FONT> */<a name="line.71"></a> |
| <FONT color="green">072</FONT> void setHost(String host);<a name="line.72"></a> |
| <FONT color="green">073</FONT> <a name="line.73"></a> |
| <FONT color="green">074</FONT> /**<a name="line.74"></a> |
| <FONT color="green">075</FONT> * Returns the originating host name or IP address (as a String) from where the {@code Subject} is initiating the<a name="line.75"></a> |
| <FONT color="green">076</FONT> * {@code Session}.<a name="line.76"></a> |
| <FONT color="green">077</FONT> * <p/><a name="line.77"></a> |
| <FONT color="green">078</FONT> * See the {@link #setHost(String) setHost(String)} JavaDoc for more about security policies based on the<a name="line.78"></a> |
| <FONT color="green">079</FONT> * {@code Session} host.<a name="line.79"></a> |
| <FONT color="green">080</FONT> *<a name="line.80"></a> |
| <FONT color="green">081</FONT> * @return the originating host name or IP address (as a String) from where the {@code Subject} is initiating the<a name="line.81"></a> |
| <FONT color="green">082</FONT> * {@code Session}.<a name="line.82"></a> |
| <FONT color="green">083</FONT> * @see #setHost(String) setHost(String)<a name="line.83"></a> |
| <FONT color="green">084</FONT> */<a name="line.84"></a> |
| <FONT color="green">085</FONT> String getHost();<a name="line.85"></a> |
| <FONT color="green">086</FONT> <a name="line.86"></a> |
| <FONT color="green">087</FONT> Serializable getSessionId();<a name="line.87"></a> |
| <FONT color="green">088</FONT> <a name="line.88"></a> |
| <FONT color="green">089</FONT> void setSessionId(Serializable sessionId);<a name="line.89"></a> |
| <FONT color="green">090</FONT> <a name="line.90"></a> |
| <FONT color="green">091</FONT> }<a name="line.91"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
