blob: 5fcc5dbd16dff0b328fc17a3524d9134020daf9f [file] [log] [blame]
<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.subject.support;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.shiro.session.SessionException;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> /**<a name="line.23"></a>
<FONT color="green">024</FONT> * Exception thrown if attempting to create a new {@code Subject}<a name="line.24"></a>
<FONT color="green">025</FONT> * {@link org.apache.shiro.subject.Subject#getSession() session}, but that {@code Subject}'s sessions are disabled.<a name="line.25"></a>
<FONT color="green">026</FONT> * &lt;p/&gt;<a name="line.26"></a>
<FONT color="green">027</FONT> * Note that this exception represents an invalid API usage scenario - where Shiro has been configured to disable<a name="line.27"></a>
<FONT color="green">028</FONT> * sessions for a particular subject, but a developer is attempting to use that Subject's session.<a name="line.28"></a>
<FONT color="green">029</FONT> * &lt;p/&gt;<a name="line.29"></a>
<FONT color="green">030</FONT> * In other words, if this exception is encountered, it should be resolved by a configuration change for Shiro and<a name="line.30"></a>
<FONT color="green">031</FONT> * &lt;em&gt;not&lt;/em&gt; by checking every Subject to see if they are enabled or not (which would likely introduce very<a name="line.31"></a>
<FONT color="green">032</FONT> * ugly/paranoid code checks everywhere a session is needed). This is why there is no<a name="line.32"></a>
<FONT color="green">033</FONT> * {@code subject.isSessionEnabled()} method.<a name="line.33"></a>
<FONT color="green">034</FONT> *<a name="line.34"></a>
<FONT color="green">035</FONT> * @since 1.2<a name="line.35"></a>
<FONT color="green">036</FONT> */<a name="line.36"></a>
<FONT color="green">037</FONT> public class DisabledSessionException extends SessionException {<a name="line.37"></a>
<FONT color="green">038</FONT> <a name="line.38"></a>
<FONT color="green">039</FONT> public DisabledSessionException(String message) {<a name="line.39"></a>
<FONT color="green">040</FONT> super(message);<a name="line.40"></a>
<FONT color="green">041</FONT> }<a name="line.41"></a>
<FONT color="green">042</FONT> }<a name="line.42"></a>
</PRE>
</BODY>
</HTML>