Package AccessGrid :: Package Security :: Module AuthorizationManager :: Class AuthorizationManagerIW
[show private | hide private]
[frames | no frames]

Class AuthorizationManagerIW

SOAPIWrapper --+
               |
              AuthorizationManagerIW

Known Subclasses:
AuthorizationIWMixIn

This object is designed to provide a simple interface that hides the network plumbing between clients and servers. The client side of this is just a functional interface through this object.
Method Summary
  __init__(self, url)
Create the client side object for the authorization service specified by the url.
  AddAction(self, name)
Add an action to the authorization manager.
  AddRole(self, name)
Add a role to the authorization manager.
  AddRolesToAction(self, roleList, action)
Add multiple roles to an action.
  AddRoleToAction(self, role, action)
Add a role to the specified action.
  AddSubjectsToRole(self, subjList, role)
Add a list of subjects to a particular role.
  AddSubjectToRole(self, subj, role)
Add a subject to a particular role.
  FindRole(self, name)
Find a role in this authorization manager.
  GetPolicy(self)
Retrieve the policy.
  GetRolesForSubject(self, subject)
Get the list of roles the subject is a part of.
  ImportPolicy(self, policy)
Imports a policy.
  IsAuthorized(self, subject, action)
Check to see if the subject authorized for the action.
  ListActions(self, subject, role)
List the actions known by this authorization manager.
  ListRoles(self)
Retrieve the entire list of Roles.
  ListRolesInAction(self, action)
List the roles associated with a specific action.
  ListSubjects(self, role)
List subjects that are in a specific role.
  RemoveAction(self, name)
Remove an action from the authorization manager.
  RemoveRole(self, name)
Remove a role from the authorization manager.
  RemoveRoleFromAction(self, role, action)
Remove a Role from the action.
  RemoveSubjectFromRole(self, subj, role)
Remove the subject from the role.
  RemoveSubjectsFromRole(self, subjList, role)
Remove multiple subjects from the role.
  TestImportExport(self, policy)
A test call that verifies the policy can be imported and exported without modification.
    Inherited from SOAPIWrapper
  _IsValid(self)
Method to provide interface verification.
  IsValid(self)
Method to provide interface verification.

Method Details

__init__(self, url=None)
(Constructor)

Create the client side object for the authorization service specified by the url.
Parameters:
url - url to the authorization service
           (type=a string containing the url)
Overrides:
AccessGrid.hosting.SOAPInterface.SOAPIWrapper.__init__

AddAction(self, name)

Add an action to the authorization manager.
Parameters:
name - the name of the action to add
           (type=string)

AddRole(self, name)

Add a role to the authorization manager.
Parameters:
name - the name of the role to add.
           (type=string)

AddRolesToAction(self, roleList, action)

Add multiple roles to an action.

WARNING: this has to marshall data.
Parameters:
roleList - the list of roles to add to the action.
           (type=a list of AccessGrid.Security.Role objects)
action - the action that gets the roles added to it
           (type=an AccessGrid.Security.Action object)

AddRoleToAction(self, role, action)

Add a role to the specified action.

WARNING: this has to marshall data.
Parameters:
role - the role to add to the action
           (type=AccessGrid.Security.Role object)
action - the action that gets the role added
           (type=AccessGrid.Security.Action object)

AddSubjectsToRole(self, subjList, role)

Add a list of subjects to a particular role.

WARNING: this has to marshall data.
Parameters:
subjList - a list of subjects
           (type=a list of AccessGrid.Security.Subject objects)
role - the role to add the subjects to
           (type=AccessGrid.Security.Role object)

AddSubjectToRole(self, subj, role)

Add a subject to a particular role. This uses AddSubjectsToRole internally.

WARNING: this has to marshall data.
Parameters:
subj - the subject to add
           (type=AccessGrid.Security.Subject object)
role - the role to add the subject to
           (type=AccessGrid.Security.Role object)

FindRole(self, name)

Find a role in this authorization manager.
Parameters:
name - the name of the role to find
           (type=string)
Returns:
the AccessGrid.Security.Role object or None

GetPolicy(self)

Retrieve the policy.
Returns:
a string containing an XML formatted authorization policy.

GetRolesForSubject(self, subject)

Get the list of roles the subject is a part of.

WARNING: this has to marshall data.
Parameters:
subject - the subject the roles are for
           (type=AccessGrid.Security.Subject object)
Returns:
list of AccessGrid.Security.Role objects

ImportPolicy(self, policy)

Imports a policy.
Parameters:
policy - an authorization policy
           (type=a string containing an XML formatted policy.)

IsAuthorized(self, subject, action)

Check to see if the subject authorized for the action.

WARNING: this has to marshall data.
Parameters:
subject - the subject being verified.
           (type=AccessGrid.Security.Subject object)
action - the action the subject is being verified for.
           (type=AccessGrid.Security.Action object.)

ListActions(self, subject=None, role=None)

List the actions known by this authorization manager.

WARNING: this has to marshall data.
Returns:
a list of AccessGrid.Security.Action objects.

ListRoles(self)

Retrieve the entire list of Roles.

This involves marshalling data across the wire.
Returns:
a list of AccessGrid.Security.Role objects

ListRolesInAction(self, action)

List the roles associated with a specific action.

WARNING: this has to marshall data.
Parameters:
action - the action to list roles for.
           (type=AccessGrid.Security.Action)
Returns:
list of AccessGrid.Security.Role objects

ListSubjects(self, role=None)

List subjects that are in a specific role.

WARNING: this has to marshall data.
Parameters:
role - the role to list the subjects of.
           (type=an AccessGrid.Security.Role object)
Returns:
a list of AccessGrid.Security.Subject objects

RemoveAction(self, name)

Remove an action from the authorization manager.
Parameters:
name - the name of the action to remove
           (type=string.)

RemoveRole(self, name)

Remove a role from the authorization manager.
Parameters:
name - the name of the role to remove.
           (type=string)

RemoveRoleFromAction(self, role, action)

Remove a Role from the action.

WARNING: this has to marshall data.
Parameters:
role - the role to remove from the action
           (type=AccessGrid.Security.Role object)
action - the action to remove the role from
           (type=AccessGrid.Security.Action object)

RemoveSubjectFromRole(self, subj, role)

Remove the subject from the role.

WARNING: this has to marshall data.
Parameters:
subj - the subject to remove
           (type=AccessGrid.Security.Subject object)
role - the role to remove the subject from
           (type=AccessGrid.Security.Role object)

RemoveSubjectsFromRole(self, subjList, role)

Remove multiple subjects from the role.

WARNING: this has to marshall data.
Parameters:
subjList - the list of subjects to remove
           (type=a list of AccessGrid.Security.Subject objects)
role - the role to remove the subject from
           (type=AccessGrid.Security.Role object)

TestImportExport(self, policy)

A test call that verifies the policy can be imported and exported without modification.
Parameters:
policy - an authorization policy
           (type=a string containing an XML formatted policy.)

Generated by Epydoc 2.1 on Thu Apr 14 16:39:30 2005 http://epydoc.sf.net