ClearSilver::CGIApplicationUnauthenticated Class Reference

Encapsulation of an unauthenticated CGI application. More...

#include <CGIApplicationUnauthenticated.h>

Inheritance diagram for ClearSilver::CGIApplicationUnauthenticated:

List of all members.

Public Types
Pointer types
typedef boost::shared_ptr< CGIApplication >	Ptr
Public Member Functions
void	swap (TraceObject &) throw ()
void	operator() ()
	CGI application entry point.
Constructors and assignment operators
	CGIApplicationUnauthenticated ()
	Default constructor.
	CGIApplicationUnauthenticated (const char *)
	Construct from the name of an HDF file.
	CGIApplicationUnauthenticated (const std::string &)
	Construct from the name of an HDF file.
	CGIApplicationUnauthenticated (const ClearSilver::HDF &)
	Construct from an existing HDF dataset.
	CGIApplicationUnauthenticated (const CGIApplicationUnauthenticated &)
	Copy constructor.
virtual	~CGIApplicationUnauthenticated () throw ()
	Destructor.
CGIApplicationUnauthenticated &	operator= (const CGIApplicationUnauthenticated &)
	Assignment operator.
void	swap (CGIApplicationUnauthenticated &) throw ()
	Swap contents with another object.
Constructors and assignment operators
void	swap (CGIApplication &) throw ()
	Swap contents with another object.
Access to ClearSilver data structures
CGI	cgi () const
	ClearSilver CGI data structure.
HDF	hdf ()
	ClearSilver HDF dataset.
Static Public Member Functions
static bool &	debug ()
	Access the debug flag.
Protected Member Functions
virtual bool	authenticate ()
	Verify authentication of query.
virtual void	execute_unauthenticated ()
	Execute the CGI program after authentication fails.
virtual void	display_unauthenticated ()
	Display CGI output in absence of authentication.
CGI application hooks
Derived classes are expected to provide their own implementations of these methods. The CGI application provided by the default version of these methods is a NOP.
virtual void	initialize ()
	Initial setup of data structures.
virtual void	execute ()
	Execute main CGI program.
virtual void	display ()
	Display CGI output.
virtual void	terminate ()
	Final cleanup of data structures.
virtual void	handle_exception (const std::string &)
	Handle exceptions appropriately.

---

Detailed Description

Encapsulation of an unauthenticated CGI application.

The class provides a template for constructing unauthenticated CGI applications. The function call operator (operator ()) provides the underlying CGI application logic, while the protected CGI application hooks provide means for derived classes to provide application-specific code. This class differs from the CGIApplication class from which it is derived by always accepting the request.

This class follows the Template Method pattern described in the following reference.

• Gamma, Erich, Helm, Richard, Johnson, Ralph, and Vlissides, John. 1995. Design Patterns. Elements of resusable object-oriented software. Template Method, pages 325-330. Addison-Wesley, Boston, Massachusetts.

Definition at line 72 of file CGIApplicationUnauthenticated.h.

---

Member Function Documentation

bool ClearSilver::CGIApplicationUnauthenticated::authenticate (   )  [protected, virtual]

Verify authentication of query. This method determines whether or not to authenticate each request. The implementation provided by this class always returns true and therefore accepts all requests. Implements ClearSilver::CGIApplication. Definition at line 84 of file CGIApplicationUnauthenticated.cc.

bool & ClearSilver::CGIApplication::debug (   )  [static, inherited]

Access the debug flag. If the debug flag is true, syslog(3) messages with priority LOG_DEBUG will be logged. Definition at line 299 of file CGIApplication.cc. Referenced by ClearSilver::CGIApplication::display(), ClearSilver::CGIApplication::display_unauthenticated(), ClearSilver::CGIApplication::operator()(), and ClearSilver::CGIApplication::operator=().

void ClearSilver::CGIApplication::display (   )  [protected, virtual, inherited]

Display CGI output. This is the main output method for a CGI application. It is expected to only create output, not modify data structures or satisfy requests. By default, this method takes the name of the ClearSilver template from the HDF dataset associated with the CGIApplication. The value of the following HDF variables are searched in order: hdf.templates.authenticated hdf.template Definition at line 232 of file CGIApplication.cc. References ClearSilver::CGIApplication::cgi(), ClearSilver::CGIApplication::debug(), ClearSilver::CGI::display(), ClearSilver::HDF::find(), ClearSilver::CGIApplication::hdf(), and ClearSilver::ConstHDFNode::value(). Referenced by ClearSilver::CGIApplication::operator()().

void ClearSilver::CGIApplicationUnauthenticated::display_unauthenticated (   )  [protected, virtual]

Display CGI output in absence of authentication. This method is analogous to display() when authentication was unsuccessful (i.e., when authenticate() returns false). In this case, however, it should never be called, as authenticate() always returns true. To guard against misuse of this class, this method throws an exception. Reimplemented from ClearSilver::CGIApplication. Definition at line 95 of file CGIApplicationUnauthenticated.cc.

void ClearSilver::CGIApplication::execute (   )  [protected, virtual, inherited]

Execute main CGI program. This is the main execution path for CGI applications. It is expected that this method will perform the following operations. Create any necessary data structures. Satisfy any necessary requests. Not generate any output. Generating output is the responsibility of the display() method. Definition at line 229 of file CGIApplication.cc. Referenced by ClearSilver::CGIApplication::operator()().

void ClearSilver::CGIApplicationUnauthenticated::execute_unauthenticated (   )  [protected, virtual]

Execute the CGI program after authentication fails. This method is analogous to execute() when authentication was unsuccessful (i.e., when authenticate() returns false). In this case, however, it should never be called, as authenticate() always returns true. To guard against misuse of this class, this method throws an exception. Reimplemented from ClearSilver::CGIApplication. Definition at line 87 of file CGIApplicationUnauthenticated.cc.

virtual void ClearSilver::CGIApplication::handle_exception (  const std::string &   )  [protected, virtual, inherited]

Handle exceptions appropriately. This method allows CGI applications to handle the messages generated by exceptions. Be default, a message is rethrown as a ClearSilverException object. Referenced by ClearSilver::CGIApplication::operator()().

void ClearSilver::CGIApplication::operator() (   )  [inherited]

CGI application entry point. This method is the main entry point for CGI applications. Essentially, it executes the following application logic. initialize (); if (authenticate ()) { execute (); display (); } else { execute_unauthenticated (); display_unauthenticated (); } terminate (); Definition at line 147 of file CGIApplication.cc. References ClearSilver::CGIApplication::authenticate(), std::basic_string< _CharT, _Traits, _Alloc >::c_str(), ClearSilver::CGIApplication::debug(), ClearSilver::CGIApplication::display(), ClearSilver::CGIApplication::display_unauthenticated(), ClearSilver::CGIApplication::execute(), ClearSilver::CGIApplication::execute_unauthenticated(), ClearSilver::CGIApplication::handle_exception(), ClearSilver::CGI::hdf(), ClearSilver::CGIApplication::initialize(), ClearSilver::CGIApplication::terminate(), std::runtime_error::what(), std::logic_error::what(), and ClearSilver::ClearSilverException::what().

void ClearSilver::CGIApplication::terminate (   )  [protected, virtual, inherited]

Final cleanup of data structures. This method is responsible for returning the HDF data structure to the state it was in prior to handling a request. The CGI data structures will automatically be removed from the dataset (see HDFNode::remove_cgi()); however, any other modifications made during the request processing must be reversed here. Definition at line 288 of file CGIApplication.cc. Referenced by ClearSilver::CGIApplication::operator()().

---

The documentation for this class was generated from the following files:

• CGIApplicationUnauthenticated.h
• CGIApplicationUnauthenticated.cc

---