org.springframework.web.socket.sockjs.SockJsMessageDeliveryException Maven / Gradle / Ivy
/*
* Copyright 2002-2013 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.socket.sockjs;
import java.util.List;
/**
* An exception thrown when a message frame was successfully received over an HTTP POST
* and parsed but one or more of the messages it contained could not be delivered to the
* WebSocketHandler either because the handler failed or because the connection got
* closed.
*
* The SockJS session is not automatically closed after this exception.
*
* @author Rossen Stoyanchev
* @since 4.0
*/
@SuppressWarnings("serial")
public class SockJsMessageDeliveryException extends SockJsException {
private final List undeliveredMessages;
public SockJsMessageDeliveryException(String sessionId, List undeliveredMessages, Throwable cause) {
super("Failed to deliver message(s) " + undeliveredMessages + " for session " + sessionId, sessionId, cause);
this.undeliveredMessages = undeliveredMessages;
}
public SockJsMessageDeliveryException(String sessionId, List undeliveredMessages, String message) {
super("Failed to deliver message(s) " + undeliveredMessages + " for session "
+ sessionId + ": " + message, sessionId, null);
this.undeliveredMessages = undeliveredMessages;
}
public List getUndeliveredMessages() {
return this.undeliveredMessages;
}
}