HttpServletRequest.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 HTTP_SERVLET_REQUEST_H
#define HTTP_SERVLET_REQUEST_H

#include <memory>
#include <string>
#include <vector>
#include "ServletRequest.h"
#include "Cookie.h"
#include "HttpSession.h"

namespace servlet {

class UploadedFile;

    class HttpServletRequest: virtual public ServletRequest {
    public:
    typedef std::map<std::string,Cookie*> cookielist_t;
        HttpServletRequest();
        virtual ~HttpServletRequest()
            {   }
        const std::string BASIC_AUTH;
        const std::string FORM_AUTH;
        const std::string CLIENT_CERT_AUTH;
        const std::string DIGEST_AUTH;
    
        virtual std::string  getAuthType() const =0;
    
    
    
    
        virtual std::auto_ptr< cookielist_t > getCookies() const =0;
    
    
    
    
        virtual long  getDateHeader(const std::string& name) const =0;
    
    
    
    
        virtual std::string  getHeader(const std::string& name) const =0;
    
    
    
    
        virtual std::auto_ptr< std::vector<std::string> > getHeaders(const std::string& name) const =0;
    
    
    
    
    
        virtual std::auto_ptr< std::vector<std::string> > getHeaderNames() const =0;
    
    
    
    
        virtual int  getIntHeader(const std::string& name) const =0;
    
    
    
    
        virtual std::string  getMethod() const =0;
    
    
    
    
        virtual std::string  getPathInfo() const =0;
    
    
    
    
        virtual std::string  getPathTranslated() const =0;
    
    
    
    
        virtual std::string  getContextPath() const =0;
    
    
    
    
        virtual std::string  getQueryString() const =0;
    
    
    
    
        virtual std::string  getRemoteUser() const =0;
    
    
    
    
        virtual bool isUserInRole(const std::string& role) const =0;
    
    
    
    /* NOTE: I don't understand this
    //    **
         *
         * Returns a <code>java.security.Principal</code> object containing
         * the name of the current authenticated user. If the user has not been
         * authenticated, the method returns <code>null</code>.
         *
         * @return          a <code>java.security.Principal</code> containing
         *                  the name of the user making this request;
         *                  <code>null</code> if the user has not been
         *                  authenticated
         *
         /
            virtual const Principal& getUserPrincipal()=0;
    */
    
    
    
    
        virtual std::string  getRequestedSessionId() const =0;
    
    
    
    
        virtual std::string  getRequestURI() const =0;
    
        virtual std::string  getRequestURL() const =0;
    
    
        virtual std::string  getServletPath() const =0;
    
    
    
    
        virtual HttpSession* getSession(bool create = true) =0;
    
        virtual bool  isRequestedSessionIdValid() const =0;
    
    
    
    
        virtual bool  isRequestedSessionIdFromCookie() const =0;
    
    
    
    
        virtual bool  isRequestedSessionIdFromURL() const =0;

    virtual UploadedFile* getUploadedFile(const std::string&) = 0;
    };

}//namespace
#endif/*HTTP_SERVLET_REQUEST_H*/