/*
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU General Public License, version 2 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/gpl-2.0.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* 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 General Public License for more details.
*
*
* Copyright 2006 - 2013 Pentaho Corporation. All rights reserved.
*/
package org.pentaho.platform.engine.core.system;
import org.pentaho.platform.api.engine.IPentahoSession;
/**
* A strategy for storing an IPentahoSession against a thread.
*
* <p>
* Inspired by {@code org.springframework.security.context.SecurityContextHolderStrategy}.
* </p>
*
* @author mlowery
*/
public interface IPentahoSessionHolderStrategy {
/**
* Sets the current session.
*
* @param session
* session to set
*/
void setSession( IPentahoSession session );
/**
* Returns the current session.
*
* @return session
*/
IPentahoSession getSession();
/**
* Clears the current session.
*/
void removeSession();
}