AccessGrid.VenueServer.VenueServer

Package AccessGrid :: Module VenueServer :: Class VenueServer

[show private | hide private]

Class VenueServer

AuthorizationMixIn --+
                     |
                    VenueServer

The Virtual Venue Server object is responsible for creating,
destroying, and configuring Virtual Venue objects.

**Extends:**

    *AccessGrid.hosting.pyGlobus.ServiceBase.*

Method Summary
	`__init__(self, hostEnvironment, configFile)` The constructor creates a new Venue Server object, initializes that object, then registers signal handlers so the venue can cleanly shutdown in the event of catastrophic signals.
	`AddVenue(self, venueDesc, authPolicy)` The AddVenue method takes a venue description and creates a new Venue Object, complete with a event service, then makes it available from this Venue Server.
	`Checkpoint(self)` Checkpoint stores the current state of the running VenueServer to non-volatile storage.
	`CleanupVenueClients(self)`
	`DumpDebugInfo(self)` Dump debug info.
	`GetAddressAllocationMethod(self)` Get the method used for multicast address allocation:...
	`GetAddressMask(self)` Get address mask used when allocating multicast addresses in an interval
	`GetBackupServer(self)` Get the server wide default for venue media encryption.
	`GetBaseAddress(self)` Get base address used when allocating multicast addresses in an interval
	`GetDefaultVenue(self)` GetDefaultVenue returns the URL to the default Venue on the VenueServer.
	`GetEncryptAllMedia(self)` Get the server wide default for venue media encryption.
	`GetStorageLocation(self)` Get the path for data storage
	`GetVenues(self)` GetVenues returns a list of Venues Descriptions for the venues hosted by this VenueServer.
	`InitFromFile(self, config)`
	`LoadPersistentVenues(self, filename)` This method loads venues from a persistent store.
	`MakeVenueURL(self, uniqueId)` Helper method to make a venue URI from a uniqueId.
	`ModifyVenue(self, oid, venueDesc)` ModifyVenue updates a Venue Description.
	`RegenerateEncryptionKeys(self)` This regenerates all the encryptions keys in all the venues.
	`RemoveVenue(self, oid)` RemoveVenue removes a venue from the VenueServer.
	`Report(self)`
	`SetAddressAllocationMethod(self, addressAllocationMethod)` Set the method used for multicast address allocation:...
	`SetAddressMask(self, mask)` Set address mask used when allocating multicast addresses in an interval
	`SetBackupServer(self, server)` Turn on or off server wide default for venue media encryption.
	`SetBaseAddress(self, address)` Set base address used when allocating multicast addresses in an interval
	`SetDefaultVenue(self, oid)` SetDefaultVenue sets which Venue is the default venue for the VenueServer.
	`SetEncryptAllMedia(self, value)` Turn on or off server wide default for venue media encryption.
	`SetStorageLocation(self, dataStorageLocation)` Set the path for data storage
	`Shutdown(self)` Shutdown shuts down the server.
Inherited from AuthorizationMixIn
	`AddRequiredRole(self, role)` Add a role to the list of required roles for this implementation.
	`GetAuthorizationManager(self)` Get the URL for the Authorization Manager.
	`GetRequiredRoles(self)` Return a list of roles required by this implementation for authorization to work.

Class Variable Summary
`dict`	`configDefaults` = `{'VenueServer.performanceReportFile': '...`
`VenueDescription`	`defaultVenueDesc` = `[0000010342a6ad1d008c00dd00220047416]...`

Method Details

init(self, hostEnvironment=None, configFile=None)
(Constructor)

The constructor creates a new Venue Server object, initializes
that object, then registers signal handlers so the venue can cleanly
shutdown in the event of catastrophic signals.

**Arguments:**
- *hostingEnvironment* a reference to the hosting environment.
- *configFile* the filename of a configuration file for this venue server.

Overrides:: AccessGrid.Security.AuthorizationManager.AuthorizationMixIn.__init__

AddVenue(self, venueDesc, authPolicy=None)

The AddVenue method takes a venue description and creates a new Venue Object, complete with a event service, then makes it available from this Venue Server.

Checkpoint(self)

Checkpoint stores the current state of the running VenueServer to non-volatile storage. In the event of catastrophic failure, the non-volatile storage can be used to restart the VenueServer.

The fequency at which Checkpointing is done will bound the amount of state that is lost (the longer the time between checkpoints, the more that can be lost).

DumpDebugInfo(self)

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

GetAddressAllocationMethod(self)

Get the method used for multicast address allocation:
    either RANDOM or INTERVAL (defined in MulticastAddressAllocator)

GetAddressMask(self)

Get address mask used when allocating multicast addresses in an interval

GetBackupServer(self)

Get the server wide default for venue media encryption.

GetBaseAddress(self)

Get base address used when allocating multicast addresses in an interval

GetDefaultVenue(self)

GetDefaultVenue returns the URL to the default Venue on the VenueServer.

GetEncryptAllMedia(self)

Get the server wide default for venue media encryption.

GetStorageLocation(self)

Get the path for data storage

GetVenues(self)

GetVenues returns a list of Venues Descriptions for the venues
hosted by this VenueServer.

**Arguments:**

**Raises:**

    **VenueServerException** This is raised if there is a
    problem creating the list of Venue Descriptions.

**Returns:**

    This returns a list of venue descriptions.

LoadPersistentVenues(self, filename)

This method loads venues from a persistent store.

**Arguments:**

    *filename* The filename for the persistent store. It is
    currently a INI formatted file.

MakeVenueURL(self, uniqueId)

Helper method to make a venue URI from a uniqueId.

ModifyVenue(self, oid, venueDesc)

ModifyVenue updates a Venue Description.

RegenerateEncryptionKeys(self)

This regenerates all the encryptions keys in all the venues.

RemoveVenue(self, oid)

RemoveVenue removes a venue from the VenueServer.

**Arguments:**
    *ID* The id of the venue to be removed.

**Raises:**

    *UnbindVenueError* - This exception is raised when the
    hosting Environment fails to unbind the venue from the
    venue server.

    *VenueNotFound* - This exception is raised when the
    the venue is not found in the list of venues for this server.

SetAddressAllocationMethod(self, addressAllocationMethod)

Set the method used for multicast address allocation:
    either RANDOM or INTERVAL (defined in MulticastAddressAllocator)

SetAddressMask(self, mask)

Set address mask used when allocating multicast addresses in an interval

SetBackupServer(self, server)

Turn on or off server wide default for venue media encryption.

SetBaseAddress(self, address)

Set base address used when allocating multicast addresses in an interval

SetDefaultVenue(self, oid)

SetDefaultVenue sets which Venue is the default venue for the VenueServer.

SetEncryptAllMedia(self, value)