001/*
002 * Copyright 2002-2017 the original author or authors.
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 *      https://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 org.springframework.web.method.annotation;
018
019import org.springframework.core.MethodParameter;
020import org.springframework.lang.Nullable;
021import org.springframework.util.Assert;
022import org.springframework.web.bind.support.SessionStatus;
023import org.springframework.web.bind.support.WebDataBinderFactory;
024import org.springframework.web.context.request.NativeWebRequest;
025import org.springframework.web.method.support.HandlerMethodArgumentResolver;
026import org.springframework.web.method.support.ModelAndViewContainer;
027
028/**
029 * Resolves a {@link SessionStatus} argument by obtaining it from
030 * the {@link ModelAndViewContainer}.
031 *
032 * @author Rossen Stoyanchev
033 * @since 3.1
034 */
035public class SessionStatusMethodArgumentResolver implements HandlerMethodArgumentResolver {
036
037        @Override
038        public boolean supportsParameter(MethodParameter parameter) {
039                return SessionStatus.class == parameter.getParameterType();
040        }
041
042        @Override
043        public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
044                        NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
045
046                Assert.state(mavContainer != null, "ModelAndViewContainer is required for session status exposure");
047                return mavContainer.getSessionStatus();
048        }
049
050}