001/* 002 * Copyright 2002-2016 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * https://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.web; 018 019import javax.servlet.ServletException; 020 021/** 022 * Exception thrown when an HTTP request handler requires a pre-existing session. 023 * 024 * @author Juergen Hoeller 025 * @since 2.0 026 */ 027@SuppressWarnings("serial") 028public class HttpSessionRequiredException extends ServletException { 029 030 private String expectedAttribute; 031 032 033 /** 034 * Create a new HttpSessionRequiredException. 035 * @param msg the detail message 036 */ 037 public HttpSessionRequiredException(String msg) { 038 super(msg); 039 } 040 041 /** 042 * Create a new HttpSessionRequiredException. 043 * @param msg the detail message 044 * @param expectedAttribute the name of the expected session attribute 045 * @since 4.3 046 */ 047 public HttpSessionRequiredException(String msg, String expectedAttribute) { 048 super(msg); 049 this.expectedAttribute = expectedAttribute; 050 } 051 052 053 /** 054 * Return the name of the expected session attribute, if any. 055 * @since 4.3 056 */ 057 public String getExpectedAttribute() { 058 return this.expectedAttribute; 059 } 060 061}