alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  
/*
 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpState.java,v 1.22.2.3 2003/10/29 03:08:49 mbecke Exp $
 * $Revision: 1.22.2.3 $
 * $Date: 2003/10/29 03:08:49 $
 *
 * ====================================================================
 *
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999-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", "Commons", 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
 * .
 *
 * [Additional notices, if required by prior licensing conditions]
 *
 */

package org.apache.commons.httpclient;

import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import java.util.List;
import java.util.Iterator;
import org.apache.commons.httpclient.cookie.CookieSpec;
import org.apache.commons.httpclient.cookie.CookiePolicy;
import org.apache.commons.httpclient.auth.HttpAuthRealm; 
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * 

* A container for HTTP attributes that may persist from request * to request, such as {@link Cookie cookies} and authentication * {@link Credentials credentials}. *

*

* Preemptive authentication can be turned on by using the property value of * #PREEMPTIVE_PROPERTY. If left unspecified, it has the default value of * #PREEMPTIVE_DEFAULT. This configurable behaviour conforms to rcf2617: *

* * @author Remy Maucherat * @author Rodney Waldhoff * @author Jeff Dever * @author Sean C. Sullivan * @author Michael Becke * @author Oleg Kalnichevski * @author Mike Bowler * @author Adrian Sutton * * @version $Revision: 1.22.2.3 $ $Date: 2003/10/29 03:08:49 $ * */ public class HttpState { // ----------------------------------------------------- Instance Variables /** * Whether authentication should be attempted preemptively. */ private boolean preemptive; /** * The boolean property name to turn on preemptive authentication. */ public static final String PREEMPTIVE_PROPERTY = "httpclient.authentication.preemptive"; /** * The default property value for #PREEMPTIVE_PROPERTY. */ public static final String PREEMPTIVE_DEFAULT = "false"; /** * Map of {@link Credentials credentials} by realm that this * HTTP state contains. */ private HashMap credMap = new HashMap(); /** * Map of {@link Credentials proxy credentials} by realm that this * HTTP state contains */ private HashMap proxyCred = new HashMap(); /** * The default authentication realm. */ public static final HttpAuthRealm DEFAULT_AUTH_REALM = new HttpAuthRealm(null, null); /** * Array of {@link Cookie cookies} that this HTTP state contains. */ private ArrayList cookies = new ArrayList(); /** * Cookie policy that applies to this HTTP state. Default is * {@link CookiePolicy#RFC2109} */ private int cookiePolicy = CookiePolicy.RFC2109; /** The current connection manager */ private HttpConnectionManager httpConnectionManager; // -------------------------------------------------------- Class Variables /** Log object for this class. */ private static final Log LOG = LogFactory.getLog(HttpState.class); /** * Default constructor. */ public HttpState() { super(); this.cookiePolicy = CookiePolicy.getDefaultPolicy(); // check the preemptive policy String preemptiveDefault = null; try { preemptiveDefault = System.getProperty(PREEMPTIVE_PROPERTY); } catch (SecurityException ignore) { } if (preemptiveDefault == null) { preemptiveDefault = PREEMPTIVE_DEFAULT; } preemptiveDefault = preemptiveDefault.trim().toLowerCase(); if (!(preemptiveDefault.equals("true") || preemptiveDefault.equals("false"))) { // property problem LOG.warn("Configuration property " + PREEMPTIVE_PROPERTY + " must be either true or false. Using default: " + PREEMPTIVE_DEFAULT); preemptiveDefault = PREEMPTIVE_DEFAULT; } this.preemptive = ("true".equals(preemptiveDefault)); } // ------------------------------------------------------------- Properties /** * Adds an {@link Cookie HTTP cookie}, replacing any existing equivalent cookies. * If the given cookie has already expired it will not be added, but existing * values will still be removed. * * @param cookie the {@link Cookie cookie} to be added * * @see #addCookies(Cookie[]) * */ public synchronized void addCookie(Cookie cookie) { LOG.trace("enter HttpState.addCookie(Cookie)"); if (cookie != null) { // first remove any old cookie that is equivalent for (Iterator it = cookies.iterator(); it.hasNext();) { Cookie tmp = (Cookie) it.next(); if (cookie.equals(tmp)) { it.remove(); break; } } if (!cookie.isExpired()) { cookies.add(cookie); } } } /** * Adds an array of {@link Cookie HTTP cookies}. Cookies are added individually and * in the given array order. If any of the given cookies has already expired it will * not be added, but existing values will still be removed. * * @param cookies the {@link Cookie cookies} to be added * * @see #addCookie(Cookie) * */ public synchronized void addCookies(Cookie[] cookies) { LOG.trace("enter HttpState.addCookies(Cookie[])"); if (cookies != null) { for (int i = 0; i < cookies.length; i++) { this.addCookie(cookies[i]); } } } /** * Returns an array of {@link Cookie cookies} that this HTTP * state currently contains. * * @return an array of {@link Cookie cookies}. * * @see #getCookies(String, int, String, boolean, java.util.Date) * */ public synchronized Cookie[] getCookies() { LOG.trace("enter HttpState.getCookies()"); return (Cookie[]) (cookies.toArray(new Cookie[cookies.size()])); } /** * Returns an array of {@link Cookie cookies} in this HTTP * state that match the given request parameters. * * @param domain the request domain * @param port the request port * @param path the request path * @param secure true when using HTTPS * @param now the {@link Date date} by which expiration is determined * * @return an array of {@link Cookie cookies}. * * @see #getCookies() * * @deprecated use CookieSpec#match(String, int, String, boolean, Cookie) */ public synchronized Cookie[] getCookies( String domain, int port, String path, boolean secure, Date now ) { return getCookies(domain, port, path, secure); } /** * Returns an array of {@link Cookie cookies} in this HTTP * state that match the given request parameters. * * @param domain the request domain * @param port the request port * @param path the request path * @param secure true when using HTTPS * * @return an array of {@link Cookie cookies}. * * @see #getCookies() * * @deprecated use {@link CookieSpec#match(String, int, String, boolean, Cookie)} */ public synchronized Cookie[] getCookies( String domain, int port, String path, boolean secure ) { LOG.trace("enter HttpState.getCookies(String, int, String, boolean)"); CookieSpec matcher = CookiePolicy.getDefaultSpec(); ArrayList list = new ArrayList(cookies.size()); for (int i = 0, m = cookies.size(); i < m; i++) { Cookie cookie = (Cookie) (cookies.get(i)); if (matcher.match(domain, port, path, secure, cookie)) { list.add(cookie); } } return (Cookie[]) (list.toArray(new Cookie[list.size()])); } /** * Removes all of {@link Cookie cookies} in this HTTP state * that have expired according to the current system time. * * @see #purgeExpiredCookies(java.util.Date) * */ public synchronized boolean purgeExpiredCookies() { LOG.trace("enter HttpState.purgeExpiredCookies()"); return purgeExpiredCookies(new Date()); } /** * Removes all of {@link Cookie cookies} in this HTTP state * that have expired by the specified {@link java.util.Date date}. * * @param date The {@link java.util.Date date} to compare against. * * @return true if any cookies were purged. * * @see Cookie#isExpired(java.util.Date) * * @see #purgeExpiredCookies() */ public synchronized boolean purgeExpiredCookies(Date date) { LOG.trace("enter HttpState.purgeExpiredCookies(Date)"); boolean removed = false; Iterator it = cookies.iterator(); while (it.hasNext()) { if (((Cookie) (it.next())).isExpired(date)) { it.remove(); removed = true; } } return removed; } /** * Returns the current {@link CookiePolicy cookie policy} for this * HTTP state. * * @return The {@link CookiePolicy cookie policy}. */ public int getCookiePolicy() { return this.cookiePolicy; } /** * Defines whether preemptive authentication should be * attempted. * * @param value true if preemptive authentication should be * attempted, false otherwise. */ public void setAuthenticationPreemptive(boolean value) { this.preemptive = value; } /** * Returns true if preemptive authentication should be * attempted, false otherwise. * * @return boolean flag. */ public boolean isAuthenticationPreemptive() { return this.preemptive; } /** * Sets the current {@link CookiePolicy cookie policy} for this HTTP * state to one of the following supported policies: * {@link CookiePolicy#COMPATIBILITY}, * {@link CookiePolicy#NETSCAPE_DRAFT} or * {@link CookiePolicy#RFC2109}. * * @param policy new {@link CookiePolicy cookie policy} */ public void setCookiePolicy(int policy) { this.cookiePolicy = policy; } /** * Sets the {@link Credentials credentials} for the given authentication * realm. The null realm signifies default credentials, which * should be used when no {@link Credentials credentials} have been explictly * supplied for the given challenging realm. Any previous credentials for * the given realm will be overwritten. * * @deprecated This method does not distinguish between realms with the * same name on different hosts. * Use {@link #setCredentials(String, String, Credentials)} instead. * * @param realm the authentication realm * @param credentials the authentication credentials for the given realm * * @see #getCredentials(String, String) * @see #setProxyCredentials(String, String, Credentials) */ public synchronized void setCredentials(String realm, Credentials credentials) { LOG.trace("enter HttpState.setCredentials(String, Credentials)"); setCredentials(realm, null, credentials); } /** * Sets the {@link Credentials credentials} for the given authentication * realm on the given host. The null realm signifies default * credentials for the given host, which should be used when no * {@link Credentials credentials} have been explictly supplied for the * challenging realm. The null host signifies default * credentials, which should be used when no {@link Credentials credentials} * have been explictly supplied for the challenging host. Any previous * credentials for the given realm on the given host will be overwritten. * * @param realm the authentication realm * @param host the host the realm belongs to * @param credentials the authentication {@link Credentials credentials} * for the given realm. * * @see #getCredentials(String, String) * @see #setProxyCredentials(String, String, Credentials) */ public synchronized void setCredentials(String realm, String host, Credentials credentials) { LOG.trace( "enter HttpState.setCredentials(String realm, String host, Credentials credentials)"); credMap.put(new HttpAuthRealm(host, realm), credentials); } /** * Find matching {@link Credentials credentials} for the given authentication realm and host. * * If the realm exists on host, return the coresponding credentials. * If the host exists with a null realm, return the corresponding * credentials. * If the realm exists with a null host, return the * corresponding credentials. If the realm does not exist, return * the default Credentials. If there are no default credentials, return * null. * * @param map the credentials hash map * @param realm the authentication realm * @param host the host the realm is on * @return the credentials * */ private static Credentials matchCredentials(HashMap map, String realm, String host) { HttpAuthRealm entry = new HttpAuthRealm(host, realm); Credentials creds = (Credentials) map.get(entry); if (creds == null && host != null && realm != null) { entry = new HttpAuthRealm(host, null); creds = (Credentials) map.get(entry); if (creds == null) { entry = new HttpAuthRealm(null, realm); creds = (Credentials) map.get(entry); } } if (creds == null) { creds = (Credentials) map.get(DEFAULT_AUTH_REALM); } return creds; } /** * Get the {@link Credentials credentials} for the given authentication realm on the * given host. * * If the realm exists on host, return the coresponding credentials. * If the host exists with a null realm, return the corresponding * credentials. * If the realm exists with a null host, return the * corresponding credentials. If the realm does not exist, return * the default Credentials. If there are no default credentials, return * null. * * @param realm the authentication realm * @param host the host the realm is on * @return the credentials * * @see #setCredentials(String, String, Credentials) */ public synchronized Credentials getCredentials(String realm, String host) { LOG.trace("enter HttpState.getCredentials(String, String"); return matchCredentials(this.credMap, realm, host); } /** * Get the {@link Credentials credentials} for the given authentication realm. * * @deprecated This method does not distinguish between realms on different * servers with the same name. Use {@link #getCredentials(String, String)} * instead. * * @param realm the authentication realm * @return the credentials * * @see #setCredentials(String, String, Credentials) * */ public synchronized Credentials getCredentials(String realm) { LOG.trace("enter HttpState.getCredentials(String)"); return getCredentials(realm, null); } /** * Sets the {@link Credentials credentials} for the given proxy authentication * realm. The null realm signifies default credentials, which * should be used when no {@link Credentials credentials} have been explictly * supplied for the given challenging proxy realm. Any previous credentials for * the given realm will be overwritten. * * @deprecated This method does not differentiate between realms with * the same name on different servers. Use * {@link #setProxyCredentials(String, String, Credentials)} instead. * * @param realm the authentication realm * @param credentials the authentication credentials for the given realm * * @see #getProxyCredentials(String) * @see #setCredentials(String, Credentials) * */ public synchronized void setProxyCredentials(String realm, Credentials credentials) { LOG.trace("enter HttpState.setProxyCredentials(String, credentials)"); setProxyCredentials(realm, null, credentials); } /** * Sets the {@link Credentials credentials} for the given proxy authentication * realm on the given proxy host. The null proxy realm signifies * default credentials for the given proxy host, which should be used when no * {@link Credentials credentials} have been explictly supplied for the * challenging proxy realm. The null proxy host signifies default * credentials, which should be used when no {@link Credentials credentials} * have been explictly supplied for the challenging proxy host. Any previous * credentials for the given proxy realm on the given proxy host will be * overwritten. * * @param realm the authentication realm * @param proxyHost the proxy host * @param credentials the authentication credentials for the given realm * * @see #getProxyCredentials(String) * @see #setCredentials(String, Credentials) * */ public synchronized void setProxyCredentials( String realm, String proxyHost, Credentials credentials ) { LOG.trace("enter HttpState.setProxyCredentials(String, String, Credentials"); proxyCred.put(new HttpAuthRealm(proxyHost, realm), credentials); } /** * Get the {@link Credentials credentials} for the given * proxy authentication realm. * * If the realm exists, return the coresponding credentials. If the * realm does not exist, return the default Credentials. If there is * no default credentials, return null. * * @deprecated This method does not distinguish between realms on different hosts. * Use {@link #getProxyCredentials(String, String)} instead. * * @param realm the authentication realm * @return the credentials * @see #setProxyCredentials(String, String, Credentials) */ public synchronized Credentials getProxyCredentials(String realm) { LOG.trace("enter HttpState.getProxyCredentials(String)"); return getProxyCredentials(realm, null); } /** * Get the {@link Credentials credentials} for the proxy host with the given * authentication realm. * * If the realm exists on host, return the coresponding credentials. * If the host exists with a null realm, return the corresponding * credentials. * If the realm exists with a null host, return the * corresponding credentials. If the realm does not exist, return * the default Credentials. If there are no default credentials, return * null. * * @param realm the authentication realm * @param proxyHost the proxy host the realm is on * @return the credentials * @see #setProxyCredentials(String, String, Credentials) */ public synchronized Credentials getProxyCredentials(String realm, String proxyHost) { LOG.trace("enter HttpState.getCredentials(String, String"); return matchCredentials(this.proxyCred, realm, proxyHost); } /** * Returns a string representation of this HTTP state. * * @return The string representation of the HTTP state. * * @see java.lang.Object#toString() */ public synchronized String toString() { StringBuffer sbResult = new StringBuffer(); sbResult.append("["); sbResult.append(getProxyCredentialsStringRepresentation(proxyCred)); sbResult.append(" | "); sbResult.append(getCredentialsStringRepresentation(proxyCred)); sbResult.append(" | "); sbResult.append(getCookiesStringRepresentation(cookies)); sbResult.append("]"); String strResult = sbResult.toString(); return strResult; } /** * Returns a string representation of the proxy credentials * @param proxyCredMap The proxy credentials * @return The string representation. */ private static String getProxyCredentialsStringRepresentation(final Map proxyCredMap) { StringBuffer sbResult = new StringBuffer(); Iterator iter = proxyCredMap.keySet().iterator(); while (iter.hasNext()) { Object key = iter.next(); Credentials cred = (Credentials) proxyCredMap.get(key); if (sbResult.length() > 0) { sbResult.append(", "); } sbResult.append(key); sbResult.append("#"); sbResult.append(cred.toString()); } return sbResult.toString(); } /** * Returns a string representation of the credentials. * @param credMap The credentials. * @return The string representation. */ private static String getCredentialsStringRepresentation(final Map credMap) { StringBuffer sbResult = new StringBuffer(); Iterator iter = credMap.keySet().iterator(); while (iter.hasNext()) { Object key = iter.next(); Credentials cred = (Credentials) credMap.get(key); if (sbResult.length() > 0) { sbResult.append(", "); } sbResult.append(key); sbResult.append("#"); sbResult.append(cred.toString()); } return sbResult.toString(); } /** * Return a string representation of the cookies. * @param cookies The cookies * @return The string representation. */ private static String getCookiesStringRepresentation(final List cookies) { StringBuffer sbResult = new StringBuffer(); Iterator iter = cookies.iterator(); while (iter.hasNext()) { Cookie ck = (Cookie) iter.next(); if (sbResult.length() > 0) { sbResult.append("#"); } sbResult.append(ck.toExternalForm()); } return sbResult.toString(); } /** * Returns the httpConnectionManager. * @return HttpConnectionManager * * @deprecated Connection manager is controlled by the HttpClient class. * Use {@link HttpClient#getHttpConnectionManager()} instead. * * @since 2.0 */ public synchronized HttpConnectionManager getHttpConnectionManager() { return httpConnectionManager; } /** * Sets the httpConnectionManager. * @param httpConnectionManager The httpConnectionManager to set * * @deprecated Connection manager is controlled by the HttpClient class. * Use {@link HttpClient#setHttpConnectionManager(HttpConnectionManager)} instead. * * @since 2.0 */ public synchronized void setHttpConnectionManager( HttpConnectionManager httpConnectionManager ) { this.httpConnectionManager = httpConnectionManager; } }
... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.