-
Notifications
You must be signed in to change notification settings - Fork 38.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add @SessionAttribute with Servlet-based support
Issue: SPR-13894
- Loading branch information
1 parent
7df3a32
commit 698f923
Showing
9 changed files
with
394 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
73 changes: 73 additions & 0 deletions
73
spring-web/src/main/java/org/springframework/web/bind/annotation/SessionAttribute.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| /* | ||
| * Copyright 2002-2015 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.springframework.web.bind.annotation; | ||
|
|
||
| import java.lang.annotation.Documented; | ||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| import org.springframework.core.annotation.AliasFor; | ||
|
|
||
| /** | ||
| * Annotation to bind a method parameter to a session attribute. | ||
| * | ||
| * <p>The main motivation is to provide convenient access to existing, permanent | ||
| * session attributes (e.g. user authentication object) with an optional/required | ||
| * check and a cast to the target method parameter type. | ||
| * | ||
| * <p>For use cases that require adding or removing session attributes consider | ||
| * injecting {@code org.springframework.web.context.request.WebRequest} or | ||
| * {@code javax.servlet.http.HttpSession} into the controller method. | ||
| * | ||
| * <p>For temporary storage of model attributes in the session as part of the | ||
| * workflow for a controller, consider using {@link SessionAttributes} instead. | ||
| * | ||
| * @author Rossen Stoyanchev | ||
| * @since 4.3 | ||
| * @see RequestMapping | ||
| * @see SessionAttributes | ||
| */ | ||
| @Target(ElementType.PARAMETER) | ||
| @Retention(RetentionPolicy.RUNTIME) | ||
| @Documented | ||
| public @interface SessionAttribute { | ||
|
|
||
| /** | ||
| * Alias for {@link #name}. | ||
| */ | ||
| @AliasFor("name") | ||
| String value() default ""; | ||
|
|
||
| /** | ||
| * The name of the session attribute to bind to. | ||
| * <p>The default name is inferred from the method parameter name. | ||
| */ | ||
| @AliasFor("value") | ||
| String name() default ""; | ||
|
|
||
| /** | ||
| * Whether the session attribute is required. | ||
| * <p>Defaults to {@code true}, leading to an exception being thrown | ||
| * if the attribute is missing in the session or there is no session. | ||
| * Switch this to {@code false} if you prefer a {@code null} or Java 1.8+ | ||
| * {@code java.util.Optional} if the attribute doesn't exist. | ||
| */ | ||
| boolean required() default true; | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
60 changes: 60 additions & 0 deletions
60
...ngframework/web/servlet/mvc/method/annotation/SessionAttributeMethodArgumentResolver.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /* | ||
| * Copyright 2002-2016 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.springframework.web.servlet.mvc.method.annotation; | ||
|
|
||
| import javax.servlet.ServletException; | ||
|
|
||
| import org.springframework.core.MethodParameter; | ||
| import org.springframework.web.bind.ServletRequestBindingException; | ||
| import org.springframework.web.bind.annotation.SessionAttribute; | ||
| import org.springframework.web.bind.annotation.ValueConstants; | ||
| import org.springframework.web.context.request.NativeWebRequest; | ||
| import org.springframework.web.context.request.RequestAttributes; | ||
| import org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver; | ||
|
|
||
| /** | ||
| * Resolves method arguments annotated with an @{@link SessionAttribute}. | ||
| * | ||
| * @author Rossen Stoyanchev | ||
| * @since 4.3 | ||
| */ | ||
| public class SessionAttributeMethodArgumentResolver extends AbstractNamedValueMethodArgumentResolver { | ||
|
|
||
|
|
||
| @Override | ||
| public boolean supportsParameter(MethodParameter parameter) { | ||
| return parameter.hasParameterAnnotation(SessionAttribute.class); | ||
| } | ||
|
|
||
|
|
||
| @Override | ||
| protected NamedValueInfo createNamedValueInfo(MethodParameter parameter) { | ||
| SessionAttribute annot = parameter.getParameterAnnotation(SessionAttribute.class); | ||
| return new NamedValueInfo(annot.name(), annot.required(), ValueConstants.DEFAULT_NONE); | ||
| } | ||
|
|
||
| @Override | ||
| protected Object resolveName(String name, MethodParameter parameter, NativeWebRequest request){ | ||
| return request.getAttribute(name, RequestAttributes.SCOPE_SESSION); | ||
| } | ||
|
|
||
| @Override | ||
| protected void handleMissingValue(String name, MethodParameter parameter) throws ServletException { | ||
| throw new ServletRequestBindingException("Missing session attribute '" + name + | ||
| "' of type " + parameter.getNestedParameterType().getSimpleName()); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.