Cookie.h

Go to the documentation of this file.

/*
 * ====================================================================
 *
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999-2001 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", "Tomcat", 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.
 * ====================================================================
 *
 */

#ifndef COOKIE_H
#define COOKIE_H

#include <ctype.h> //tolower
#include <string>
#include <algorithm>

namespace servlet {

class Cookie {
    //
    // The value of the cookie itself.
    //
    std::string name;         // NAME= ... "$Name" style is reserved
    std::string value;        // value of NAME

    //
    // Attributes encoded in the header's cookie fields.
    //
    std::string comment;     // ;Comment=VALUE ... describes cookie's use
                             // ;Discard ... implied by maxAge < 0
    std::string domain;      // ;Domain=VALUE ... domain that sees cookie
    int maxAge;              // ;Max-Age=VALUE ... cookies auto-expire
    std::string path;        // ;Path=VALUE ... URLs that see the cookie
    bool secure;             // ;Secure ... e.g. use SSL
    int version;             // ;Version=1 ... means RFC 2109++ style
public:



    Cookie(const std::string& name, const std::string& value);



    void  setComment(const std::string& purpose)
        { comment = purpose; }


    std::string  getComment() const
        { return comment; }



    void  setDomain(const std::string& pattern) {
        domain.resize(pattern.size());
        std::transform(pattern.begin(), pattern.end(), domain.begin(), tolower); // IE allegedly needs this
    }



    std::string  getDomain() const
        { return domain; }


    void  setMaxAge(int expiry)
        { maxAge = expiry; }


    int  getMaxAge() const
        { return maxAge; }



    void  setPath(const std::string& uri)
        { path = uri; }



    std::string  getPath() const
        { return path; }



    void  setSecure(bool flag)
        { secure = flag; }


    bool  getSecure() const
        { return secure; }



    std::string  getName() const
        { return name; }



    void  setValue(const std::string& newValue)
        { value = newValue; }



    std::string  getValue() const
        { return value; }


    int  getVersion() const
        { return version; }




    void  setVersion(int v)
        { version = v; }

private:


    /*
     * Tests a string and returns true if the string counts as a
     * reserved token in the Java language.
     *
     * @param value             the <code>String</code> to be tested
     *
     * @return                  <code>true</code> if the <code>String</code> is
     *                          a reserved token; <code>false</code>
     *                          if it is not
     */
    bool  isValidName(const std::string& value) const;
};

}//namespace

#endif/*COOKIE_H*/