Class SQLDatabaseAuthNMethod

Description
Description | Methods (details)

The SQLDatabaseAuthNMethod is used to authenticate against a SQL database.

  • version: $Id: SQLDatabaseAuthNMethod.class.php,v 1.13 2007/09/04 20:25:37 adamfranco Exp $
  • license: GNU General Public License (GPL)
  • copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/agentmanagement/AuthNMethods/SQLDatabaseAuthNMethod.class.php (line 23) 

AuthNMethod
   |
   --SQLDatabaseAuthNMethod
Method Summary
Description | Methods (details)
void addTokens (object AuthNTokens $authNTokens)
object assignConfiguration (object Properties $configuration)
boolean authenticateTokens (object AuthNTokens $authNTokens)
object Tokens createTokensObject ()
void deleteTokens (object AuthNTokens $authNTokens)
object ObjectIterator getTokensBySearch (string $searchString)
boolean supportsPropertyUpdates ()
boolean supportsTokenAddition ()
boolean supportsTokenDeletion ()
boolean supportsTokenUpdates ()
boolean tokensExist (object AuthNTokens $authNTokens)
void updatePropertiesForTokens (object AuthNTokens $authNTokens, object Properties $newProperties)
void updateTokens (object AuthNTokens $oldAuthNTokens, object AuthNTokens $newAuthNTokens)
void _populateProperties (object AuthNTokens $authNTokens, object Properties $properties)
Methods
Description | Methods (details)
addTokens (line 313)

Add tokens to the system.

  • since: 3/1/05
  • access: public
void addTokens (object AuthNTokens $authNTokens)
Redefinition of:
AuthNMethod::addTokens()
Add tokens to the system.
assignConfiguration (line 35)

Stores the configuration. Calls the parent configuration first, then does additional operations.

  • since: 3/24/05
  • access: public
object assignConfiguration (object Properties $configuration)
  • object Properties $configuration
Redefinition of:
AuthNMethod::assignConfiguration()
Store the configuration.
authenticateTokens (line 107)

Authenticate an AuthNTokens object

  • since: 3/1/05
  • access: public
boolean authenticateTokens (object AuthNTokens $authNTokens)
Redefinition of:
AuthNMethod::authenticateTokens()
Authenticate a Tokens object
createTokensObject (line 86)

Create a Tokens Object

  • since: 3/1/05
  • access: public
object Tokens createTokensObject ()
Redefinition of:
AuthNMethod::createTokensObject()
Create a Tokens Object
deleteTokens (line 363)

Add tokens and associated Properties to the system.

  • since: 3/1/05
  • access: public
void deleteTokens (object AuthNTokens $authNTokens)
Redefinition of:
AuthNMethod::deleteTokens()
Add tokens and associated Properties to the system.
getTokensBySearch (line 254)

Get an iterator of the AuthNTokens that match the search string passed.

The '*' wildcard character can be present in the string and will be converted to the system wildcard for the AuthNMethod if wildcards are supported or removed (and the exact string searched for) if they are not supported.

When multiple fields are searched on an OR search is performed, i.e. '*ach*' would match username/fullname 'achapin'/'Chapin, Alex' as well as 'zsmith'/'Smith, Zach'.

  • since: 3/3/05
  • access: public
object ObjectIterator getTokensBySearch (string $searchString)
  • string $searchString
Redefinition of:
AuthNMethod::getTokensBySearch()
Get an iterator of the AuthNTokens that match the search string passed.
supportsPropertyUpdates (line 446)

Return TRUE if this method supports property updates.

  • since: 3/1/05
  • access: public
boolean supportsPropertyUpdates ()
Redefinition of:
AuthNMethod::supportsPropertyUpdates()
Return TRUE if this method supports property updates.
supportsTokenAddition (line 298)

Return TRUE if this method supports token addition.

  • since: 3/1/05
  • access: public
boolean supportsTokenAddition ()
Redefinition of:
AuthNMethod::supportsTokenAddition()
Return TRUE if this method supports token addition.
supportsTokenDeletion (line 348)

Return TRUE if this method supports token deletion.

  • since: 3/1/05
  • access: public
boolean supportsTokenDeletion ()
Redefinition of:
AuthNMethod::supportsTokenDeletion()
Return TRUE if this method supports token deletion.
supportsTokenUpdates (line 392)

Return TRUE if this method supports token updates.

  • since: 3/1/05
  • access: public
boolean supportsTokenUpdates ()
Redefinition of:
AuthNMethod::supportsTokenUpdates()
Return TRUE if this method supports token updates.
tokensExist (line 149)

Return true if the tokens can be matched in the system.

  • since: 3/1/05
  • access: public
boolean tokensExist (object AuthNTokens $authNTokens)
Redefinition of:
AuthNMethod::tokensExist()
Return true if the AuthNTokens can be matched in the system.
updatePropertiesForTokens (line 462)

Update the properties for the given tokens

  • since: 3/1/05
  • access: public
void updatePropertiesForTokens (object AuthNTokens $authNTokens, object Properties $newProperties)
Redefinition of:
AuthNMethod::updatePropertiesForTokens()
Update the properties for the given tokens
updateTokens (line 408)

Update old tokens to new tokens in the system.

  • since: 3/1/05
  • access: public
void updateTokens (object AuthNTokens $oldAuthNTokens, object AuthNTokens $newAuthNTokens)
Redefinition of:
AuthNMethod::updateTokens()
Update old tokens to new tokens in the system.
_populateProperties (line 190)

A private method used to populate the Properties that correspond to the given AuthNTokens

  • since: 3/1/05
  • access: private
void _populateProperties (object AuthNTokens $authNTokens, object Properties $properties)
Redefinition of:
AuthNMethod::_populateProperties()
A private method used to populate the Properties that correspond to the given AuthNTokens

Inherited Methods

Inherited From AuthNMethod

AuthNMethod::AuthNMethod()
AuthNMethod::addTokens()
AuthNMethod::assignConfiguration()
AuthNMethod::authenticate()
AuthNMethod::authenticateTokens()
AuthNMethod::createTokens()
AuthNMethod::createTokensForIdentifier()
AuthNMethod::createTokensObject()
AuthNMethod::deleteTokens()
AuthNMethod::exists()
AuthNMethod::getAllGroups()
AuthNMethod::getDisplayNameForTokens()
AuthNMethod::getGroup()
AuthNMethod::getGroupsContainingGroup()
AuthNMethod::getGroupsContainingTokens()
AuthNMethod::getProperties()
AuthNMethod::getPropertiesForTokens()
AuthNMethod::getRootGroups()
AuthNMethod::getTokensBySearch()
AuthNMethod::getType()
AuthNMethod::isGroup()
AuthNMethod::setType()
AuthNMethod::supportsDirectory()
AuthNMethod::supportsPropertyUpdates()
AuthNMethod::supportsTokenAddition()
AuthNMethod::supportsTokenDeletion()
AuthNMethod::supportsTokenUpdates()
AuthNMethod::tokensExist()
AuthNMethod::updatePropertiesForTokens()
AuthNMethod::updateTokens()
AuthNMethod::_populateProperties()

Documentation generated on Wed, 19 Sep 2007 10:26:39 -0400 by phpDocumentor 1.3.0RC3