| /* |
| * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/cookie/BasicClientCookie.java $ |
| * $Revision: 659191 $ |
| * $Date: 2008-05-22 11:26:53 -0700 (Thu, 22 May 2008) $ |
| * |
| * ==================================================================== |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * ==================================================================== |
| * |
| * 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.http.impl.cookie; |
| |
| import java.util.Date; |
| import java.util.HashMap; |
| import java.util.Locale; |
| import java.util.Map; |
| |
| import org.apache.http.cookie.ClientCookie; |
| import org.apache.http.cookie.SetCookie; |
| |
| /** |
| * HTTP "magic-cookie" represents a piece of state information |
| * that the HTTP agent and the target server can exchange to maintain |
| * a session. |
| * |
| * @author B.C. Holmes |
| * @author <a href="mailto:jericho@thinkfree.com">Park, Sung-Gu</a> |
| * @author <a href="mailto:dsale@us.britannica.com">Doug Sale</a> |
| * @author Rod Waldhoff |
| * @author dIon Gillard |
| * @author Sean C. Sullivan |
| * @author <a href="mailto:JEvans@Cyveillance.com">John Evans</a> |
| * @author Marc A. Saegesser |
| * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> |
| * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a> |
| * |
| * @version $Revision: 659191 $ |
| */ |
| public class BasicClientCookie implements SetCookie, ClientCookie, Cloneable { |
| |
| /** |
| * Default Constructor taking a name and a value. The value may be null. |
| * |
| * @param name The name. |
| * @param value The value. |
| */ |
| public BasicClientCookie(final String name, final String value) { |
| super(); |
| if (name == null) { |
| throw new IllegalArgumentException("Name may not be null"); |
| } |
| this.name = name; |
| this.attribs = new HashMap<String, String>(); |
| this.value = value; |
| } |
| |
| /** |
| * Returns the name. |
| * |
| * @return String name The name |
| */ |
| public String getName() { |
| return this.name; |
| } |
| |
| /** |
| * Returns the value. |
| * |
| * @return String value The current value. |
| */ |
| public String getValue() { |
| return this.value; |
| } |
| |
| /** |
| * Sets the value |
| * |
| * @param value |
| */ |
| public void setValue(final String value) { |
| this.value = value; |
| } |
| |
| /** |
| * Returns the comment describing the purpose of this cookie, or |
| * <tt>null</tt> if no such comment has been defined. |
| * |
| * @return comment |
| * |
| * @see #setComment(String) |
| */ |
| public String getComment() { |
| return cookieComment; |
| } |
| |
| /** |
| * If a user agent (web browser) presents this cookie to a user, the |
| * cookie's purpose will be described using this comment. |
| * |
| * @param comment |
| * |
| * @see #getComment() |
| */ |
| public void setComment(String comment) { |
| cookieComment = comment; |
| } |
| |
| |
| /** |
| * Returns null. Cookies prior to RFC2965 do not set this attribute |
| */ |
| public String getCommentURL() { |
| return null; |
| } |
| |
| |
| /** |
| * Returns the expiration {@link Date} of the cookie, or <tt>null</tt> |
| * if none exists. |
| * <p><strong>Note:</strong> the object returned by this method is |
| * considered immutable. Changing it (e.g. using setTime()) could result |
| * in undefined behaviour. Do so at your peril. </p> |
| * @return Expiration {@link Date}, or <tt>null</tt>. |
| * |
| * @see #setExpiryDate(java.util.Date) |
| * |
| */ |
| public Date getExpiryDate() { |
| return cookieExpiryDate; |
| } |
| |
| /** |
| * Sets expiration date. |
| * <p><strong>Note:</strong> the object returned by this method is considered |
| * immutable. Changing it (e.g. using setTime()) could result in undefined |
| * behaviour. Do so at your peril.</p> |
| * |
| * @param expiryDate the {@link Date} after which this cookie is no longer valid. |
| * |
| * @see #getExpiryDate |
| * |
| */ |
| public void setExpiryDate (Date expiryDate) { |
| cookieExpiryDate = expiryDate; |
| } |
| |
| |
| /** |
| * Returns <tt>false</tt> if the cookie should be discarded at the end |
| * of the "session"; <tt>true</tt> otherwise. |
| * |
| * @return <tt>false</tt> if the cookie should be discarded at the end |
| * of the "session"; <tt>true</tt> otherwise |
| */ |
| public boolean isPersistent() { |
| return (null != cookieExpiryDate); |
| } |
| |
| |
| /** |
| * Returns domain attribute of the cookie. |
| * |
| * @return the value of the domain attribute |
| * |
| * @see #setDomain(java.lang.String) |
| */ |
| public String getDomain() { |
| return cookieDomain; |
| } |
| |
| /** |
| * Sets the domain attribute. |
| * |
| * @param domain The value of the domain attribute |
| * |
| * @see #getDomain |
| */ |
| public void setDomain(String domain) { |
| if (domain != null) { |
| cookieDomain = domain.toLowerCase(Locale.ENGLISH); |
| } else { |
| cookieDomain = null; |
| } |
| } |
| |
| |
| /** |
| * Returns the path attribute of the cookie |
| * |
| * @return The value of the path attribute. |
| * |
| * @see #setPath(java.lang.String) |
| */ |
| public String getPath() { |
| return cookiePath; |
| } |
| |
| /** |
| * Sets the path attribute. |
| * |
| * @param path The value of the path attribute |
| * |
| * @see #getPath |
| * |
| */ |
| public void setPath(String path) { |
| cookiePath = path; |
| } |
| |
| /** |
| * @return <code>true</code> if this cookie should only be sent over secure connections. |
| * @see #setSecure(boolean) |
| */ |
| public boolean isSecure() { |
| return isSecure; |
| } |
| |
| /** |
| * Sets the secure attribute of the cookie. |
| * <p> |
| * When <tt>true</tt> the cookie should only be sent |
| * using a secure protocol (https). This should only be set when |
| * the cookie's originating server used a secure protocol to set the |
| * cookie's value. |
| * |
| * @param secure The value of the secure attribute |
| * |
| * @see #isSecure() |
| */ |
| public void setSecure (boolean secure) { |
| isSecure = secure; |
| } |
| |
| |
| /** |
| * Returns null. Cookies prior to RFC2965 do not set this attribute |
| */ |
| public int[] getPorts() { |
| return null; |
| } |
| |
| |
| /** |
| * Returns the version of the cookie specification to which this |
| * cookie conforms. |
| * |
| * @return the version of the cookie. |
| * |
| * @see #setVersion(int) |
| * |
| */ |
| public int getVersion() { |
| return cookieVersion; |
| } |
| |
| /** |
| * Sets the version of the cookie specification to which this |
| * cookie conforms. |
| * |
| * @param version the version of the cookie. |
| * |
| * @see #getVersion |
| */ |
| public void setVersion(int version) { |
| cookieVersion = version; |
| } |
| |
| /** |
| * Returns true if this cookie has expired. |
| * @param date Current time |
| * |
| * @return <tt>true</tt> if the cookie has expired. |
| */ |
| public boolean isExpired(final Date date) { |
| if (date == null) { |
| throw new IllegalArgumentException("Date may not be null"); |
| } |
| return (cookieExpiryDate != null |
| && cookieExpiryDate.getTime() <= date.getTime()); |
| } |
| |
| public void setAttribute(final String name, final String value) { |
| this.attribs.put(name, value); |
| } |
| |
| public String getAttribute(final String name) { |
| return this.attribs.get(name); |
| } |
| |
| public boolean containsAttribute(final String name) { |
| return this.attribs.get(name) != null; |
| } |
| |
| @Override |
| public Object clone() throws CloneNotSupportedException { |
| BasicClientCookie clone = (BasicClientCookie) super.clone(); |
| clone.attribs = new HashMap<String, String>(this.attribs); |
| return clone; |
| } |
| |
| @Override |
| public String toString() { |
| StringBuilder buffer = new StringBuilder(); |
| buffer.append("[version: "); |
| buffer.append(Integer.toString(this.cookieVersion)); |
| buffer.append("]"); |
| buffer.append("[name: "); |
| buffer.append(this.name); |
| buffer.append("]"); |
| buffer.append("[value: "); |
| buffer.append(this.value); |
| buffer.append("]"); |
| buffer.append("[domain: "); |
| buffer.append(this.cookieDomain); |
| buffer.append("]"); |
| buffer.append("[path: "); |
| buffer.append(this.cookiePath); |
| buffer.append("]"); |
| buffer.append("[expiry: "); |
| buffer.append(this.cookieExpiryDate); |
| buffer.append("]"); |
| return buffer.toString(); |
| } |
| |
| // ----------------------------------------------------- Instance Variables |
| |
| /** Cookie name */ |
| private final String name; |
| |
| /** Cookie attributes as specified by the origin server */ |
| private Map<String, String> attribs; |
| |
| /** Cookie value */ |
| private String value; |
| |
| /** Comment attribute. */ |
| private String cookieComment; |
| |
| /** Domain attribute. */ |
| private String cookieDomain; |
| |
| /** Expiration {@link Date}. */ |
| private Date cookieExpiryDate; |
| |
| /** Path attribute. */ |
| private String cookiePath; |
| |
| /** My secure flag. */ |
| private boolean isSecure; |
| |
| /** The version of the cookie specification I was created from. */ |
| private int cookieVersion; |
| |
| } |
| |