ServletRequest.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 SERVLET_REQUEST_H
#define SERVLET_REQUEST_H

#include <memory>
#include <string>
#include <vector>
#include <map>
#include <memory>
#include <iostream>
#include <boost/shared_ptr.hpp>

namespace servlet {

    class RequestDispatcher;
    //class Locale;
    
    class ServletRequest {
    public:
    virtual ~ServletRequest(){}

        virtual boost::shared_ptr<void> getAttribute(const std::string& name)=0;
    template <typename T>
     T getAttribute(const std::string& name);
    
        virtual bool hasAttribute(const std::string& name) const = 0;
    
        virtual std::auto_ptr< std::vector<std::string> > getAttributeNames() const=0;
    
        virtual void setAttribute(const std::string& name, boost::shared_ptr<void> o)=0;
        template <typename T>
     void setAttribute(const std::string& name, boost::shared_ptr<T> o)
    {
        setAttribute(name, static_cast<boost::shared_ptr<void> >(o));
    }
        template <typename T>
     void setAttribute(const std::string& name, const T& o);

        virtual void  removeAttribute(const std::string& name)=0;
    
        virtual std::string  getCharacterEncoding() const=0;
    
        virtual void  setCharacterEncoding(const std::string& env) =0;
    
        virtual int  getContentLength() const=0;
    
        virtual std::string  getContentType() const=0;
    
        virtual std::istream&  getInputStream()=0;
    
        virtual std::string  getParameter(const std::string& name) const=0;
    
        virtual std::auto_ptr< std::vector<std::string> > getParameterNames() const=0;
    
        virtual std::auto_ptr< std::vector<std::string> > getParameterValues(const std::string& name) const=0;
    
        virtual std::auto_ptr< std::multimap<std::string,std::string> > getParameterMap() const=0;
    
        virtual std::string  getProtocol() const=0;
    
        virtual std::string  getScheme() const=0;
    
        virtual std::string  getServerName() const=0;
    
        virtual int  getServerPort() const=0;
    
        virtual std::string  getRemoteAddr() const=0;
    
        virtual std::string  getRemoteHost() const=0;
    
        virtual bool  isSecure() const=0;
    
        virtual RequestDispatcher* getRequestDispatcher(const std::string& path)=0;
    
        virtual int  getRemotePort() const=0;
    
        virtual std::string  getLocalName() const=0;
    
        virtual std::string  getLocalAddr() const=0;
    
        virtual int  getLocalPort() const=0;
    };

    template<typename T>
    T ServletRequest::getAttribute(const std::string& name) {
        const boost::shared_ptr<void> value = getAttribute(name);
        if(!value)
            return T();
        return *boost::static_pointer_cast<T>(value);
    }
    template<typename T>
    void ServletRequest::setAttribute(const std::string& name, const T& o) {
    setAttribute(name,boost::shared_ptr<void>(new T(o)));
    }

}//namespace

#endif/*SERVLET_REQUEST_H*/