org.ameba.exception.BadRequestException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ameba-lib Show documentation
Ameba Utilities
There is a newer version: 4.1.0-jdk17
/*
 * Copyright 2015-2024 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.ameba.exception;

import org.ameba.Messages;
import org.ameba.i18n.Translator;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;

import java.io.Serializable;

/**
 * A BadRequestException signals an error, caused by a invalid client request that can be
 * corrected by the client.
 *
 * @author Heiko Scherrer
 */
@ResponseStatus(HttpStatus.BAD_REQUEST)
public class BadRequestException extends BusinessRuntimeException {

    /**
     * Constructs with a message key and a message
     *
     * @param message Message text
     */
    public BadRequestException(String message) {
        super(message);
    }

    /**
     * Constructs with a message key and a message
     *
     * @param messageKey Message key
     * @param data Additional implicit data passed to the caller
     */
    protected BadRequestException(String messageKey, Serializable[] data) {
        super(messageKey, data);
    }

    /**
     * Constructs with a message text a message key and a message
     *
     * @param message Message text
     * @param messageKey Message key
     * @param data Additional implicit data passed to the caller
     */
    protected BadRequestException(String message, String messageKey, Serializable... data) {
        super(message, messageKey, data);
    }

    protected BadRequestException(Translator translator, String messageKey, Serializable[] data, Object... param) {
        super(translator.translate(messageKey, param), messageKey, data);
    }

    /**
     * Create and return an instance with the given parameters and the message key {@link Messages#REQ_GENERIC}.
     *
     * @param message Message text
     * @param data Additional implicit data passed to the caller
     * @return The instance
     */
    public static BadRequestException createFrom(String message, Serializable... data) {
        return new BadRequestException(message, Messages.REQ_GENERIC, data);
    }

    /**
     * Create and return an instance with the given parameters and the message key.
     *
     * @param translator A Translator instance
     * @param messageKey Message key
     * @param data Additional implicit data passed to the caller
     * @param param Additional implicit data passed to the caller
     * @return The instance
     */
    public static BadRequestException createFromKey(Translator translator, String messageKey, Serializable[] data, Object... param) {
        return new BadRequestException(translator.translate(messageKey, param), messageKey, data);
    }
}