Docs For Class ForceAuthAction

Description

The ForceAuthAction forces token collection via HTTP Authentication to allow

authentication outside of the context of a browser Harmoni-Application environment. For instance, this can be used to authenticate an RSS reader for an RSS feed, or to prompt for authentication for a file that is directly linked from another website.

version: $Id: ForceAuthAction.class.php,v 1.4 2007/09/19 14:04:41 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 8/4/06

Located in /polyphony/main/library/AbstractActions/ForceAuthAction.class.php (line 30)

Action
   |
   --ForceAuthAction

Direct descendents

Class	Description
RSSAction	<##>
viewfileAction	Display the file in the specified record.
viewthumbnailAction	Display the file in the specified record.

Method Summary

void authenticate ()

mixed getCancelFunction ()

mixed getRelm ()

boolean isAuthenticated ()

boolean isAuthorizedToExecute ()

boolean isExecutionAuthorized ()

Methods

authenticate (line 89)

Loop through the authentication types and try to authenticate the user.

since: 8/4/06
access: public

void authenticate ()

getCancelFunction (line 153)

Answer the cancel function for this action, to use if the user hits the 'cancel' button in the http authentication dialog.

return: string or null
since: 8/7/06
access: public

mixed getCancelFunction ()

Redefined in descendants as:

viewfileAction::getCancelFunction() : Answer the cancel function for this action, to use if the user hits the 'cancel' button in the http authentication dialog.
viewthumbnailAction::getCancelFunction() : Answer the cancel function for this action, to use if the user hits the 'cancel' button in the http authentication dialog.

getRelm (line 141)

Answer the HTTP Authentication 'Relm' to present to the user for authentication.

return: string or null
since: 8/7/06
access: public

mixed getRelm ()

Redefined in descendants as:

browse_rssAction::getRelm() : Answer the HTTP Authentication 'Relm' to present to the user for authentication.
viewfileAction::getRelm() : Answer the HTTP Authentication 'Relm' to present to the user for authentication.
viewthumbnailAction::getRelm() : Answer the HTTP Authentication 'Relm' to present to the user for authentication.

isAuthenticated (line 64)

Loop through the authentication types and see if the user is authenticated.

since: 8/4/06
access: public

boolean isAuthenticated ()

isAuthorizedToExecute (line 41)

Check Authorizations

since: 4/26/05
access: public

boolean isAuthorizedToExecute ()

Redefinition of:

Action::isAuthorizedToExecute(): Check Authorizations

isExecutionAuthorized (line 130)

Check Authorizations

since: 8/4/06
access: public

boolean isExecutionAuthorized ()

Redefined in descendants as:

browse_rssAction::isExecutionAuthorized() : Check Authorizations
viewfileAction::isExecutionAuthorized() : Check Authorizations
viewthumbnailAction::isExecutionAuthorized() : Check Authorizations

Inherited Methods

Inherited From Action

Action::execute()
Action::getHeadingText()
Action::getUnauthorizedMessage()
Action::isAuthorizedToExecute()
Action::requestedAction()
Action::requestedModule()