ProtocolContext.java

/*
 * eID Applet Project.
 * Copyright (C) 2008-2009 FedICT.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version
 * 3.0 as published by the Free Software Foundation.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, see 
 * http://www.gnu.org/licenses/.
 */

package be.fedict.eid.applet.shared.protocol;

/**
 * Interface for protocol context component.
 * 
 * @author Frank Cornelis
 * 
 */
public interface ProtocolContext {

	/**
	 * Gives back the current protocol state.
	 * 
	 * @return
	 */
	ProtocolState getProtocolState();

	/**
	 * Persists the protocol state in the protocol context.
	 * 
	 * @param protocolState
	 */
	void setProtocolState(ProtocolState protocolState);

	/**
	 * Removes the protocol state from the protocol context.
	 */
	void removeProtocolState();
}