InitialRequestStrategy.java

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2008, Red Hat Middleware LLC, and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * 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, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jboss.jsfunit.framework;

import com.gargoylesoftware.htmlunit.Page;
import java.io.IOException;

/**
 * Implementations of this interface allow for different ways to make the 
 * initial request that starts a JSF session.  Implementers of this interface
 * will need to use only the HtmlUnit API as the initial setup does not need
 * to be JSF-specific.
 *
 * @author Stan Silvert
 * @since 1.0
 */
public interface InitialRequestStrategy
{
   /**
    * Do the initial request.  This request may consist of logging in or
    * doing some application-specific setup.
    *
    * @param wcSpec The WebClient specification.
    *
    * @return The Page obejct returned by HtmlUnit when the initial setup is
    *         complete.
    *
    * @throws IOException if HtmlUnit encounters an error.
    */
   public Page doInitialRequest(WebClientSpec wcSpec) throws IOException;
}