Class AuthNMethodManager

Description
Description | Methods (details)

The AuthNMethodManager handles the management of Authentication Types and the AuthNMethods that correspond to those types. Neither the AuthNMethodManager nor AuthNMethods maintain any information about authentication states. They simply provide the means of checking that authentication when desired.

  • version: $Id: AuthNMethodManager.class.php,v 1.8 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/AuthNMethodManager.class.php (line 24) 

OsidManager
   |
   --AuthNMethodManager
Method Summary
Description | Methods (details)
object AuthNMethodManager ()
object AuthNMethod addAuthNMethodWithType (object AuthNMethod $authNMethod, object Type $authNType)
void assignConfiguration (object Properties $configuration)
void assignOsidContext (mixed $context, object OsidContext $context )
object AuthNMethod getAuthNMethodForType (object Type $authNType)
object TypeIterator getAuthNTypes ()
object OsidContext getOsidContext ()
integer _getKey (object Type $authNType)
string _typeToString (object Type $type)
Methods
Description | Methods (details)
Constructor AuthNMethodManager (line 38)

Constructor. We wish to ensure that the manager is properly configured via the assignConfiguration() method and any needed context information has been passed via assignOsidContext(), so an instance variable is set here to false untill the necessary initialization has occurred.

  • since: 3/1/05
  • access: public
object AuthNMethodManager ()
addAuthNMethodWithType (line 112)

Add an Authentication Type-Method pair.

  • return: The method that was passed.
  • since: 3/2/05
  • access: public
object AuthNMethod addAuthNMethodWithType (object AuthNMethod $authNMethod, object Type $authNType)
assignConfiguration (line 92)

Assign the configuration of this OsidManager.

  • access: public
  • throws: object OsidException An exception with one of the following messages defined in org.osid.OsidException: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT
void assignConfiguration (object Properties $configuration)
  • object Properties $configuration: (original type: java.util.Properties)
Redefinition of:
OsidManager::assignConfiguration()
Assign the configuration of this OsidManager.
assignOsidContext (line 71)

Assign the context of this OsidManager.

  • access: public
  • throws: object OsidException An exception with one of the following messages defined in org.osid.OsidException: NULL_ARGUMENT
void assignOsidContext (mixed $context, object OsidContext $context )
  • object OsidContext $context
Redefinition of:
OsidManager::assignOsidContext()
Assign the context of this OsidManager.
getAuthNMethodForType (line 149)

Get an AuthNMethod based on its Type

  • since: 3/2/05
  • access: public
object AuthNMethod getAuthNMethodForType (object Type $authNType)
  • object Type $authNType
getAuthNTypes (line 136)

Get all AuthN Types

  • since: 3/2/05
  • access: public
object TypeIterator getAuthNTypes ()
getOsidContext (line 56)

Return context of this OsidManager.

  • access: public
  • throws: object OsidException
object OsidContext getOsidContext ()
Redefinition of:
OsidManager::getOsidContext()
Return context of this OsidManager.
_getKey (line 169)

Private method for matching keys to Types.

  • since: 3/2/05
  • access: public
integer _getKey (object Type $authNType)
  • object Type $authNType
_typeToString (line 187)

Private method for converting Types to strings.

  • since: 3/2/05
  • access: public
string _typeToString (object Type $type)
  • object Type $type

Inherited Methods

Inherited From OsidManager

OsidManager::assignConfiguration()
OsidManager::assignOsidContext()
OsidManager::getOsidContext()
OsidManager::osidVersion_2_0()

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