Source for gnu.java.net.protocol.http.Cookie

   1: /* Cookie.java --
   2:    Copyright (C) 2004 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10:  
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package gnu.java.net.protocol.http;
  40: 
  41: import java.util.Date;
  42: 
  43: /**
  44:  * An HTTP cookie, as specified in RFC 2109.
  45:  *
  46:  * @author Chris Burdess (dog@gnu.org)
  47:  */
  48: public class Cookie
  49: {
  50: 
  51:   /**
  52:    * The name of the cookie.
  53:    */
  54:   protected final String name;
  55: 
  56:   /**
  57:    * The value of the cookie.
  58:    */
  59:   protected final String value;
  60: 
  61:   /**
  62:    * Optional documentation of the intended use of the cookie.
  63:    */
  64:   protected final String comment;
  65: 
  66:   /**
  67:    * The domain for which the cookie is valid.
  68:    */
  69:   protected final String domain;
  70: 
  71:   /**
  72:    * Optional subset of URL paths within the domain for which the cookie is
  73:    * valid.
  74:    */
  75:   protected final String path;
  76: 
  77:   /**
  78:    * Indicates that the user-agent should only use secure means to transmit
  79:    * this cookie to the server.
  80:    */
  81:   protected final boolean secure;
  82: 
  83:   /**
  84:    * The date at which this cookie expires.
  85:    */
  86:   protected final Date expires;
  87: 
  88:   public Cookie(String name, String value, String comment, String domain,
  89:                 String path, boolean secure, Date expires)
  90:   {
  91:     this.name = name;
  92:     this.value = value;
  93:     this.comment = comment;
  94:     this.domain = domain;
  95:     this.path = path;
  96:     this.secure = secure;
  97:     this.expires = expires;
  98:   }
  99: 
 100:   public String getName()
 101:   {
 102:     return name;
 103:   }
 104: 
 105:   public String getValue()
 106:   {
 107:     return value;
 108:   }
 109: 
 110:   public String getComment()
 111:   {
 112:     return comment;
 113:   }
 114: 
 115:   public String getDomain()
 116:   {
 117:     return domain;
 118:   }
 119: 
 120:   public String getPath()
 121:   {
 122:     return path;
 123:   }
 124: 
 125:   public boolean isSecure()
 126:   {
 127:     return secure;
 128:   }
 129: 
 130:   public Date getExpiryDate()
 131:   {
 132:     return expires;
 133:   }
 134: 
 135:   public String toString()
 136:   {
 137:     return toString(true, true);
 138:   }
 139:   
 140:   public String toString(boolean showPath, boolean showDomain)
 141:   {
 142:     StringBuilder buf = new StringBuilder();
 143:     buf.append(name);
 144:     buf.append('=');
 145:     buf.append(value);
 146:     if (showPath)
 147:       {
 148:         buf.append("; $Path=");
 149:         buf.append(path);
 150:       }
 151:     if (showDomain)
 152:       {
 153:         buf.append("; $Domain=");
 154:         buf.append(domain);
 155:       }
 156:     return buf.toString();
 157:   }
 158: 
 159: }