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.handler;
018
019import org.springframework.lang.Nullable;
020import org.springframework.web.socket.CloseStatus;
021
022/**
023 * Raised when a WebSocket session has exceeded limits it has been configured
024 * for, e.g. timeout, buffer size, etc.
025 *
026 * @author Rossen Stoyanchev
027 * @since 4.0.3
028 */
029@SuppressWarnings("serial")
030public class SessionLimitExceededException extends RuntimeException {
031
032        private final CloseStatus status;
033
034
035        public SessionLimitExceededException(String message, @Nullable CloseStatus status) {
036                super(message);
037                this.status = (status != null ? status : CloseStatus.NO_STATUS_CODE);
038        }
039
040
041        public CloseStatus getStatus() {
042                return this.status;
043        }
044
045}