BigSWAF::AppHandler Class Reference

Maps requests coming in via a BigSWAF::RequestHandler onto a BigSWAF::Application derivation. More...

List of all members.

Public Class Methods
retval	new (scalar this)
Public Object Methods
retval	clone ()
	Clone/copy this object.
void	initapp (scalar appid)
	Initializes an application: Instantiates the corresponding BigSister::(application)Application class, reads the application specific configuration via BigSWAF::Configuration and sets up a BigSWAF::DispEngine object.
scalar	request (BigSWAF::RequestHandler env)
	Handle one request.
BigSWAF::AppHandler	env (BigSWAF::RequestHandler env)
	Get/set the RequestHandler in charge.
BigSWAF::DispEngine	display (BigSWAF::DispEngine disp)
	Get/set the BigSWAF::DispEngine in charge.
BigSWAF::Session	session (BigSWAF::Session session)
	Get/set the active BigSWAF::Session.
retval	noapp ()
	Emits an error if no application could be associated with a request.
retval	error (scalar code, scalar message)
	Set error code/message for request results.
retval	param (scalar name)
	Get the list of values of a request parameter.
retval	paramv (scalar name)
	Get the first value of a request parameter.
retval	upload_filehandle (scalar name)
	If a parameter is associated with an input field of type "file", then param() and paramv() return the uploaded file's name, while upload_filehandle() returns a handle to the actual uploaded file.
retval	prevent_caching (list ARGS)
	Ask if client requested us to bypass caches.
retval	authenticate (scalar realm)
	Ask for authentication for a given realm.
retval	getcredentials ()
	Ask which credentials a client provided.
retval	content_type (scalar type)
	Set content type for the request result.
retval	rootpath (scalar path)
	Get/set root path of this request.
retval	path (scalar path)
	Get/set path of this request.
retval	appid ()
	Get name/id of the current application.
retval	clientid ()
	Get the id of the client.

---

Detailed Description

Maps requests coming in via a BigSWAF::RequestHandler onto a BigSWAF::Application derivation.

---

Member Function Documentation

retval BigSWAF::AppHandler::appid (   )

Get name/id of the current application. Frontend for BigSWAF::RequestHandler::appid().

retval BigSWAF::AppHandler::authenticate (  scalar  realm  )

Ask for authentication for a given realm. Frontend for BigSWAF::RequestHandler::authenticate().

retval BigSWAF::AppHandler::clientid (   )

Get the id of the client. Frontend for BigSWAF::RequestHandler::clientid().

retval BigSWAF::AppHandler::clone (   )

Clone/copy this object. Returns: an exact copy of the object.

retval BigSWAF::AppHandler::content_type (  scalar  type  )

Set content type for the request result. Frontend for BigSWAF::RequestHandler::content_type().

BigSWAF::DispEngine BigSWAF::AppHandler::display (  BigSWAF::DispEngine  disp  )

Get/set the BigSWAF::DispEngine in charge.

BigSWAF::AppHandler BigSWAF::AppHandler::env (  BigSWAF::RequestHandler  env  )

Get/set the RequestHandler in charge.

retval BigSWAF::AppHandler::error (  scalar  code, scalar  message )

Set error code/message for request results. Frontend for BigSWAF::RequestHandler::error().

retval BigSWAF::AppHandler::getcredentials (   )

Ask which credentials a client provided. Frontend for BigSWAF::RequestHandler::getcredentials().

void BigSWAF::AppHandler::initapp (  scalar  appid  )

Initializes an application: Instantiates the corresponding BigSister::(application)Application class, reads the application specific configuration via BigSWAF::Configuration and sets up a BigSWAF::DispEngine object. Parameters: appid  The name/id of the application to initialize

retval BigSWAF::AppHandler::new (  scalar  this  )

retval BigSWAF::AppHandler::noapp (   )

Emits an error if no application could be associated with a request.

retval BigSWAF::AppHandler::param (  scalar  name  )

Get the list of values of a request parameter. Frontend for BigSWAF::RequestHandler::param().

retval BigSWAF::AppHandler::paramv (  scalar  name  )

Get the first value of a request parameter. Frontend for BigSWAF::RequestHandler::paramv().

retval BigSWAF::AppHandler::path (  scalar  path  )

Get/set path of this request. Frontend for BigSWAF::RequestHandler::path().

retval BigSWAF::AppHandler::prevent_caching (  list  ARGS  )

Ask if client requested us to bypass caches. Frontend for BigSWAF::RequestHandler::prevent_caching().

scalar BigSWAF::AppHandler::request (  BigSWAF::RequestHandler  env  )

Handle one request. The BigSWAF::RequestHandler in charge invokes request() for each incoming request. The request() method finds out which BigSWAF application the request belongs to, sets up an apphandler via initapp(), does session and cookie handling and passes the request on to the respective application handler. Parameters: env  the RequestHandler that is in charge for this request and Returns: a document the calling method is supposed to pass on to the user

retval BigSWAF::AppHandler::rootpath (  scalar  path  )

Get/set root path of this request. Frontend for BigSWAF::RequestHandler::rootpath().

BigSWAF::Session BigSWAF::AppHandler::session (  BigSWAF::Session  session  )

Get/set the active BigSWAF::Session.

retval BigSWAF::AppHandler::upload_filehandle (  scalar  name  )

If a parameter is associated with an input field of type "file", then param() and paramv() return the uploaded file's name, while upload_filehandle() returns a handle to the actual uploaded file.

---

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

• BigSWAF/AppHandler.pm

---