vmassol 2003/06/22 08:03:55
Modified: framework/src/java/share/org/apache/cactus/client/connector/http
AbstractConnectionHelper.java
JdkConnectionHelper.java
HttpClientConnectionHelper.java
framework/src/java/share/org/apache/cactus Cookie.java
WebResponse.java
Added: framework/src/java/share/org/apache/cactus/util
CookieUtil.java
Removed: framework/src/java/share/org/apache/cactus/client/connector/http
CookieUtil.java
Log:
Moved all Cookie utility methods to o.a.c.util.CookieUtil
Revision Changes Path
1.6 +1 -162
jakarta-cactus/framework/src/java/share/org/apache/cactus/client/connector/http/AbstractConnectionHelper.java
Index: AbstractConnectionHelper.java
===================================================================
RCS file:
/home/cvs/jakarta-cactus/framework/src/java/share/org/apache/cactus/client/connector/http/AbstractConnectionHelper.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- AbstractConnectionHelper.java 22 Jun 2003 14:53:58 -0000 1.5
+++ AbstractConnectionHelper.java 22 Jun 2003 15:03:54 -0000 1.6
@@ -61,14 +61,8 @@
import java.net.URLEncoder;
import java.util.Enumeration;
-import java.util.Vector;
-import org.apache.cactus.Cookie;
import org.apache.cactus.WebRequest;
-import org.apache.cactus.client.ClientException;
-import org.apache.commons.httpclient.Header;
-import org.apache.commons.httpclient.cookie.CookiePolicy;
-import org.apache.commons.httpclient.cookie.CookieSpec;
/**
* Common helper methods for implementing <code>ConnectionHelper</code>. These
@@ -155,159 +149,4 @@
return new URL(theURL.getProtocol(), theURL.getHost(),
theURL.getPort(), file);
}
-
- /**
- * @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
- */
- public String getCookieString(WebRequest theRequest, URL theUrl)
- throws ClientException
- {
- // If no Cookies, then exit
- Vector cookies = theRequest.getCookies();
-
- if (!cookies.isEmpty())
- {
- // transform the Cactus cookies into HttpClient cookies
- org.apache.commons.httpclient.Cookie[] httpclientCookies =
- createHttpClientCookies(theRequest, theUrl);
-
- // and create the cookie header to send
- Header cookieHeader = createCookieHeader(
- CookieUtil.getCookieDomain(theRequest, theUrl.getHost()),
- CookieUtil.getCookiePath(theRequest, theUrl.getFile()),
- httpclientCookies);
-
- return cookieHeader.getValue();
- }
-
- return null;
- }
-
- /**
- * 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
- */
- protected org.apache.commons.httpclient.Cookie[] createHttpClientCookies(
- WebRequest theRequest, URL theUrl)
- {
- Vector cactusCookies = theRequest.getCookies();
-
- // transform the Cactus cookies into HttpClient cookies
- org.apache.commons.httpclient.Cookie[] httpclientCookies =
- new org.apache.commons.httpclient.Cookie[cactusCookies.size()];
-
- for (int i = 0; i < cactusCookies.size(); i++)
- {
- Cookie cactusCookie = (Cookie) cactusCookies.elementAt(i);
- httpclientCookies[i] =
- createHttpClientCookie(theRequest, theUrl, cactusCookie);
- }
-
- return httpclientCookies;
- }
-
- /**
- * 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
- */
- protected org.apache.commons.httpclient.Cookie createHttpClientCookie(
- WebRequest theRequest, URL theUrl, Cookie theCactusCookie)
- {
- // If no domain has been specified, use a default one
- String domain;
- if (theCactusCookie.getDomain() == null)
- {
- domain = CookieUtil.getCookieDomain(theRequest, theUrl.getHost());
- }
- else
- {
- domain = theCactusCookie.getDomain();
- }
-
- // If not path has been specified , use a default one
- String path;
- if (theCactusCookie.getPath() == null)
- {
- path = CookieUtil.getCookiePath(theRequest, theUrl.getFile());
- }
- else
- {
- path = theCactusCookie.getPath();
- }
-
- // Assemble the HttpClient cookie
- org.apache.commons.httpclient.Cookie httpclientCookie =
- new org.apache.commons.httpclient.Cookie(domain,
- theCactusCookie.getName(), theCactusCookie.getValue());
- httpclientCookie.setComment(theCactusCookie.getComment());
- httpclientCookie.setExpiryDate(
- theCactusCookie.getExpiryDate());
- httpclientCookie.setPath(path);
- httpclientCookie.setSecure(theCactusCookie.isSecure());
-
- return httpclientCookie;
- }
-
- /**
- * Create a HttpClient [EMAIL PROTECTED] 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 [EMAIL PROTECTED] Header} containing the matching
- * cookies
- * @throws ClientException if no cookie was matching the domain
- * and path
- */
- private Header createCookieHeader(String theDomain, String thePath,
- org.apache.commons.httpclient.Cookie[] theCookies)
- throws ClientException
- {
- Header cookieHeader = null;
-
- // separate domain into host and port
- int port = 80;
- String host = theDomain;
- int portIndex = theDomain.indexOf(":");
- if (portIndex != -1)
- {
- host = host.substring(0, portIndex);
- port = Integer.parseInt(theDomain.substring(portIndex + 1));
- }
-
- CookieSpec matcher = CookiePolicy.getDefaultSpec();
- org.apache.commons.httpclient.Cookie[] cookies =
- matcher.match(host, port, thePath, false, theCookies);
- if ((cookies != null) && (cookies.length > 0))
- {
- cookieHeader = matcher.formatCookieHeader(cookies);
- }
-
- if (cookieHeader == null)
- {
- throw new ClientException("Failed to create Cookie header for ["
- + "domain = [" + theDomain + ", path = [" + thePath
- + ", cookies = [" + theCookies + "]]. Turn on HttpClient "
- + "logging for more information about the error");
- }
-
- return cookieHeader;
- }
-
}
1.5 +3 -2
jakarta-cactus/framework/src/java/share/org/apache/cactus/client/connector/http/JdkConnectionHelper.java
Index: JdkConnectionHelper.java
===================================================================
RCS file:
/home/cvs/jakarta-cactus/framework/src/java/share/org/apache/cactus/client/connector/http/JdkConnectionHelper.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- JdkConnectionHelper.java 15 Jun 2003 16:27:59 -0000 1.4
+++ JdkConnectionHelper.java 22 Jun 2003 15:03:54 -0000 1.5
@@ -72,6 +72,7 @@
import org.apache.cactus.client.authentication.Authentication;
import org.apache.cactus.configuration.Configuration;
import org.apache.cactus.util.ChainedRuntimeException;
+import org.apache.cactus.util.CookieUtil;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
@@ -162,7 +163,7 @@
addHeaders(theRequest, connection);
// Add the cookies
- String cookieString = getCookieString(theRequest, url);
+ String cookieString = CookieUtil.getCookieString(theRequest, url);
if (cookieString != null)
{
1.6 +3 -2
jakarta-cactus/framework/src/java/share/org/apache/cactus/client/connector/http/HttpClientConnectionHelper.java
Index: HttpClientConnectionHelper.java
===================================================================
RCS file:
/home/cvs/jakarta-cactus/framework/src/java/share/org/apache/cactus/client/connector/http/HttpClientConnectionHelper.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- HttpClientConnectionHelper.java 15 Jun 2003 16:27:59 -0000 1.5
+++ HttpClientConnectionHelper.java 22 Jun 2003 15:03:54 -0000 1.6
@@ -68,6 +68,7 @@
import org.apache.cactus.WebRequest;
import org.apache.cactus.client.authentication.Authentication;
import org.apache.cactus.configuration.Configuration;
+import org.apache.cactus.util.CookieUtil;
import org.apache.cactus.util.UrlUtil;
import org.apache.commons.httpclient.HostConfiguration;
import org.apache.commons.httpclient.HttpClient;
@@ -165,7 +166,7 @@
// Add the cookies
HttpState state = new HttpState();
- state.addCookies(createHttpClientCookies(theRequest, url));
+ state.addCookies(CookieUtil.createHttpClientCookies(theRequest, url));
// Open the connection and get the result
HttpClient client = new HttpClient();
1.9 +2 -2
jakarta-cactus/framework/src/java/share/org/apache/cactus/Cookie.java
Index: Cookie.java
===================================================================
RCS file:
/home/cvs/jakarta-cactus/framework/src/java/share/org/apache/cactus/Cookie.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- Cookie.java 22 Jun 2003 14:53:58 -0000 1.8
+++ Cookie.java 22 Jun 2003 15:03:54 -0000 1.9
@@ -60,7 +60,7 @@
import java.util.Date;
-import org.apache.cactus.client.connector.http.CookieUtil;
+import org.apache.cactus.util.CookieUtil;
/**
* Client cookie. Used for manipulating client cookies either in
1.14 +2 -2
jakarta-cactus/framework/src/java/share/org/apache/cactus/WebResponse.java
Index: WebResponse.java
===================================================================
RCS file:
/home/cvs/jakarta-cactus/framework/src/java/share/org/apache/cactus/WebResponse.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- WebResponse.java 22 Jun 2003 14:53:58 -0000 1.13
+++ WebResponse.java 22 Jun 2003 15:03:54 -0000 1.14
@@ -65,8 +65,8 @@
import java.util.Vector;
-import org.apache.cactus.client.connector.http.CookieUtil;
import org.apache.cactus.util.ChainedRuntimeException;
+import org.apache.cactus.util.CookieUtil;
import org.apache.cactus.util.IoUtil;
import org.apache.commons.httpclient.Header;
import org.apache.commons.httpclient.HttpException;
1.1
jakarta-cactus/framework/src/java/share/org/apache/cactus/util/CookieUtil.java
Index: CookieUtil.java
===================================================================
/*
* ====================================================================
*
* 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 [EMAIL PROTECTED]
*
* 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.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:[EMAIL PROTECTED]">Vincent Massol</a>
* @version $Id: CookieUtil.java,v 1.1 2003/06/22 15:03:55 vmassol Exp $
* @since 1.5
*/
public class CookieUtil
{
/**
* 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
*/
public static String getCookieDomain(WebRequest theRequest,
String theRealHost)
{
String domain;
ServletURL url = theRequest.getURL();
if ((url != null) && (url.getHost() != null))
{
domain = url.getHost();
}
else
{
domain = theRealHost;
}
LOGGER.debug("Cookie validation domain = [" + domain + "]");
return domain;
}
/**
* 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
*/
public static int getCookiePort(WebRequest theRequest, int theRealPort)
{
int port;
ServletURL url = theRequest.getURL();
if ((url != null) && (url.getHost() != null))
{
port = url.getPort();
}
else
{
port = theRealPort;
}
LOGGER.debug("Cookie validation port = [" + port + "]");
return port;
}
/**
* 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
*/
public static String getCookiePath(WebRequest theRequest,
String theRealPath)
{
String path;
ServletURL url = theRequest.getURL();
if ((url != null) && (url.getPath() != null))
{
path = url.getPath();
}
else
{
String file = theRealPath;
if (file != null)
{
int q = file.lastIndexOf('?');
if (q != -1)
{
path = file.substring(0, q);
}
else
{
path = file;
}
}
else
{
path = null;
}
}
LOGGER.debug("Cookie validation path = [" + path + "]");
return path;
}
/**
* 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
*/
public static org.apache.commons.httpclient.Cookie createHttpClientCookie(
WebRequest theRequest, URL theUrl, Cookie theCactusCookie)
{
// If no domain has been specified, use a default one
String domain;
if (theCactusCookie.getDomain() == null)
{
domain = CookieUtil.getCookieDomain(theRequest, theUrl.getHost());
}
else
{
domain = theCactusCookie.getDomain();
}
// If not path has been specified , use a default one
String path;
if (theCactusCookie.getPath() == null)
{
path = CookieUtil.getCookiePath(theRequest, theUrl.getFile());
}
else
{
path = theCactusCookie.getPath();
}
// Assemble the HttpClient cookie
org.apache.commons.httpclient.Cookie httpclientCookie =
new org.apache.commons.httpclient.Cookie(domain,
theCactusCookie.getName(), theCactusCookie.getValue());
httpclientCookie.setComment(theCactusCookie.getComment());
httpclientCookie.setExpiryDate(
theCactusCookie.getExpiryDate());
httpclientCookie.setPath(path);
httpclientCookie.setSecure(theCactusCookie.isSecure());
return httpclientCookie;
}
/**
* 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[]
createHttpClientCookies(WebRequest theRequest, URL theUrl)
{
Vector cactusCookies = theRequest.getCookies();
// transform the Cactus cookies into HttpClient cookies
org.apache.commons.httpclient.Cookie[] httpclientCookies =
new org.apache.commons.httpclient.Cookie[cactusCookies.size()];
for (int i = 0; i < cactusCookies.size(); i++)
{
Cookie cactusCookie = (Cookie) cactusCookies.elementAt(i);
httpclientCookies[i] = CookieUtil.createHttpClientCookie(
theRequest, theUrl, cactusCookie);
}
return httpclientCookies;
}
/**
* Create a HttpClient [EMAIL PROTECTED] 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 [EMAIL PROTECTED] Header} containing the matching
* cookies
* @throws ClientException if no cookie was matching the domain
* and path
*/
public static Header createCookieHeader(String theDomain, String thePath,
org.apache.commons.httpclient.Cookie[] theCookies)
throws ClientException
{
Header cookieHeader = null;
// separate domain into host and port
int port = 80;
String host = theDomain;
int portIndex = theDomain.indexOf(":");
if (portIndex != -1)
{
host = host.substring(0, portIndex);
port = Integer.parseInt(theDomain.substring(portIndex + 1));
}
CookieSpec matcher = CookiePolicy.getDefaultSpec();
org.apache.commons.httpclient.Cookie[] cookies =
matcher.match(host, port, thePath, false, theCookies);
if ((cookies != null) && (cookies.length > 0))
{
cookieHeader = matcher.formatCookieHeader(cookies);
}
if (cookieHeader == null)
{
throw new ClientException("Failed to create Cookie header for ["
+ "domain = [" + theDomain + ", path = [" + thePath
+ ", cookies = [" + theCookies + "]]. Turn on HttpClient "
+ "logging for more information about the error");
}
return cookieHeader;
}
/**
* @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
*/
public static String getCookieString(WebRequest theRequest, URL theUrl)
throws ClientException
{
// If no Cookies, then exit
Vector cookies = theRequest.getCookies();
if (!cookies.isEmpty())
{
// transform the Cactus cookies into HttpClient cookies
org.apache.commons.httpclient.Cookie[] httpclientCookies =
CookieUtil.createHttpClientCookies(theRequest, theUrl);
// and create the cookie header to send
Header cookieHeader = createCookieHeader(
CookieUtil.getCookieDomain(theRequest, theUrl.getHost()),
CookieUtil.getCookiePath(theRequest, theUrl.getFile()),
httpclientCookies);
return cookieHeader.getValue();
}
return null;
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
