Cookie.java

/*
 * Copyright 2003-2006 Rick Knowles <winstone-devel at lists sourceforge net>
 * Distributed under the terms of either:
 * - the common development and distribution license (CDDL), v1.0; or
 * - the GNU Lesser General Public License, v2.1 or later
 */
package javax.winstone.servlet.http;

/**
 * Cookie model value object
 * 
 * @author <a href="mailto:rick_knowles@hotmail.com">Rick Knowles</a>
 */
public class Cookie implements Cloneable {
    private String name;
    private String value;
    private String comment;
    private String domain;
    private String path;
    private boolean secure;
    private int maxAge;
    private int version;

    public Cookie(String name, String value) {
        setName(name);
        setValue(value);
        setMaxAge(-1);
    }

    public Object clone() {
        Cookie clone = new Cookie(this.name, this.value);
        clone.setComment(this.comment);
        clone.setDomain(this.domain);
        clone.setMaxAge(this.maxAge);
        clone.setSecure(this.secure);
        clone.setVersion(this.version);
        clone.setPath(this.path);
        return clone;
    }

    public String getComment() {
        return this.comment;
    }

    public String getDomain() {
        return this.domain;
    }

    public int getMaxAge() {
        return this.maxAge;
    }

    public String getName() {
        return this.name;
    }

    public String getPath() {
        return this.path;
    }

    public boolean getSecure() {
        return this.secure;
    }

    public String getValue() {
        return this.value;
    }

    public int getVersion() {
        return this.version;
    }

    private void setName(String name) {
        if (name == null) {
            throw new IllegalArgumentException("Cookie name was null");
        } else if (name.indexOf(";") != -1) {
            throw new IllegalArgumentException("Cookie name contains a semicolon");
        } else if (name.indexOf(",") != -1) {
            throw new IllegalArgumentException("Cookie name contains a comma");
        } else if (name.startsWith("$")) {
            throw new IllegalArgumentException("Cookie name starts with $");
        } else {
            // Check for white space, comma, semicolon
            for (int n = 0; n < name.length(); n++) {
                char c = name.charAt(n); 
                if (c <= 0x20 || c >= 0x7f) {
                    throw new IllegalArgumentException("Cookie name contains whitespace or " +
                            "non-alphanumeric char: " + name.charAt(n) + " in " + name);
                }
            }
            this.name = name;
        }
    }
    
    public void setComment(String purpose) {
        this.comment = purpose;
    }

    public void setDomain(String pattern) {
        this.domain = pattern;
    }

    public void setMaxAge(int expiry) {
        this.maxAge = expiry;
    }

    public void setPath(String uri) {
        this.path = uri;
    }

    public void setSecure(boolean flag) {
        this.secure = flag;
    }

    public void setValue(String newValue) {
        this.value = newValue;
    }

    public void setVersion(int v) {
        this.version = v;
    }
    
    public String toString() {
        return "[Cookie: name=" + this.name + " value=" + this.value + " version=" + 
                this.version + " path=" + this.path + " domain=" + this.domain + " comment=" +
                this.comment + " maxAge=" + this.maxAge + " secure=" + this.secure + "]";
    }
}