package se.entra.phantom.server.http;

import java.io.IOException;

/**
 * This interface is implemented by classes acting as "CGI programs" for the
 * NetPhantom Web Server.
 */
public interface CgiHtmlResourceInterface
{
  /**
   * This method should return an <code>HtmlResource</code> instance with the document
   * that should be sent to the client.
   *
   * <p>The current directory of the CGI for the client agent is defined in the
   * <code>HttpSession</code> class instance as the resource requested without
   * the "/name.cgi" text.
   *
   * @throws  IOException  for IO errors.
   */
  public abstract HtmlResource performAction(HttpSession session) throws IOException;
}