net.officefloor.web.session.HttpSessionAdministration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of officeweb Show documentation

OfficeFloor plug-in for Web

There is a newer version: 3.40.0

/*
 * 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;

import net.officefloor.frame.api.function.ManagedFunction;
import net.officefloor.frame.api.managedobject.AsynchronousManagedObject;

/**
 * Administration interface for the {@link HttpSession}.
 *
 * @author Daniel Sagenschneider
 */
public interface HttpSessionAdministration {

	/**
	 * Triggers invalidating the {@link HttpSession}.
	 *
	 * @param isRequireNewSession
	 *            true to have a new {@link HttpSession} created.
	 * @throws Throwable
	 *             If immediate failure in invalidating the {@link HttpSession}.
	 */
	void invalidate(boolean isRequireNewSession) throws Throwable;

	/**
	 * Triggers storing the {@link HttpSession}.
	 *
	 * @throws Throwable
	 *             If immediate failure in storing the {@link HttpSession}.
	 */
	void store() throws Throwable;

	/**
	 * 
	 * Indicates if the invalidate or store operation are complete.
	 * 
	 * As is an {@link AsynchronousManagedObject}, the next time a new
	 * {@link ManagedFunction} is run the operation should be complete. This method enables
	 * determining if completed immediately and there were no failures of the
	 * operation.
	 *
	 * @return true if the invalidate or store operation is
	 *         complete.
	 * @throws Throwable
	 *             Possible failure in invalidating or storing the
	 *             {@link HttpSession}.
	 */
	boolean isOperationComplete() throws Throwable;

}