/*

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

  *

  * 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.util;

 import java.net.URL;

 import java.util.Vector;

 import org.apache.cactus.Cookie;

 import org.apache.cactus.ServletURL;

 import org.apache.cactus.WebRequest;

 import org.apache.cactus.client.ClientException;

 import org.apache.commons.httpclient.Header;

 import org.apache.commons.httpclient.HttpState;

 import org.apache.commons.httpclient.cookie.CookiePolicy;

 import org.apache.commons.httpclient.cookie.CookieSpec;

 import org.apache.commons.logging.Log;

 import org.apache.commons.logging.LogFactory;

 /**

  * Utility methods to manipulate cookies and transform Cactus cookie objects 

  * to HttpClient cookie objects.

  *

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

  * @version $Id: CookieUtil.java,v 1.3 2003/06/22 19:20:10 vmassol Exp $

  * @since 1.5

  */

 {

     /**

      * The logger

      */

     private static final Log LOGGER = LogFactory.getLog(CookieUtil.class);

     /**

      * Returns the domain that will be used to send the cookies. If a host

      * was specified using <code>setURL()</code> then the domain will be

      * this host. Otherwise it will be the real redirector host.

      *

      * @param theRequest the request containing all data to pass to the server

      *        redirector.

      * @param theRealHost the real host to which we are connecting to. We will

      *        use it if no simulation host has been specified.

      * @return the cookie domain to use

      */

         String theRealHost)

     {

         {

         }

         else

         {

         }

     }

     /**

      * Returns the port that will be used to send the cookies. If a port

      * was specified using <code>setURL()</code> then the port sent will be

      * this port. Otherwise it will be the real redirector port.

      *

      * @param theRequest the request containing all data to pass to the server

      *        redirector.

      * @param theRealPort the real port to which we are connecting to. We will

      *        use it if no simulation port has been specified.

      * @return the cookie domain to use

      */

     {

         {

         }

         else

         {

         }

     }

     /**

      * Returns the path that will be used to validate if a cookie will be

      * sent or not. The algorithm is as follows : if the cookie path is not

      * set (i.e. null) then the cookie is always sent (provided the domain

      * is right). If the cookie path is set, the cookie is sent only if

      * the request path starts with the same string as the cookie path. If

      * <code>setURL()</code> has been called, return the path it has been

      * set to (context + servletPath + pathInfo). Otherwise return the

      * real redirector path.

      *

      * @param theRequest the request containing all data to pass to the server

      *        redirector.

      * @param theRealPath the real path to which we are connecting to. We will

      *        use it if no simulation path has been specified.

      * @return the path to use to decide if a cookie will get sent

      */

         String theRealPath)

     {

         {

         }

         else

         {

             {

                 {

                 }

                 else

                 {

                 }

             }

             else

             {

             }

         }

     }

     /**

      * Create a Commons-HttpClient cookie from a Cactus cookie, with information

      * from the web request and the URL.

      * 

      * @param theRequest The request

      * @param theUrl The URL

      * @param theCactusCookie The Cactus Cookie object

      * @return The HttpClient cookie

      */

         WebRequest theRequest, URL theUrl, Cookie theCactusCookie)

     {

         // If no domain has been specified, use a default one

         {

         }

         else

         {

         }

         // If not path has been specified , use a default one

         {

         }

         else

         {

         }

         // Assemble the HttpClient cookie

             new org.apache.commons.httpclient.Cookie(domain,

                 theCactusCookie.getName(), theCactusCookie.getValue());

             theCactusCookie.getExpiryDate());

     }

     /**

      * Transforms an array of Cactus cookies into an array of Commons-HttpClient

      * cookies, using information from the request and URL.

      * 

      * @param theRequest The request

      * @param theUrl The URL

      * @return The array of HttpClient cookies

      */

     public static org.apache.commons.httpclient.Cookie[] 

     {

         // transform the Cactus cookies into HttpClient cookies

             new org.apache.commons.httpclient.Cookie[cactusCookies.size()];

         {

                 theRequest, theUrl, cactusCookie);

         }

     }

     /**

      * Create a HttpClient {@link Header} for cookies that matches

      * the domain and path.

      * 

      * @param theDomain the cookie domain to match

      * @param thePath the cookie path to match

      * @param theCookies the list of potential cookies

      * @return the HttpClient {@link Header} containing the matching 

      *         cookies

      * @throws ClientException if no cookie was matching the domain

      *         and path

      */

         org.apache.commons.httpclient.Cookie[] theCookies)

         throws ClientException

     {

         // separate domain into host and port

         {

         }

             matcher.match(host, port, thePath, false, theCookies);

         {

         }

         {

                 + "domain = [" + theDomain + ", path = [" + thePath

                 + ", cookies = [" + theCookies + "]]. Turn on HttpClient "

                 + "logging for more information about the error"); 

         }

     }

     /**

      * @return the cookie string which will be added as a HTTP "Cookie" header

      *         or null if no cookie has been set

      * @param theRequest the request containing all data to pass to the server

      *        redirector.

      * @param theUrl the URL to connect to

      * @throws ClientException if an error occurred when creating the cookie

      *         string

      */

         throws ClientException

     {

         // If no Cookies, then exit

         {

             // transform the Cactus cookies into HttpClient cookies

                 CookieUtil.createHttpClientCookies(theRequest, theUrl);

             // and create the cookie header to send

                 CookieUtil.getCookieDomain(theRequest, theUrl.getHost()), 

                 CookieUtil.getCookiePath(theRequest, theUrl.getFile()), 

                 httpclientCookies);

         }

     }

     /**

      * Create an HttpClient {@link HttpState} object containing all cookies 

      * stored in the passed {@link WebRequest} object.

      *

      * @param theRequest the request containing the cookies to use when calling

      *        the server side

      * @param theUrl the URL to connect to

      * @return an HttpClient {@link HttpState} object which has been set with

      *         the cookies

      */

         URL theUrl)

     {

             theUrl));

     }

 }