001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    package org.apache.shiro.subject.support;
020    
021    import org.apache.shiro.session.SessionException;
022    
023    /**
024     * Exception thrown if attempting to create a new {@code Subject}
025     * {@link org.apache.shiro.subject.Subject#getSession() session}, but that {@code Subject}'s sessions are disabled.
026     * <p/>
027     * Note that this exception represents an invalid API usage scenario - where Shiro has been configured to disable
028     * sessions for a particular subject, but a developer is attempting to use that Subject's session.
029     * <p/>
030     * In other words, if this exception is encountered, it should be resolved by a configuration change for Shiro and
031     * <em>not</em> by checking every Subject to see if they are enabled or not (which would likely introduce very
032     * ugly/paranoid code checks everywhere a session is needed). This is why there is no
033     * {@code subject.isSessionEnabled()} method.
034     *
035     * @since 1.2
036     */
037    public class DisabledSessionException extends SessionException {
038    
039        public DisabledSessionException(String message) {
040            super(message);
041        }
042    }