Docs For Class LDAPAuthNMethod

Class LDAPAuthNMethod

Description

The LDAPAuthNMethod is used to authenticate against an LDAP system.

version: $Id: LDAPAuthNMethod.class.php,v 1.17 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/LDAPAuthNMethod.class.php (line 25)

AuthNMethod
   |
   --LDAPAuthNMethod

Method Summary

object assignConfiguration (object Properties $configuration)

boolean authenticateTokens (object AuthNTokens $authNTokens)

object Tokens createTokensObject ()

object AgentIterator getAllGroups (object AuthNTokens $authNTokens)

object ObjectIterator getClassTokensBySearch (string $searchString)

object AgentIterator getGroup (object Id $id)

object AgentIterator getGroupsContainingGroup (object Id $id, mixed $includeSubgroups)

object AgentIterator getGroupsContainingTokens (object AuthNTokens $authNTokens, mixed $includeSubgroups)

object ObjectIterator getGroupTokensBySearch (string $searchString)

object AgentIterator getRootGroups (object AuthNTokens $authNTokens)

object ObjectIterator getTokensBySearch (string $searchString)

boolean isGroup (object Id $id)

boolean supportsDirectory ()

boolean tokensExist (object AuthNTokens $authNTokens)

void _populateProperties (object AuthNTokens $authNTokens, object Properties $properties)

Methods

assignConfiguration (line 38)

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 78)

Authenticate an AuthNTokens object

since: 3/1/05
access: public

boolean authenticateTokens (object AuthNTokens $authNTokens)

object AuthNTokens $authNTokens

Redefinition of:

AuthNMethod::authenticateTokens(): Authenticate a Tokens object

createTokensObject (line 57)

Create a Tokens Object

since: 3/1/05
access: public

object Tokens createTokensObject ()

Redefinition of:

AuthNMethod::createTokensObject(): Create a Tokens Object

getAllGroups (line 290)

Answer an iterator of all groups

since: 2/23/06
access: public

object AgentIterator getAllGroups (object AuthNTokens $authNTokens)

object AuthNTokens $authNTokens

Redefinition of:

AuthNMethod::getAllGroups(): Answer an iterator of all groups

getClassTokensBySearch (line 236)

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 getClassTokensBySearch (string $searchString)

string $searchString

getGroup (line 331)

Answer a group by Id

since: 2/23/06
access: public

object AgentIterator getGroup (object Id $id)

object Id $id

Redefinition of:

AuthNMethod::getGroup(): Answer a group by Id

getGroupsContainingGroup (line 409)

Answer an iterator of groups that contain the Id. If $includeSubgroups is true then groups will be returned if any descendent group contains the Id.

since: 2/23/06
access: public

object AgentIterator getGroupsContainingGroup (object Id $id, mixed $includeSubgroups)

object Id $id

Redefinition of:

AuthNMethod::getGroupsContainingGroup(): Answer an iterator of groups that contain the Id. If $includeSubgroups is true then groups will be returned if any descendent group contains the Id.

getGroupsContainingTokens (line 364)

Answer an iterator of groups that contain the tokens. If $includeSubgroups is true then groups will be returned if any descendent group contains the tokens.

since: 2/23/06
access: public

object AgentIterator getGroupsContainingTokens (object AuthNTokens $authNTokens, mixed $includeSubgroups)

object AuthNTokens $authNTokens

Redefinition of:

AuthNMethod::getGroupsContainingTokens(): Answer an iterator of groups that contain the tokens. If $includeSubgroups is true then groups will be returned if any descendent group contains the tokens.

getGroupTokensBySearch (line 194)

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

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 getGroupTokensBySearch (string $searchString)

string $searchString

getRootGroups (line 303)

Answer an iterator of the top-level groups, may be equivalent to getAllGroups() if this directory is not hierarchically organized.

since: 2/23/06
access: public

object AgentIterator getRootGroups (object AuthNTokens $authNTokens)

object AuthNTokens $authNTokens

Redefinition of:

AuthNMethod::getRootGroups(): Answer an iterator of the top-level groups, may be equivalent to getAllGroups() if this directory is not hierarchically organized.

getTokensBySearch (line 152)

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

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.

isGroup (line 348)

Answer a true if the Id corresponds to a valid group.

since: 2/23/06
access: public
todo: search on DN and ObjectClass

boolean isGroup (object Id $id)

object Id $id

Redefinition of:

AuthNMethod::isGroup(): Answer a true if the Id corresponds to a valid group

supportsDirectory (line 277)

Answer TRUE if this AuthN method supports directory functionality

since: 2/23/06
access: public

boolean supportsDirectory ()

Redefinition of:

AuthNMethod::supportsDirectory(): Answer TRUE if this AuthN method supports directory functionality

tokensExist (line 92)

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

since: 3/1/05
access: public

boolean tokensExist (object AuthNTokens $authNTokens)

object AuthNTokens $authNTokens

Redefinition of:

AuthNMethod::tokensExist(): Return true if the AuthNTokens can be matched in the system.

_populateProperties (line 107)

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)

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:24:49 -0400 by phpDocumentor 1.3.0RC3