001/*
002 * Copyright 2002-2016 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.server.session;
018
019import reactor.core.publisher.Mono;
020
021import org.springframework.web.server.ServerWebExchange;
022import org.springframework.web.server.WebSession;
023
024/**
025 * Main class for access to the {@link WebSession} for an HTTP request.
026 *
027 * @author Rossen Stoyanchev
028 * @since 5.0
029 * @see WebSessionIdResolver
030 * @see WebSessionStore
031 */
032public interface WebSessionManager {
033
034        /**
035         * Return the {@link WebSession} for the given exchange. Always guaranteed
036         * to return an instance either matching to the session id requested by the
037         * client, or a new session either because the client did not specify one
038         * or because the underlying session expired.
039         * @param exchange the current exchange
040         * @return promise for the WebSession
041         */
042        Mono<WebSession> getSession(ServerWebExchange exchange);
043
044}