AuthorizationManager allows an application to create Authorizations, get Authorizations given selection criterias, ask questions of Authorization such as what agentId can do a Function in a Qualifier context, etc.
The primary objects in Authorization are Authorization, Function, agentId, and Qualifier. There are also Function and Qualifier types that are understood by the implementation.
Ids in Authorization are externally defined and their uniqueness is enforced by the implementation.
There are two methods to create Authorizations. One method uses agentId, Function, and Qualifier. The other adds effective date and expiration date. For the method without the dates, the effective date is today and there is no expiration date.
All implementations of OsidManager (manager) provide methods for accessing and manipulating the various objects defined in the OSID package. A manager defines an implementation of an OSID. All other OSID objects come either directly or indirectly from the manager. New instances of the OSID objects are created either directly or indirectly by the manager. Because the OSID objects are defined using interfaces, create methods must be used instead of the new operator to create instances of the OSID objects. Create methods are used both to instantiate and persist OSID objects. Using the OsidManager class to define an OSID's implementation allows the application to change OSID implementations by changing the OsidManager package name used to load an implementation. Applications developed using managers permit OSID implementation substitution without changing the application source code. As with all managers, use the OsidLoader to load an implementation of this interface.
OSID Version: 2.0
Licensed under the org.osid.SidImplementationLicenseMIT.
Located in /harmoni/oki2/osid/authorization/AuthorizationManager.php (line 57)
OsidManager | --AuthorizationManager
| Class | Description |
|---|---|
| HarmoniAuthorizationManager | AuthorizationManager allows an application to create Authorizations, get Authorizations given selection criterias, ask questions of Authorization such as what agentId can do a Function in a Qualifier context, etc. |
Return true if the agentId exists in the Authorization Service; false otherwise. This is not asking if there are any Authorizations that reference this agentId. This is not asking if the agentId is known to the Agent OSID.
Creates a new Authorization for a Agent performing a Function with a Qualifier. Uses current date/time as the effectiveDate and doesn't set an expiration date.
Creates a new Authorization for an Agent performing a Function with a Qualifier.
Ids in Authorization are externally defined and their uniqueness is enforced by the implementation.
Ids in Authorization are externally defined and their uniqueness is
enforced by the implementation. Creates a new Qualifier in the Authorization Service. This is different than making a new instance of a Qualifier object locally as the Qualifier will be inserted into the Authorization Service.
Creates a new Qualifier in the Authorization Service that has no parent.
This is different from making a new instance of a Qualifier object locally as the Qualifier will be inserted into the Authorization Service.
Deletes an existing Authorization.
Delete a Function by Id.
Delete a Qualifier by Id. The last root Qualifier cannot be deleted.
Given a functionId and a qualifierId returns all Authorizations that
would allow agents to do the Function with the Qualifier. This method differs from the simple form of getAuthorizations in that this method looks for any Authorization that permits doing the Function with the Qualifier even if the Authorization's Qualifier happens to be a parent of this Qualifier argument.
Given a FunctionType and a qualifierId returns all Authorizations that
would allow Agents to do Functions in the FunctionType with the Qualifier. This method differs from getAuthorizations in that this method looks for any Authorization that permits doing the Function with the Qualifier even if the Authorization's Qualifier happens to be a parent of the Qualifier argument.
Given a functionId and a qualifierId returns all Authorizations that
would allow the user to do the Function with the Qualifier. This method differs from the simple form of getAuthorizations in that this method looks for any Authorization that permits doing the Function with the Qualifier even if the Authorization's Qualifier happens to be a parent of this Qualifier argument.
Given a FunctionType and a qualifierId returns all Authorizations that
would allow the user to do Functions in the FunctionType with the Qualifier. This method differs from getAuthorizations in that this method looks for any Authorization that permits doing the Function with the Qualifier even if the Authorization's Qualifier happens to be a parent of the Qualifier argument.
Given a agentId, a functionId, and a qualifierId (at least one of these must be non-null) returns the matching Authorizations. Explicit Authorizations can be modified. Any null argument will be treated as a wildcard.
Given a agentId, a FunctionType, and a qualifierId (either agentId or qualifierId must be non-null) returns the matching Authorizations. The Authorizations must be for Functions within the given FunctionType.
Explicit Authorizations can be modified. Any null argument will be treated as a wildcard.
Given a functionId and qualifierId (one must be non-null) returns the matching user Authorizations. Explicit Authorizations can be modified.. Any null argument will be treated as a wildcard.
Given a FunctionType and qualifierId returns the matching user Authorizations. The Authorizations must be for Functions within the given FunctionType. Explicit Authorizations can be modified. Any null argument will be treated as a wildcard.
Given an implicit returns the matching explicit user Authorizations.
Explicit Authorizations can be modified. A null argument will be treated as a wildcard.
Get all the Functions of the specified Type.
Get all the FunctionTypes supported by the Authorization implementation.
Given an existing qualifierId returns the Ids of its child Qualifiers.
Given an existing qualifierId returns the Ids of all descendants including its child Qualifiers.
Returns the Qualifier Hierarchies supported by the Authorization implementation. Qualifier Hierarchies are referenced by Id and may be known and managed through the Hierarchy OSID.
Get all the QualifierTypes supported by the Authorization implementation.
Given a hierarchyId, returns the Qualifiers at the root of the specified Hierarchy.
Given a functionId and a qualifierId returns the Ids of all Agents allowed to do the Function with the Qualifier. A null qualifierId is treated as a wildcard.
Given an agentId, functionId, and qualifierId returns true if the Agent is authorized now to perform the Function with the Qualifier.
Given a functionId and qualifierId returns true if the user is authorized now to perform the Function with the Qualifier.
This method indicates whether this implementation supports AuthorizationManager methods: createFunction, deleteFunction. Function methods: updateDescription, updateDisplayName.
This method indicates whether this implementation supports
AuthorizationManager methods: createAuthorization, createDatedAuthorization, createQualifier, createRootQualifier, deleteAuthorization, deleteQualifier, getFunctionTypes, getQualifier, getQualifierChildren, getQualifierDescendents, getQualifierHierarchies, getQualifierTypes, getRootQualifiers, getWhoCanDo. Function methods: getDescription, getDisplayName, getFunctionType, getId, getQualifierHierarchy. Qualifier methods: addParent, changeParent, getChildren, getDescription, getDisplayName, isParent, getId, getParents, getQualifierType, isChildOf, isDescendentOf, removeParent, updateDescription, updateDisplayName.
Inherited From OsidManager
OsidManager::assignConfiguration()
OsidManager::assignOsidContext()
OsidManager::getOsidContext()
OsidManager::osidVersion_2_0()
Documentation generated on Wed, 19 Sep 2007 10:21:41 -0400 by phpDocumentor 1.3.0RC3