Class AgentTokenMappingManager

Description
Description | Methods (details)

The AgentTokenMappingManager manages the mappings between AgentIds and one or more sets of authentication tokens per AgentId.

AgentIds as recorded by the AgentManager OSID are essentially immutible and refer to all Agents that the system has seen, be (at a University) Faculty, Students, or people who just bought concert tickets or used the golf course. Additionally, since other records may persist that refer to the AgentId, the AgentManager does not de-reference its Ids for Agents when said people leave the institution (or die). Knowledge by the AgentManager thereby does not infer any status to an Agent.

A small sub-set of all Agents are those who are 'authenticatable'. That is, they have authentication tokens that allow them to be identified by the system when they 'log in'. These users (at a University) would usually include current Faculty, Staff, and Students, official visitors (?), trustees, and possibly even computer systems (such as an email server that logs into another information database to populate its address-book tables). Having authentication ability does not imply any authorization, but it does imply a 'current agent' status to a person or thing.

  • version: $Id: AgentTokenMappingManager.class.php,v 1.12 2007/09/13 16:04:18 adamfranco Exp $
  • license: GNU General Public License (GPL)
  • copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/agentmanagement/AgentTokenMapping/AgentTokenMappingManager.class.php (line 41) 

OsidManager
   |
   --AgentTokenMappingManager
Method Summary
Description | Methods (details)
object AgentTokenMappingManager ()
void assignConfiguration (object Properties $configuration)
void assignOsidContext (mixed $context, object OsidContext $context )
object AgentTokenMapping createMapping (object Id $agentId, object AuthNTokens $authNTokens, object Type $authenticationType)
void deleteMapping (object AgentTokenMapping $mapping)
mixed getMappingForTokens (object AuthNTokens $authNTokens, object Type $authenticationType)
object ObjectIterator getMappingsForAgentId (object Id $agentId)
object AgentTokenMapping getMappingsForAgentIdAndAuthenticationType (object Id $agentId, object Type $authenticationType)
object OsidContext getOsidContext ()
boolean mappingExists (object Id $agentId, object AuthNTokens $authNTokens, object Type $authenticationType)
void _checkConfig ()
array _createMappingsFromResult (object SelectQueryResult $result)
object SelectQuery _createSelectQuery ()
integer _getTypeKey (object Type $type)
boolean _mappingExistsForTokens (object AuthNTokens $authNTokens, object Type $authenticationType)
Methods
Description | Methods (details)
Constructor AgentTokenMappingManager (line 54)

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 AgentTokenMappingManager ()
assignConfiguration (line 108)

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

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.
createMapping (line 128)

Create a new mapping between AuthNTokens and an AgentId.

  • since: 3/1/05
  • access: public
object AgentTokenMapping createMapping (object Id $agentId, object AuthNTokens $authNTokens, object Type $authenticationType)
deleteMapping (line 188)

Remove the mapping between AuthNTokens and an Agent

  • since: 3/9/05
  • access: public
void deleteMapping (object AgentTokenMapping $mapping)
getMappingForTokens (line 241)

Return the mapping for an AuthNTokens.

  • return: AgentTokenMapping OR FALSE if not found.
  • since: 3/9/05
  • access: public
mixed getMappingForTokens (object AuthNTokens $authNTokens, object Type $authenticationType)
getMappingsForAgentId (line 326)

Return an iterator of all of the mappings for an Agent Id across all of the AuthenticationTypes

  • since: 3/9/05
  • access: public
object ObjectIterator getMappingsForAgentId (object Id $agentId)
  • object Id $agentId
getMappingsForAgentIdAndAuthenticationType (line 286)

Return the mapping for an Agent Id.

  • since: 3/9/05
  • access: public
object AgentTokenMapping getMappingsForAgentIdAndAuthenticationType (object Id $agentId, object Type $authenticationType)
  • object Id $agentId
  • object Type $authenticationType
getOsidContext (line 72)

Return context of this OsidManager.

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

Return true if a mapping between AuthNTokens and an AgentId exists for this auth Type.

  • since: 3/1/05
  • access: public
boolean mappingExists (object Id $agentId, object AuthNTokens $authNTokens, object Type $authenticationType)
_checkConfig (line 464)

Check that we are configured

  • since: 3/9/05
  • access: private
void _checkConfig ()
_createMappingsFromResult (line 532)

Create an array of mapping objects from a query result.

  • since: 3/9/05
  • access: private
array _createMappingsFromResult (object SelectQueryResult $result)
  • object SelectQueryResult $result
_createSelectQuery (line 571)

Create a select query with table joins.

  • since: 3/9/05
  • access: private
object SelectQuery _createSelectQuery ()
_getTypeKey (line 478)

Get the key of the type.

  • since: 3/9/05
  • access: private
integer _getTypeKey (object Type $type)
  • object Type $type
_mappingExistsForTokens (line 414)

Return true if a mapping between AuthNTokens and an AgentId exists for this auth Type.

  • since: 3/1/05
  • access: private
boolean _mappingExistsForTokens (object AuthNTokens $authNTokens, object Type $authenticationType)

Inherited Methods

Inherited From OsidManager

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

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