WebSessionStore.java

/*
 * 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.server.session;

import reactor.core.publisher.Mono;

import org.springframework.web.server.WebSession;

/**
 * Strategy for {@link WebSession} persistence.
 *
 * @author Rossen Stoyanchev
 * @since 5.0
 */
public interface WebSessionStore {

	/**
	 * Store the given session.
	 * @param session the session to store
	 * @return {@code Mono} for completion notification
	 */
	Mono<Void> storeSession(WebSession session);

	/**
	 * Load the session for the given session id.
	 * @param sessionId the session to load
	 * @return {@code Mono} for async access to the loaded session
	 */
	Mono<WebSession> retrieveSession(String sessionId);

	/**
	 * Remove the session with the given id.
	 * @param sessionId the session to remove
	 * @return {@code Mono} for completion notification
	 */
	Mono<Void> removeSession(String sessionId);

}