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