CGIApplication.h

Go to the documentation of this file.

/* -*- c++ -*-
 * $Id: CGIApplication.h,v 1.11 2006/05/16 20:12:15 brook Exp $
 */

/*
 * ClearSilver++ Software License.
 *
 * Copyright (c) 2006 Brook Milligan <brook@nmsu.edu>
 * 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 name of the author may not be used to endorse or promote
 *    products derived from this software without specific prior
 *    written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
 * 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 AUTHOR 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 CGIApplication_h_
#define CGIApplication_h_ 1

#include <boost/shared_ptr.hpp>
#include "CGI.h"
#include "TraceObject.h"

namespace ClearSilver
{

  class CGIApplication : TraceObject
  {
  public:
    //\{
    typedef boost::shared_ptr<CGIApplication> Ptr;
    //\}

  public:
    //\{
    // constructors
    CGIApplication ();
    explicit CGIApplication (const char*);
    explicit CGIApplication (const std::string&);
    explicit CGIApplication (const ClearSilver::HDF&);
    explicit CGIApplication (const ClearSilver::CGI&);
    CGIApplication (const CGIApplication&);
    virtual ~CGIApplication () throw();

    CGIApplication& operator = (const CGIApplication&);
    CGIApplication& operator = (const CGI&);
    void swap (CGIApplication&) throw();
    //\}

    void operator () ();

    //\{
    CGI cgi () const;
    HDF hdf ();
    //\}

  protected:
    //\{

    virtual void initialize ();

    virtual bool authenticate() = 0;

    virtual void execute();

    virtual void display();

    virtual void execute_unauthenticated();

    virtual void display_unauthenticated();

    virtual void terminate ();

    virtual void handle_exception (const std::string&);
    //\}

  public:
    static bool& debug ();

  private:
    CGI cgi_;
  };

};                              // namespace ClearSilver

#endif

---