CPPSERV


Home Projects Jobs Clientele Contact
CPPSERV Documentation Download TODO Mailing lists Bug tracker News RSS Feed Browse source

ServletContext.h

Go to the documentation of this file.
00001 /*
00002  * ====================================================================
00003  *
00004  * The Apache Software License, Version 1.1
00005  *
00006  * Copyright (c) 1999-2001 The Apache Software Foundation.  All rights
00007  * reserved.
00008  *
00009  * Redistribution and use in source and binary forms, with or without
00010  * modification, are permitted provided that the following conditions
00011  * are met:
00012  *
00013  * 1. Redistributions of source code must retain the above copyright
00014  *    notice, this list of conditions and the following disclaimer.
00015  *
00016  * 2. Redistributions in binary form must reproduce the above copyright
00017  *    notice, this list of conditions and the following disclaimer in
00018  *    the documentation and/or other materials provided with the
00019  *    distribution.
00020  *
00021  * 3. The end-user documentation included with the redistribution, if
00022  *    any, must include the following acknowlegement:
00023  *       "This product includes software developed by the
00024  *        Apache Software Foundation (http://www.apache.org/)."
00025  *    Alternately, this acknowlegement may appear in the software itself,
00026  *    if and wherever such third-party acknowlegements normally appear.
00027  *
00028  * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
00029  *    Foundation" must not be used to endorse or promote products derived
00030  *    from this software without prior written permission. For written
00031  *    permission, please contact apache@apache.org.
00032  *
00033  * 5. Products derived from this software may not be called "Apache"
00034  *    nor may "Apache" appear in their names without prior written
00035  *    permission of the Apache Group.
00036  *
00037  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00038  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00039  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00040  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00041  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00042  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00043  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00044  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00045  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00046  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00047  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00048  * SUCH DAMAGE.
00049  * ====================================================================
00050  *
00051  */
00052 
00053 #ifndef SERVLET_CONTEXT_H
00054 #define SERVLET_CONTEXT_H
00055 
00056 #include <memory>
00057 #include <set>
00058 #include <string>
00059 #include <iostream>
00060 #include <exception>
00061 #include <servlet/RequestDispatcher.h>
00062 #include <vector>
00063 #include <boost/shared_ptr.hpp>
00064 
00065 namespace servlet {    
00096     class ServletContext {
00097     public:
00098     virtual ~ServletContext(){}
00099     
00124         virtual ServletContext*  getContext(const std::string& uripath)=0;
00125     
00126     
00127     
00137         virtual int  getMajorVersion()=0;
00138     
00139     
00140     
00150         virtual int  getMinorVersion()=0;
00151     
00152     
00153     
00168         virtual std::string  getMimeType(const std::string& file)=0;
00169     
00197         virtual std::auto_ptr< std::set<std::string> >  getResourcePaths(const std::string& path)=0;
00198     
00199     
00200     
00242         virtual std::string getResource(const std::string& path)=0;
00243     
00244     
00245     
00280         virtual std::istream& getResourceAsStream(const std::string& path)=0;
00281     
00282     
00283     
00284     
00312         virtual RequestDispatcher* getRequestDispatcher(const std::string& path)=0;
00313     
00314     
00315     
00342         virtual RequestDispatcher*  getNamedDispatcher(const std::string& name)=0;
00343     
00344     
00356         virtual void  log(const std::string& msg) const =0;
00357     
00372         virtual void  log(const std::string& message, const std::exception& e) const =0;
00373     
00398         virtual std::string  getRealPath(const std::string& path)=0;
00399     
00400     
00401     
00402     
00421         virtual std::string  getServerInfo()=0;
00422     
00423     
00442         virtual std::string  getInitParameter(const std::string& name)=0;
00443     
00444     
00445     
00446     
00459         virtual std::auto_ptr< std::vector<std::string> > getInitParameterNames()=0;
00460     
00461     
00462     
00492          virtual boost::shared_ptr<void> getAttribute(const std::string& name)=0;
00493          template <typename T>
00494       T getAttribute(const std::string& name);
00495     
00496     
00510         virtual std::auto_ptr< std::vector<std::string> > getAttributeNames()=0;
00511     
00512     
00513     
00514     
00541         virtual void setAttribute(const std::string& name, boost::shared_ptr<void> object)=0;
00542         template <typename T>
00543      void setAttribute(const std::string& name, boost::shared_ptr<T> object)
00544     {
00545         setAttribute(name, static_cast<boost::shared_ptr<void> >(object));
00546     }
00547         template <typename T>
00548      void setAttribute(const std::string& name, const T& object);
00549     
00550     
00566         virtual void  removeAttribute(const std::string& name)=0;
00567     
00579         virtual bool hasAttribute(const std::string& name) const = 0;
00580 
00581         
00582     
00591         virtual std::string  getServletContextName() const=0;
00592         
00593     };
00594     template<typename T>
00595     T ServletContext::getAttribute(const std::string& name) {    
00596         const boost::shared_ptr<void> value = getAttribute(name);
00597         if(!value)
00598             return T();
00599         return *boost::static_pointer_cast<T>(value);
00600     }
00601     template<typename T>
00602     void ServletContext::setAttribute(const std::string& name, const T& object) {
00603     setAttribute(name,boost::shared_ptr<void>(new T(object)));
00604     }
00605 
00606 }//namespace
00607 #endif/*SERVLET_CONTEXT_H*/

SourceForge.net Logo