SessionManager.java

package com.google.gwt.dist;

import com.google.gwt.dist.comm.CommMessage;
import com.google.gwt.dist.comm.CommMessagePayload;
import com.google.gwt.dist.compiler.communicator.Communicator;

/**
 * Defines how SessionManager implementations will handle queries from client.
 */
public interface SessionManager extends Runnable {

	/**
	 * Check if CompilePerms is finished.
	 * 
	 * @param n
	 *            Node to check.
	 * 
	 * @return true if {@link CompilePerms} is completed and ready to be sent to the
	 *         client.
	 */
	boolean compilePermsCompleted(Node n);

	/**
	 * Fetch Communicator that is currently in use.
	 * 
	 * @return Currently used communicator.
	 */
	Communicator getCommunicator();

	/**
	 * Is all the necessary communication with, that is supposed to be done by
	 * this session manager, finished.
	 * 
	 * @return true if there is no more communication that should be done. false
	 *         otherwise.
	 */
	boolean isFinished();

	/**
	 * Check if it is OK to send some data to the agent.
	 * 
	 * @param node
	 *            Note to which the data should be sent.
	 * @return true if it is OK for the client to send data to the agent. False
	 *         otherwise.
	 */
	boolean readyToReceiveData(Node node);

	/**
	 * s Sends data to specified node.
	 * 
	 * @param data
	 *            Data to be sent to the agent.
	 */
	void sendDataToAgent(byte[] data);

	/**
	 * Send CommMessage to the node.
	 * 
	 * @param message
	 *            CommMessage to be sent.
	 */
	<T extends CommMessagePayload> T sendMessageToAgent(CommMessage<T> message);

	/**
	 * Sets communicator to be used.
	 * 
	 * @param communicator
	 *            Communicator to be used.
	 */
	void setCommunicator(Communicator communicator);

	/**
	 * Initiates message exchange with agent.
	 */
	void start();
}