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.messaging;
018
019import org.springframework.core.NestedRuntimeException;
020import org.springframework.lang.Nullable;
021
022/**
023 * The base exception for any failures related to messaging.
024 *
025 * @author Mark Fisher
026 * @author Gary Russell
027 * @since 4.0
028 */
029@SuppressWarnings("serial")
030public class MessagingException extends NestedRuntimeException {
031
032        @Nullable
033        private final Message<?> failedMessage;
034
035
036        public MessagingException(Message<?> message) {
037                super(null, null);
038                this.failedMessage = message;
039        }
040
041        public MessagingException(String description) {
042                super(description);
043                this.failedMessage = null;
044        }
045
046        public MessagingException(@Nullable String description, @Nullable Throwable cause) {
047                super(description, cause);
048                this.failedMessage = null;
049        }
050
051        public MessagingException(Message<?> message, String description) {
052                super(description);
053                this.failedMessage = message;
054        }
055
056        public MessagingException(Message<?> message, Throwable cause) {
057                super(null, cause);
058                this.failedMessage = message;
059        }
060
061        public MessagingException(Message<?> message, @Nullable String description, @Nullable Throwable cause) {
062                super(description, cause);
063                this.failedMessage = message;
064        }
065
066
067        @Nullable
068        public Message<?> getFailedMessage() {
069                return this.failedMessage;
070        }
071
072        @Override
073        public String toString() {
074                return super.toString() + (this.failedMessage == null ? ""
075                                : (", failedMessage=" + this.failedMessage));
076        }
077
078}