/*

  * ====================================================================

  *

  * The Apache Software License, Version 1.1

  *

  * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights

  * reserved.

  *

  * Redistribution and use in source and binary forms, with or without

  * modification, are permitted provided that the following conditions

  * are met:

  *

  * 1. Redistributions of source code must retain the above copyright

  *    notice, this list of conditions and the following disclaimer.

  *

  * 2. Redistributions in binary form must reproduce the above copyright

  *    notice, this list of conditions and the following disclaimer in

  *    the documentation and/or other materials provided with the

  *    distribution.

  *

  * 3. The end-user documentation included with the redistribution, if

  *    any, must include the following acknowlegement:

  *       "This product includes software developed by the

  *        Apache Software Foundation (http://www.apache.org/)."

  *    Alternately, this acknowlegement may appear in the software itself,

  *    if and wherever such third-party acknowlegements normally appear.

  *

  * 4. The names "The Jakarta Project", "Cactus" and "Apache Software

  *    Foundation" must not be used to endorse or promote products

  *    derived from this software without prior written permission. For

  *    written permission, please contact apache@apache.org.

  *

  * 5. Products derived from this software may not be called "Apache"

  *    nor may "Apache" appear in their names without prior written

  *    permission of the Apache Group.

  *

  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED

  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES

  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR

  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT

  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

  * SUCH DAMAGE.

  * ====================================================================

  *

  * This software consists of voluntary contributions made by many

  * individuals on behalf of the Apache Software Foundation.  For more

  * information on the Apache Software Foundation, please see

  * <http://www.apache.org/>.

  *

  */

 package org.apache.cactus.extension.jetty;

 import java.io.File;

 import java.net.URL;

 import junit.extensions.TestSetup;

 import junit.framework.Protectable;

 import junit.framework.Test;

 import junit.framework.TestResult;

 import org.apache.cactus.configuration.BaseConfiguration;

 import org.apache.cactus.configuration.Configuration;

 import org.apache.cactus.configuration.FilterConfiguration;

 import org.apache.cactus.configuration.ServletConfiguration;

 import org.apache.cactus.server.FilterTestRedirector;

 import org.apache.cactus.server.ServletTestRedirector;

 import org.apache.cactus.util.ClassLoaderUtils;

 /**

  * Custom JUnit test setup to use to automatically start Jetty. Example:<br/>

  * <code><pre>

  * public static Test suite()

  * {

  *     TestSuite suite = new TestSuite(Myclass.class);

  *     return new JettyTestSetup(suite);

  * }

  * </pre></code>

  * 

  * @author <a href="mailto:vmassol@apache.org">Vincent Massol</a>

  *

  * @version $Id: JettyTestSetup.java,v 1.2.2.2 2003/10/28 06:59:24 vmassol Exp $

  */

 {

     /**

      * Name of optional system property that points to a Jetty XML

      * configuration file.

      */

     private static final String CACTUS_JETTY_CONFIG_PROPERTY = 

         "cactus.jetty.config";

     /**

      * Name of optional system property that gives the directory

      * where JSPs and other resources are located. 

      */

     private static final String CACTUS_JETTY_RESOURCE_DIR_PROPERTY = 

         "cactus.jetty.resourceDir";

     /**

      * The configuration file to be used for initializing Jetty.

      */

     private File configFile;

     /**

      * The directory containing the resources of the web-application.

      */

     private File resourceDir;

     /**

      * The Jetty server object representing the running instance. It is

      * used to stop Jetty in {@link #tearDown()}.

      */

     private Object server; 

     /**

      * @param theTest the test we are decorating (usually a test suite)

      */

     {

     }

     /**

      * Make sure that {@link #tearDown} is called if {@link #setUp} fails

      * to start the container properly. The default 

      * {@link TestSetup#run(TestResult)} method does not provide this feature

      * unfortunately.

      *  

      * @see TestSetup#run(TestResult)

      */

     {

         {

             {

                 {

                 }

                 finally

                 {

                 }

             }

         };

     }  

     /**

      * Start an embedded Jetty server. It is allowed to pass a Jetty XML as

      * a system property (<code>cactus.jetty.config</code>) to further 

      * configure Jetty. Example: 

      * <code>-Dcactus.jetty.config=./jetty.xml</code>.

      *

      * @exception Exception if an error happens during initialization

      */

     {

         // Note: We are currently using reflection in order not to need Jetty

         // to compile Cactus. If the code becomes more complex or we need to 

         // add other initializer, it will be worth considering moving them

         // to a separate "extension" subproject which will need additional jars

         // in its classpath (using the same mechanism as the Ant project is

         // using to conditionally compile tasks).

         // Create configuration objects

         // Create a Jetty Server object and configure a listener

         // Create a Jetty context.

         // Add the Cactus Servlet redirector

         // Add the Cactus Jsp redirector

         // Add the Cactus Filter redirector

         // Configure Jetty with an XML file if one has been specified on the

         // command line.

         {

                 new Class[] {String.class}).invoke(

                     this.server, new Object[] {getConfigFile().toString()});

         }

         // Start the Jetty server

             this.server, null);

     }

     /**

      * Stop the running Jetty server.

      * 

      * @exception Exception if an error happens during the shutdown

      */

     { 

         { 

             // First, verify if the server is running

                 "isStarted", null).invoke(this.server, null)).booleanValue(); 

             // Stop the Jetty server, if started

             {

                     this.server, null);

             }

         } 

     }

     /**

      * Sets the configuration file to use for initializing Jetty.

      * 

      * @param theConfigFile The configuration file to set

      */

     {

     }

     /**

      * Sets the directory in which Jetty will look for the web-application

      * resources.

      * 

      * @param theResourceDir The resource directory to set

      */

     {

     }

     /**

      * @return The resource directory, or <code>null</code> if it has not been

      *         set

      */

     {

         {

                 CACTUS_JETTY_CONFIG_PROPERTY);

             {

             }

         }

     }

     /**

      * @return The resource directory, or <code>null</code> if it has not been

      *         set

      */

     {

         {

                 CACTUS_JETTY_RESOURCE_DIR_PROPERTY);

             {

             }

         }

     }

     /**

      * Create a Jetty server object and configures a listener on the

      * port defined in the Cactus context URL property.

      * 

      * @param theConfiguration the base Cactus configuration

      * @return the Jetty <code>Server</code> object

      * 

      * @exception Exception if an error happens during initialization

      */

         throws Exception

     {

         // Create Jetty Server object

             "org.mortbay.jetty.Server", this.getClass());

         // Add a listener on the port defined in the Cactus configuration

             new Class[] {String.class})

             .invoke(server, new Object[] {"" + contextURL.getPort()});

     }

     /**

      * Create a Jetty Context. We use a <code>WebApplicationContext</code>

      * because we need to use Servlet Filters.

      * 

      * @param theServer the Jetty Server object

      * @param theConfiguration the base Cactus configuration

      * @return Object the <code>WebApplicationContext</code> object

      * 

      * @exception Exception if an error happens during initialization

      */

         Configuration theConfiguration) throws Exception

     {

         // Add a web application. This creates a WebApplicationContext.

         // Note: We do not put any WEB-INF/, lib/ nor classes/ directory

         // in the webapp.

         {

                 new Class[] {String.class, String.class})

                 .invoke(theServer, new Object[] {contextURL.getPath(), 

                     getResourceDir().toString()});

         }

         // Retrieves the WebApplication context created by the

         // "addWebApplication". We need it to be able to manually configure

         // other items in the context.

             "getContext", new Class[] {String.class})

             .invoke(theServer, new Object[] {contextURL.getPath()});

     }

     /**

      * Adds the Cactus Servlet redirector configuration

      * 

      * @param theContext the Jetty context under which to add the configuration

      * @param theConfiguration the Cactus Servlet configuration

      * 

      * @exception Exception if an error happens during initialization

      */

         ServletConfiguration theConfiguration) throws Exception

     {

             new Class[] {String.class, String.class, String.class})

             .invoke(theContext, 

             new Object[] {theConfiguration.getDefaultRedirectorName(),

             "/" + theConfiguration.getDefaultRedirectorName(), 

             ServletTestRedirector.class.getName()});

     }

     /**

      * Adds the Cactus Jsp redirector configuration. We only add it if the

      * CACTUS_JETTY_RESOURCE_DIR_PROPERTY has been provided by the user. This

      * is because JSPs need to be attached to a WebApplicationHandler in Jetty.

      * 

      * @param theContext the Jetty context under which to add the configuration

      * 

      * @exception Exception if an error happens during initialization

      */

     {

         {

                 new Class[] {String.class, String.class})

                 .invoke(theContext, 

                 new Object[] {"*.jsp", 

                 "org.apache.jasper.servlet.JspServlet"});

             // Get the WebApplicationHandler object in order to be able to 

             // call the addServlet() method that accpets a forced path.

                 "getWebApplicationHandler", 

                 new Class[] {}).invoke(theContext, new Object[] {});

                 new Class[] {String.class, String.class, String.class, 

                     String.class})

                 .invoke(handler, 

                 new Object[] {

                     "JspRedirector",

                     "/JspRedirector",

                     "org.apache.jasper.servlet.JspServlet",

                     "/jspRedirector.jsp"});

         }

     }

     /**

      * Adds the Cactus Filter redirector configuration. We only add it if the

      * CACTUS_JETTY_RESOURCE_DIR_PROPERTY has been provided by the user. This

      * is because Filters need to be attached to a WebApplicationHandler in 

      * Jetty.

      * 

      * @param theContext the Jetty context under which to add the configuration

      * @param theConfiguration the Cactus Filter configuration

      * 

      * @exception Exception if an error happens during initialization

      */

         FilterConfiguration theConfiguration) throws Exception

     {

         {

             // Get the WebApplicationHandler object in order to be able to add

             // the Cactus Filter redirector

                 "getWebApplicationHandler", 

                 new Class[] {}).invoke(theContext, new Object[] {});

                 new Class[] {String.class, String.class})

                 .invoke(handler, 

                 new Object[] {theConfiguration.getDefaultRedirectorName(),

                 FilterTestRedirector.class.getName()});        

                 new Class[] {String.class})

                 .invoke(filterHolder, new Object[] {"REQUEST"});        

             // Map the Cactus Filter redirector to a path

                 new Class[] {String.class, String.class})

                 .invoke(handler, 

                 new Object[] {"/" 

                 + theConfiguration.getDefaultRedirectorName(),

                 theConfiguration.getDefaultRedirectorName()});

         }

     }

 }