| <!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.InvalidSessionException;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.session.ProxiedSession;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.session.Session;</a> |
| <span class="sourceLineNo">024</span><a id="line.24"></a> |
| <span class="sourceLineNo">025</span><a id="line.25"></a> |
| <span class="sourceLineNo">026</span><a id="line.26">/**</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * Implementation of the {@link Session Session} interface that proxies another <code>Session</code>, but does not</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * allow any 'write' operations to the underlying session. It allows 'read' operations only.</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * <p/></a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * The <code>Session</code> write operations are defined as follows. A call to any of these methods on this</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * proxy will immediately result in an {@link InvalidSessionException} being thrown:</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * <ul></a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * <li>{@link Session#setTimeout(long) Session.setTimeout(long)}</li></a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * <li>{@link Session#touch() Session.touch()}</li></a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * <li>{@link Session#stop() Session.stop()}</li></a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * <li>{@link Session#setAttribute(Object, Object) Session.setAttribute(key,value)}</li></a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * <li>{@link Session#removeAttribute(Object) Session.removeAttribute(key)}</li></a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * </ul></a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * Any other method invocation not listed above will result in a corresponding call to the underlying <code>Session</code>.</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> *</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * @since 0.9</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> */</a> |
| <span class="sourceLineNo">043</span><a id="line.43">public class ImmutableProxiedSession extends ProxiedSession {</a> |
| <span class="sourceLineNo">044</span><a id="line.44"></a> |
| <span class="sourceLineNo">045</span><a id="line.45"> /**</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * Constructs a new instance of this class proxying the specified <code>Session</code>.</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> *</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * @param target the target <code>Session</code> to proxy.</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> */</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> public ImmutableProxiedSession(Session target) {</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> super(target);</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> }</a> |
| <span class="sourceLineNo">053</span><a id="line.53"></a> |
| <span class="sourceLineNo">054</span><a id="line.54"> /**</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * Simply throws an <code>InvalidSessionException</code> indicating that this proxy is immutable. Used</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * only in the Session's 'write' methods documented in the top class-level JavaDoc.</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> *</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * @throws InvalidSessionException in all cases - used by the Session 'write' method implementations.</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> */</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> protected void throwImmutableException() throws InvalidSessionException {</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> String msg = "This session is immutable and read-only - it cannot be altered. This is usually because " +</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> "the session has been stopped or expired already.";</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> throw new InvalidSessionException(msg);</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> }</a> |
| <span class="sourceLineNo">065</span><a id="line.65"></a> |
| <span class="sourceLineNo">066</span><a id="line.66"> /**</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * Immediately {@link #throwImmutableException() throws} an <code>InvalidSessionException</code> in all</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * cases because this proxy is immutable.</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> */</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> public void setTimeout(long maxIdleTimeInMillis) throws InvalidSessionException {</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> throwImmutableException();</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> }</a> |
| <span class="sourceLineNo">073</span><a id="line.73"></a> |
| <span class="sourceLineNo">074</span><a id="line.74"> /**</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * Immediately {@link #throwImmutableException() throws} an <code>InvalidSessionException</code> in all</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> * cases because this proxy is immutable.</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> */</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> public void touch() throws InvalidSessionException {</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> throwImmutableException();</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> }</a> |
| <span class="sourceLineNo">081</span><a id="line.81"></a> |
| <span class="sourceLineNo">082</span><a id="line.82"> /**</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> * Immediately {@link #throwImmutableException() throws} an <code>InvalidSessionException</code> in all</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * cases because this proxy is immutable.</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> */</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> public void stop() throws InvalidSessionException {</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> throwImmutableException();</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> }</a> |
| <span class="sourceLineNo">089</span><a id="line.89"></a> |
| <span class="sourceLineNo">090</span><a id="line.90"> /**</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> * Immediately {@link #throwImmutableException() throws} an <code>InvalidSessionException</code> in all</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> * cases because this proxy is immutable.</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> */</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> public void setAttribute(Object key, Object value) throws InvalidSessionException {</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> throwImmutableException();</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> }</a> |
| <span class="sourceLineNo">097</span><a id="line.97"></a> |
| <span class="sourceLineNo">098</span><a id="line.98"> /**</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> * Immediately {@link #throwImmutableException() throws} an <code>InvalidSessionException</code> in all</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> * cases because this proxy is immutable.</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> */</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> public Object removeAttribute(Object key) throws InvalidSessionException {</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> throwImmutableException();</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> //we should never ever reach this point due to the exception being thrown.</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> throw new InternalError("This code should never execute - please report this as a bug!");</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> }</a> |
| <span class="sourceLineNo">107</span><a id="line.107">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
