org.springframework.kafka.KafkaException Maven / Gradle / Ivy
/*
* Copyright 2016-2020 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
*
* https://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.kafka;
import org.springframework.core.NestedRuntimeException;
import org.springframework.core.log.LogAccessor;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
/**
* The Spring Kafka specific {@link NestedRuntimeException} implementation.
*
* @author Gary Russell
* @author Artem Bilan
*/
@SuppressWarnings("serial")
public class KafkaException extends NestedRuntimeException {
/**
* The log level for {@link KafkaException}.
* @since 2.5
*/
public enum Level {
/**
* Fatal.
*/
FATAL,
/**
* Error.
*/
ERROR,
/**
* Warn.
*/
WARN,
/**
* Info.
*/
INFO,
/**
* Debug.
*/
DEBUG,
/**
* Trace.
*/
TRACE
}
private final Level logLevel;
/**
* Construct an instance with the provided properties.
* @param message the message.
*/
public KafkaException(String message) {
this(message, Level.ERROR, null);
}
/**
* Construct an instance with the provided properties.
* @param message the message.
* @param cause the cause.
*/
public KafkaException(String message, @Nullable Throwable cause) {
this(message, Level.ERROR, cause);
}
/**
* Construct an instance with the provided properties.
* @param message the message.
* @param level the level at which this exception should be logged when using
* {@link #selfLog(String, LogAccessor)}.
* @param cause the cause.
*/
public KafkaException(String message, Level level, @Nullable Throwable cause) {
super(message, cause);
Assert.notNull(level, "'level' cannot be null");
this.logLevel = level;
}
/**
* Log this exception at its log level.
* @param message the message.
* @param logger the log accessor.
*/
public void selfLog(String message, LogAccessor logger) {
switch (this.logLevel) {
case FATAL:
logger.fatal(this, message);
break;
case ERROR:
logger.error(this, message);
break;
case WARN:
logger.warn(this, message);
break;
case INFO:
logger.info(this, message);
break;
case DEBUG:
logger.debug(this, message);
break;
case TRACE:
logger.trace(this, message);
break;
default:
logger.error(this, message);
}
}
}