• Home
• net.officefloor.web
• officeweb
• 3.5.1
• source code
• HttpSessionIdGenerator.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

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

/**
 * 

 * Generates the {@link HttpSession} Id.
 * 

 * Typically a default {@link HttpSessionIdGenerator} is provided by the
 * {@link HttpSession} and this need not be provided. This interface however
 * enables customising the generation of the {@link HttpSession} Id.
 *
 * @author Daniel Sagenschneider
 */
public interface HttpSessionIdGenerator {

	/**
	 * 

	 * Generates the session Id.
	 * 

	 * This method may return without the session Id being specified on the
	 * {@link FreshHttpSession}. In this case it is expected that the session Id
	 * will be populated some time in the near future.
	 *
	 * @param session
	 *            {@link FreshHttpSession} to be populated with a new session
	 *            Id.
	 */
	void generateSessionId(FreshHttpSession session);

}