Source for gnu.inet.http.Cookie

   1: /*
   2:  * Cookie.java
   3:  * Copyright (C) 2004 The Free Software Foundation
   4:  * 
   5:  * This file is part of GNU inetlib, a library.
   6:  * 
   7:  * GNU inetlib is free software; you can redistribute it and/or modify
   8:  * it under the terms of the GNU General Public License as published by
   9:  * the Free Software Foundation; either version 2 of the License, or
  10:  * (at your option) any later version.
  11:  * 
  12:  * GNU inetlib is distributed in the hope that it will be useful,
  13:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15:  * GNU General Public License for more details.
  16:  * 
  17:  * You should have received a copy of the GNU General Public License
  18:  * along with this library; if not, write to the Free Software
  19:  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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:  * obliged to do so.  If you do not wish to do so, delete this
  36:  * exception statement from your version.
  37:  */
  38: 
  39: package gnu.inet.http;
  40: 
  41: import java.text.ParseException;
  42: import java.util.Date;
  43: 
  44: /**
  45:  * An HTTP cookie, as specified in RFC 2109.
  46:  *
  47:  * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
  48:  */
  49: public class Cookie
  50: {
  51: 
  52:   /**
  53:    * The name of the cookie.
  54:    */
  55:   protected final String name;
  56: 
  57:   /**
  58:    * The value of the cookie.
  59:    */
  60:   protected final String value;
  61: 
  62:   /**
  63:    * Optional documentation of the intended use of the cookie.
  64:    */
  65:   protected final String comment;
  66: 
  67:   /**
  68:    * The domain for which the cookie is valid.
  69:    */
  70:   protected final String domain;
  71: 
  72:   /**
  73:    * Optional subset of URL paths within the domain for which the cookie is
  74:    * valid.
  75:    */
  76:   protected final String path;
  77: 
  78:   /**
  79:    * Indicates that the user-agent should only use secure means to transmit
  80:    * this cookie to the server.
  81:    */
  82:   protected final boolean secure;
  83: 
  84:   /**
  85:    * The date at which this cookie expires.
  86:    */
  87:   protected final Date expires;
  88: 
  89:   public Cookie(String name, String value, String comment, String domain,
  90:                 String path, boolean secure, Date expires)
  91:   {
  92:     this.name = name;
  93:     this.value = value;
  94:     this.comment = comment;
  95:     this.domain = domain;
  96:     this.path = path;
  97:     this.secure = secure;
  98:     this.expires = expires;
  99:   }
 100: 
 101:   public String getName()
 102:   {
 103:     return name;
 104:   }
 105: 
 106:   public String getValue()
 107:   {
 108:     return value;
 109:   }
 110: 
 111:   public String getComment()
 112:   {
 113:     return comment;
 114:   }
 115: 
 116:   public String getDomain()
 117:   {
 118:     return domain;
 119:   }
 120: 
 121:   public String getPath()
 122:   {
 123:     return path;
 124:   }
 125: 
 126:   public boolean isSecure()
 127:   {
 128:     return secure;
 129:   }
 130: 
 131:   public Date getExpiryDate()
 132:   {
 133:     return expires;
 134:   }
 135: 
 136:   public String toString()
 137:   {
 138:     return toString(true, true);
 139:   }
 140:   
 141:   public String toString(boolean showPath, boolean showDomain)
 142:   {
 143:     StringBuffer buf = new StringBuffer();
 144:     buf.append(name);
 145:     buf.append('=');
 146:     buf.append(value);
 147:     if (showPath)
 148:       {
 149:         buf.append("; $Path=");
 150:         buf.append(path);
 151:       }
 152:     if (showDomain)
 153:       {
 154:         buf.append("; $Domain=");
 155:         buf.append(domain);
 156:       }
 157:     return buf.toString();
 158:   }
 159: 
 160: }