Package AccessGrid :: Module VenueServer :: Class VenueServerI
[show private | hide private]
[frames | no frames]

Class VenueServerI

    SOAPInterface --+        
                    |        
AuthorizationManagerI --+    
                        |    
      AuthorizationIMixIn --+
                            |
            SOAPInterface --+
                            |
                           VenueServerI


This is the SOAP interface to the venue server.
Method Summary
  __init__(self, impl)
The server side interface object.
  AddAdministrator(self, subjStr)
LEGACY CALL: This is replace by GetAuthorizationManager.
  AddVenue(self, venueDescStruct)
Inteface call for Adding a venue.
  Checkpoint(self)
Interface to checkpoint the Venue Server.
  DumpDebugInfo(self, flag)
Dump debug info.
  GetAddressAllocationMethod(self)
Interface for getting the Address Allocation Method.
  GetAddressMask(self)
Interface to retrieve the address mask of the address allocation pool.
  GetAdministrators(self)
LEGACY CALL: This is replace by GetAuthorizationManager.
  GetBackupServer(self)
Interface to retrieve the value of the backup server name.
  GetBaseAddress(self)
Interface to retrieve the base address for the address allocation pool.
  GetDefaultVenue(self)
Interface for getting the URL to the default venue.
  GetEncryptAllMedia(self)
Interface to retrieve the value of the media encryption flag.
  GetStorageLocation(self)
Inteface for getting the current data store path.
  GetVenues(self)
This is the interface to get a list of Venues from the Venue Server.
  ModifyVenue(self, URL, venueDescStruct)
Interface for modifying an existing Venue.
  RegenerateEcryptionKeys(self)
Interface method to regenerate all encryption keys for all venues on this server.
  RemoveAdministrator(self, string)
LEGACY CALL: This is replace by GetAuthorizationManager.
  RemoveVenue(self, URL)
Interface for removing a Venue.
  SetAddressAllocationMethod(self, method)
Interface for setting the address allocation method for multicast addresses (for now).
  SetAddressMask(self, mask)
Interface to set the network mask of the address allocation pool.
  SetBackupServer(self, server)
Interface for setting a fallback venue server.
  SetBaseAddress(self, address)
Interface for setting the base address for the allocation pool.
  SetDefaultVenue(self, URL)
Interface to set default venue.
  SetEncryptAllMedia(self, value)
Interface for setting the flag to encrypt all media or turn it off.
  SetStorageLocation(self, location)
Interface for setting the location of the data store.
  Shutdown(self, secondsFromNow)
Interface to shutdown the Venue Server.
    Inherited from AuthorizationIMixIn
  GetAuthorizationManager(self)
Accessor to retrieve the authorization manager from the mixin.
    Inherited from AuthorizationManagerI
  AddAction(self, action)
Add an action to the authorization manager.
  AddRole(self, role)
Add a role to the authorization manager.
  AddRolesToAction(self, action, roleList)
Add multiple roles to an action.
  AddRoleToAction(self, action, role)
Add a role to the specified action.
  AddSubjectsToRole(self, role, subjectList)
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)
Import 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, action)
Retrieve the entire list of Roles.
  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, action, role)
Remove a Role from the action.
  RemoveSubjectsFromRole(self, role, subjectList)
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 SOAPInterface
  _IsValid(self)
This method is here to support calls that just want to see if there is a valid server endpoint for communication from the client.
  IsValid(self)
This method is here to support calls that just want to see if there is a valid server endpoint for communication from the client.

Method Details

__init__(self, impl)
(Constructor)

The server side interface object. This gets an implementation to initialize itself with.
Parameters:
impl - the implementation object this interface represents
           (type=AccessGrid.Security.AuthorizationManager)
Overrides:
AccessGrid.Security.AuthorizationManager.AuthorizationManagerI.__init__ (inherited documentation)

AddAdministrator(self, subjStr)

LEGACY CALL: This is replace by GetAuthorizationManager.

Interface to add an administrator to the Venue Server.

**Arguments:**

*subjStr* The DN of the new administrator.

**Raises:**

**Returns:**

*subjStr* The DN of the administrator added.

AddVenue(self, venueDescStruct)

Inteface call for Adding a venue.

**Arguments:**

    *Venue Description Struct* A description of the new
    venue, currently an anonymous struct.

**Raises:**
    *VenueServerException* When the venue description struct
    isn't successfully converted to a real venue description
    object and the venue isn't added.

**Returns:**
    *Venue URI* Upon success a uri to the new venue is returned.

Checkpoint(self)

Interface to checkpoint the Venue Server.

**Arguments:** **Raises:** **Returns:**

DumpDebugInfo(self, flag=None)

Dump debug info. The 'flag' argument is not used now, but could be used later to control the dump

GetAddressAllocationMethod(self)

Interface for getting the Address Allocation Method.

**Arguments:**
**Raises:**
**Returns:**
    *method* The address allocation method configured, either
    RANDOM or INTERVAL.

GetAddressMask(self)

Interface to retrieve the address mask of the address allocation pool.

**Arguments:**
**Raises:**
**Returns:**
    *mask* the network mask of the address allocation pool.

GetAdministrators(self)

LEGACY CALL: This is replace by GetAuthorizationManager.

GetAdministrators returns a list of adminisitrators for this VenueServer.

GetBackupServer(self)

Interface to retrieve the value of the backup server name.

**Arguments:**
**Raises:**
**Returns:**
    the string hostname of the back up server or "".

GetBaseAddress(self)

Interface to retrieve the base address for the address allocation pool.

**Arguments:**
**Raises:**
**Returns:**
    *base address* the base address of the address allocation pool.

GetDefaultVenue(self)

Interface for getting the URL to the default venue.

GetEncryptAllMedia(self)

Interface to retrieve the value of the media encryption flag.

**Arguments:** **Raises:** **Returns:**

GetStorageLocation(self)

Inteface for getting the current data store path.

**Arguments:**
**Raises:**
**Returns:**
    *location* The path to the data store location.

GetVenues(self)

This is the interface to get a list of Venues from the Venue Server.

**Returns:**
    *venue description list* A list of venues descriptions.

ModifyVenue(self, URL, venueDescStruct)

Interface for modifying an existing Venue.

**Arguments:**
    *URL* The URL to the venue.

    *Venue Description Struct* An anonymous struct that is the
    new venue description.

**Raises:**
    *InvalideVenueURL* When the URL isn't a valid venue.

    *InvalidVenueDescription* If the Venue Description has a
    different URL than the URL argument passed in.

RegenerateEcryptionKeys(self)

Interface method to regenerate all encryption keys for all venues on this server.

RemoveAdministrator(self, string)

LEGACY CALL: This is replace by GetAuthorizationManager.

**Arguments:**

*string* The Distinguished Name (DN) of the administrator being removed.

**Raises:**

**Returns:**

*string* The Distinguished Name (DN) of the administrator removed.

RemoveVenue(self, URL)

Interface for removing a Venue.

**Arguments:**
    *URL* The url to the venue to be removed.

SetAddressAllocationMethod(self, method)

Interface for setting the address allocation method for
multicast addresses (for now).

**Arguments:**

    *method* An argument specifying either RANDOM or INTERVAL
    allocation. RANDOM is a random address from the standard
    random range. INTERVAL means a random address from a
    specified range.

**Raises:**

**Returns:**

SetAddressMask(self, mask)

Interface to set the network mask of the address allocation pool.

**Arguments:**
    *mask*  The network mask for the address allocation pool.
**Raises:**
**Returns:**

SetBackupServer(self, server)

Interface for setting a fallback venue server.

**Arguments:**
    *server* The string hostname of the server.
**Raises:**
**Returns:**
    *server* the return value from SetBackupServer

SetBaseAddress(self, address)

Interface for setting the base address for the allocation pool.

**Arguments:**
    *address* The base address of the address pool to allocate from.
**Raises:**
**Returns:**

SetDefaultVenue(self, URL)

Interface to set default venue.

**Arguments:**
    *URL* The URL to the default venue.

**Raises:**

**Returns:**
    *URL* the url of the default venue upon success.

SetEncryptAllMedia(self, value)

Interface for setting the flag to encrypt all media or turn it off.

**Arguments:**
    *value* The flag, 1 turns encryption on, 0 turns encryption off.
**Raises:**
**Returns:**
    *flag* the return value from SetEncryptAllMedia.

SetStorageLocation(self, location)

Interface for setting the location of the data store.

**Arguments:**


    *location* This is a path for the data store.

**Raises:**
**Returns:**
    *location* The new location on success.

Shutdown(self, secondsFromNow)

Interface to shutdown the Venue Server.

**Arguments:**
    *secondsFromNow* How long from the time the call is
    received until the server starts to shutdown.
**Raises:**
**Returns:**

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