001/*
002 * Copyright 2022-2025 Revetware LLC.
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 * http://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 com.soklet.exception;
018
019import javax.annotation.Nonnull;
020import javax.annotation.Nullable;
021import javax.annotation.concurrent.NotThreadSafe;
022import java.util.Optional;
023
024import static java.util.Objects.requireNonNull;
025
026/**
027 * Exception thrown when an HTTP form parameter value does not match the expected Java type.
028 *
029 * @author <a href="https://www.revetkn.com">Mark Allen</a>
030 */
031@NotThreadSafe
032public final class IllegalFormParameterException extends BadRequestException {
033        @Nonnull
034        private final String formParameterName;
035        @Nullable
036        private final String formParameterValue;
037
038        public IllegalFormParameterException(@Nullable String message,
039                                                                                                                                                         @Nonnull String formParameterName,
040                                                                                                                                                         @Nullable String formParameterValue) {
041                super(message);
042                this.formParameterName = requireNonNull(formParameterName);
043                this.formParameterValue = formParameterValue;
044        }
045
046        public IllegalFormParameterException(@Nullable String message,
047                                                                                                                                                         @Nullable Throwable cause,
048                                                                                                                                                         @Nonnull String formParameterName,
049                                                                                                                                                         @Nullable String formParameterValue) {
050                super(message, cause);
051                this.formParameterName = requireNonNull(formParameterName);
052                this.formParameterValue = formParameterValue;
053        }
054
055        @Nonnull
056        public String getFormParameterName() {
057                return this.formParameterName;
058        }
059
060        @Nonnull
061        public Optional<String> getFormParameterValue() {
062                return Optional.ofNullable(this.formParameterValue);
063        }
064}