net.officefloor.web.session.spi.FreshHttpSession Maven / Gradle / Ivy

Go to download
/*
 * OfficeFloor - http://www.officefloor.net
 * Copyright (C) 2005-2018 Daniel Sagenschneider
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package net.officefloor.web.session.spi;

import net.officefloor.server.http.ServerHttpConnection;
import net.officefloor.web.session.HttpSession;

/**
 * Newly created {@link HttpSession} requiring a session Id.
 *
 * @author Daniel Sagenschneider
 */
public interface FreshHttpSession {

	/**
	 * 
	 * Obtains the {@link ServerHttpConnection} requiring a new
	 * {@link HttpSession}.
	 * 
	 * Typically this should not be required to generate session Ids.
	 *
	 * @return {@link ServerHttpConnection} requiring a new {@link HttpSession}.
	 */
	ServerHttpConnection getConnection();

	/**
	 * Specifies the Id generated for the {@link HttpSession}.
	 *
	 * @param sessionId
	 *            Id generated for the {@link HttpSession}.
	 */
	void setSessionId(String sessionId);

	/**
	 * Flags failure in generating the {@link HttpSession} Id.
	 *
	 * @param failure
	 *            Failure in generating the {@link HttpSession} Id.
	 */
	void failedToGenerateSessionId(Throwable failure);

}