org.springframework.web.service.invoker.RequestAttributeArgumentResolver 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.service.invoker;
import org.springframework.core.MethodParameter;
import org.springframework.web.bind.annotation.RequestAttribute;
/**
* {@link HttpServiceArgumentResolver} for {@link RequestAttribute @RequestAttribute}
* annotated arguments.
*
* The argument may be a single variable value or a {@code Map} with multiple
* variables and values.
*
*
If the value is required but {@code null}, {@link IllegalArgumentException}
* is raised. The value is not required if:
*
* - {@link RequestAttribute#required()} is set to {@code false}
*
- The argument is declared as {@link java.util.Optional}
*
*
* @author Rossen Stoyanchev
* @since 6.0
*/
public class RequestAttributeArgumentResolver extends AbstractNamedValueArgumentResolver {
@Override
protected NamedValueInfo createNamedValueInfo(MethodParameter parameter) {
RequestAttribute annot = parameter.getParameterAnnotation(RequestAttribute.class);
return (annot == null ? null :
new NamedValueInfo(annot.name(), annot.required(), null, "request attribute", false));
}
@Override
protected void addRequestValue(
String name, Object value, MethodParameter parameter, HttpRequestValues.Builder requestValues) {
requestValues.addAttribute(name, value);
}
}