001/* 002 * Copyright 2002-2017 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.socket.sockjs; 018 019import org.springframework.core.NestedRuntimeException; 020import org.springframework.lang.Nullable; 021 022/** 023 * Base class for exceptions raised while processing SockJS HTTP requests. 024 * 025 * @author Rossen Stoyanchev 026 * @since 4.0 027 */ 028@SuppressWarnings("serial") 029public class SockJsException extends NestedRuntimeException { 030 031 @Nullable 032 private final String sessionId; 033 034 035 /** 036 * Constructor for SockJsException. 037 * @param message the exception message 038 * @param cause the root cause 039 */ 040 public SockJsException(String message, @Nullable Throwable cause) { 041 this(message, null, cause); 042 } 043 044 /** 045 * Constructor for SockJsException. 046 * @param message the exception message 047 * @param sessionId the SockJS session id 048 * @param cause the root cause 049 */ 050 public SockJsException(String message, @Nullable String sessionId, @Nullable Throwable cause) { 051 super(message, cause); 052 this.sessionId = sessionId; 053 } 054 055 056 /** 057 * Return the SockJS session id. 058 */ 059 @Nullable 060 public String getSockJsSessionId() { 061 return this.sessionId; 062 } 063 064}