org.springframework.web.bind.MissingRequestCookieException Maven / Gradle / Ivy
/*
* Copyright 2002-2022 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.web.bind;
import org.springframework.core.MethodParameter;
/**
* {@link ServletRequestBindingException} subclass that indicates
* that a request cookie expected in the method parameters of an
* {@code @RequestMapping} method is not present.
*
* @author Juergen Hoeller
* @since 5.1
* @see MissingRequestHeaderException
*/
@SuppressWarnings("serial")
public class MissingRequestCookieException extends MissingRequestValueException {
private final String cookieName;
private final MethodParameter parameter;
/**
* Constructor for MissingRequestCookieException.
* @param cookieName the name of the missing request cookie
* @param parameter the method parameter
*/
public MissingRequestCookieException(String cookieName, MethodParameter parameter) {
this(cookieName, parameter, false);
}
/**
* Constructor for use when a value was present but converted to {@code null}.
* @param cookieName the name of the missing request cookie
* @param parameter the method parameter
* @param missingAfterConversion whether the value became null after conversion
* @since 5.3.6
*/
public MissingRequestCookieException(
String cookieName, MethodParameter parameter, boolean missingAfterConversion) {
super("", missingAfterConversion, null, new Object[] {cookieName});
this.cookieName = cookieName;
this.parameter = parameter;
getBody().setDetail("Required cookie '" + this.cookieName + "' is not present.");
}
@Override
public String getMessage() {
return "Required cookie '" + this.cookieName + "' for method parameter type " +
this.parameter.getNestedParameterType().getSimpleName() + " is " +
(isMissingAfterConversion() ? "present but converted to null" : "not present");
}
/**
* Return the expected name of the request cookie.
*/
public final String getCookieName() {
return this.cookieName;
}
/**
* Return the method parameter bound to the request cookie.
*/
public final MethodParameter getParameter() {
return this.parameter;
}
}