AccessGrid.Venue.VenueIW

Package AccessGrid :: Module Venue :: Class VenueIW

[show private | hide private]

Class VenueIW

SOAPIWrapper --+
               |
              VenueIW

SOAP interface for a venue.

Method Summary
	`__init__(self, url, faultHandler)`
	`AddConnection(self, connection)` Connect this venue to another venue.
Descriptions.DataDescription	`AddData(self, dataDescription)` LEGACY: The implementation call is only present to support AG2.0 clients.
	`AddNetworkLocationToStream(self, privId, streamId, networkLocation)` Add a transport to an existing stream.
	`AddNetworkService(self, type, privateID)` AddNetworkService adds a net service to those in the venue
Descriptions.ServiceDescription	`AddService(self, serviceDesc)` The AddService method enables VenuesClients to put services in the Virtual Venue.
	`AddStream(self, streamDesc)` Add a stream to the list of streams for this venue.
NetworkLocation.MulticastNetworkLocation	`AllocateMulticastLocation(self)` This method creates a new Multicast Network Location.
string	`CreateApplication(self, name, description, mimeType)` Create a new application object.
	`DestroyApplication(self, aid)` Destroy an application object.
(Descriptions.VenueState, integer, [Descriptions.StreamDescription])	`Enter(self, profile)` The Enter method is used by a VenueClient to gain access to the services, clients, and content found within a Virtual Venue.
	`Exit(self, pid)` The Exit method is used by a VenueClient to cleanly leave a Virtual Venue.
dict	`GetApplication(self, aid)` Return the application state for the given application object.
[Descriptions.ApplicationDescription]	`GetApplications(self)` return the list of application descriptions for this venue.
string	`GetAuthorizationManager(self)` Get the url for the authorization manager for this venue.
[ClientProfile.ClientProfile]	`GetCachedProfiles(self)` This method returns a list of client profiles that have been registered for this venue.
[ ClientProfile.ClientProfile]	`GetClients(self)` Return a list of the clients in this venue.
[Descriptions.ConnectionDescription]	`GetConnections(self)` GetConnections returns a list of all the connections to other venues that are found within this venue.
[Descriptions.DataDescription]	`GetDataDescriptions(self)` Return all data currently in the venue.
[int]	`GetDataIDs(self)` Return all ids of data currently in the venue.
(string, string)	`GetDataStoreInformation(self)` Retrieve an upload descriptor and a URL to the Venue's DataStore
string	`GetDescription(self)` GetDescription returns the description for the venue.
int	`GetEncryptMedia(self)` Return whether we are encrypting streams or not.
((string, string), int)	`GetEventServiceLocation(self)` Get location of the venue event service
string	`GetName(self)` Get the name of the venue.
[Descriptions.AGNetworkServiceDescription].	`GetNetworkServices(self)` GetNetworkServices returns a list of all the network services in this venue.
Descriptions.ServiceDescription	`GetServices(self)` GetServices returns a list of all the services in this venue.
[Descriptions.StreamDescription]	`GetStaticStreams(self)` Returns a list of static stream descriptions
[Descriptions.StreamDescription]	`GetStreams(self)` Get the list of streams.
string	`GetUploadDescriptor(self)` Retrieve the upload descriptor from the Venue's datastore.
int	`IsValid(self)` Check if the venue soap interface is valid.
	`RecycleMulticastLocation(self, location)` This method removes a multicast network Location.
	`RegenerateEncryptionKeys(self)` RegenerateKeys allows one to regenerate the encryption keys on the venue.
	`RegisterNetworkService(self, networkServiceDescription)` Registers a network service with the venue.
	`RemoveConnection(self, connection)` Remove venue connection from this venue.
Descriptions.DataDescription	`RemoveData(self, dataDescription)` Interface for removing data.
	`RemoveNetworkLocationFromStream(self, privId, streamId, networkId)` Remove a transport from an existing stream.
	`RemoveNetworkService(self, nid)` RemoveNetworkService removes a netservice from those in the venue
	`RemoveService(self, sid)` RemoveService removes persistent service from the Virtual Venue.
	`RemoveStream(self, streamDesc)` Remove the given stream from the venue
	`SetConnections(self, connectionList)` Interface for setting all the connections in a venue.
	`SetDescription(self, description)` Set the venue description.
string	`SetEncryptMedia(self, value, key)` Turn media encryption on or off.
string	`SetName(self, name)` Set the venue name.
	`Shutdown(self)` This method cleanly shuts down all active threads associated with the venue.
	`UnRegisterNetworkService(self, networkServiceDescription)` Removes a network service from the venue
	`UpdateApplication(self, applicationDesc)` Update application.
	`UpdateClientProfile(self, profile)` UpdateClientProfile allows a VenueClient to update/modify the client profile that is stored by the Virtual Venue that they gave to the Venue when they called the Enter method.
	`UpdateData(self, dataDescription)` Find data with the same name and replace it.
Descriptions.ServiceDescription	`UpdateService(self, serviceDesc)` The UpdateService method enables VenuesClients to modify a service description.
Inherited from SOAPIWrapper
	`_IsValid(self)` Method to provide interface verification.

Method Details

AddConnection(self, connection)

Connect this venue to another venue.

Parameters:: connection - Description of venue to add
(type=Descriptions.ConnectionDescription)

Raises:: BadConnectionDescription - Raised when the connection description struct is not successfully converted to a connection description.

AddData(self, dataDescription)

LEGACY: The implementation call is only present to support AG2.0 clients.

Interface to Add data to the Venue.

Parameters:: dataDescription - The data description being added to the venue.
(type=Descriptions.DataDescription)

Returns:: A data description is returned on success.
(type=Descriptions.DataDescription)

Raises:: BadDataDescription - This is raised if the data description struct cannot be converted to a real data description.

AddNetworkLocationToStream(self, privId, streamId, networkLocation)

Add a transport to an existing stream. Note: This method overwrites the private id in the incoming network location

Parameters:: privId - Private id of the service that wants to add the location
(type=AccessGrid.GUID.GUID); streamId - The id of the stream to which to add the transport
(type=AccessGrid.GUID.GUID); networkLocation - The network location (transport) to add
(type=NetworkLocation.NetworkLocation)

AddNetworkService(self, type, privateID)

AddNetworkService adds a net service to those in the venue

Parameters:: type - Net service type
(type=string); privateID - A net service private id
(type=AccessGrid.GUID.GUID)

AddService(self, serviceDesc)

The AddService method enables VenuesClients to put services in the Virtual Venue. Service put in the Virtual Venue through AddService is persistently stored.

Returns:: service description of the added service.
(type=Descriptions.ServiceDescription)

Raises:: serviceAlreadyPresent - Raised when a service is added twice.

AddStream(self, streamDesc)

Add a stream to the list of streams for this venue.

Parameters:: streamDesc - Stream to add
(type=Descriptions.StreamDescription)

Raises:: BadStreamDescription - Invalid stream description.

AllocateMulticastLocation(self)

This method creates a new Multicast Network Location.

Returns:: A new multicast network location object.
(type=NetworkLocation.MulticastNetworkLocation)

CreateApplication(self, name, description, mimeType)

Create a new application object. Initialize the implementation, and create a web service interface for it.

Parameters:: name - A name for the application instance.
(type=string); description - A description for the new application instance.
(type=string); mimeType - A mime-type for the new application, used to match applications with clients.
(type=string)

Returns:: A url to the new application object/service.
(type=string)

DestroyApplication(self, aid)

Destroy an application object.

Raises:: ApplicationNotFound - Raised when an application is not found for the application id specified.; ApplicationUnbindError - Raised when the hosting environment can't unbind the application from the web service layer.

Enter(self, profile)

The Enter method is used by a VenueClient to gain access to the services, clients, and content found within a Virtual Venue.

Parameters:: profile - The ClientProfile of the client entering the venue.
(type=ClientProfile.ClientProfile @return:(state, privateId, streamDescriptions) This tuple is returned upon success. The state is a snapshot of the current venuestate. The privateId is a private, unique id assigned by the venue for this client session, the streamDescriptions are the stream descriptions the venue has found best match this clients capabilities.)

Returns:: (Descriptions.VenueState, integer, [Descriptions.StreamDescription])

Exit(self, pid)

The Exit method is used by a VenueClient to cleanly leave a Virtual Venue. Cleanly leaving a Virtual Venue allows the Venue to cleanup any state associated (or caused by) the VenueClients presence.

Raises:: clientNotFound - Raised when a privateId is not found in the venue list of clients.

GetApplication(self, aid)

Return the application state for the given application object.

Parameters:: aid - The id of the application being retrieved.
(type=AccessGrid.GUID.GUID)

Returns:: The state of the application object.
(type=dict)

Raises:: ApplicationNotFound - Raised when the application is not found in the venue.

GetApplications(self)

return the list of application descriptions for this venue.

Returns:: List of application descriptions
(type=[Descriptions.ApplicationDescription])

GetAuthorizationManager(self)

Get the url for the authorization manager for this venue.

Returns:: url for the authorization manager
(type=string)

GetCachedProfiles(self)

This method returns a list of client profiles that have been registered for this venue.

Returns:: A list of all cached client profiles.
(type=[ClientProfile.ClientProfile])

GetClients(self)

Return a list of the clients in this venue.

Returns:: list of client profiles
(type=[ ClientProfile.ClientProfile])

GetConnections(self)

GetConnections returns a list of all the connections to other venues that are found within this venue.

Returns:: A list of connection descriptions.
(type=[Descriptions.ConnectionDescription])

GetDataDescriptions(self)

Return all data currently in the venue.

Returns:: A list of data descriptions
(type=[Descriptions.DataDescription])

GetDataIDs(self)

Return all ids of data currently in the venue.

Returns:: A list of data ids
(type=[int])

GetDataStoreInformation(self)

Retrieve an upload descriptor and a URL to the Venue's DataStore

Returns:: a tuple with the upload descriptor to the Venue's DataStore and the url to the DataStore SOAP service.
(type=(string, string))

GetDescription(self)

GetDescription returns the description for the venue.

Returns:: Description for the venue.
(type=string)

GetEncryptMedia(self)

Return whether we are encrypting streams or not.

Returns:: 1 if we are encrypting streams
(type=int)

GetEventServiceLocation(self)

Get location of the venue event service

Returns:: tuple including location (host,port) and private id for this venue. The private id is the channel id used for the venue on the event service.
(type=((string, string), int))

GetName(self)

Get the name of the venue.

Returns:: Name for this venue.
(type=string)

GetNetworkServices(self)

GetNetworkServices returns a list of all the network services in this venue.

Returns:: A list of network service descriptions
(type=[Descriptions.AGNetworkServiceDescription].)

GetServices(self)

GetServices returns a list of all the services in this venue.

Returns:: A list of service descriptions.
(type=Descriptions.ServiceDescription)

GetStaticStreams(self)

Returns a list of static stream descriptions

Returns:: The list of stream descriptions for the static streams in this venue.
(type=[Descriptions.StreamDescription])

GetStreams(self)

Get the list of streams.

Returns:: The list of stream descriptions.
(type=[Descriptions.StreamDescription])

GetUploadDescriptor(self)

Retrieve the upload descriptor from the Venue's datastore.

Returns:: The upload descriptor for the data store.
(type=string)

IsValid(self)

Check if the venue soap interface is valid.

Returns:: 1 if valid
(type=int)

Overrides:: AccessGrid.hosting.SOAPInterface.SOAPIWrapper.IsValid

RecycleMulticastLocation(self, location)

This method removes a multicast network Location.

Parameters:: location - Network location to recycle
(type=NetworkLocation.MulticastNetworkLocation)

RegenerateEncryptionKeys(self)

RegenerateKeys allows one to regenerate the encryption keys on the venue. This should only be done with extreme care, as the regeneration of encryption keys will interrupt existing collaborations by restarting simple media tools.

RegisterNetworkService(self, networkServiceDescription)

Registers a network service with the venue.

@param networkServiceDescription A description object for the network service

Parameters:: networkServiceDescription
(type=Descriptions.AGNetworkServiceDescription)

RemoveConnection(self, connection)

Remove venue connection from this venue.

Parameters:: connection - Connection description for the venue to remove.
(type=Descriptions.ConnectionDescription)

Raises:: ConnectionNotFound - Raised when a connection isn't found to be rmeoved.; BadConnectionDescription - Raised when the connection description struct is not successfully converted to a connection description.

RemoveData(self, dataDescription)

Interface for removing data.

Parameters:: dataDescription - The data description that's being added to the venue.
(type=Descriptions.DataDescription)

Returns:: A data description is returned on success.
(type=Descriptions.DataDescription)

Raises:: BadDataDescription - This is raised if the data description struct cannot be converted to a real data description.

RemoveNetworkLocationFromStream(self, privId, streamId, networkId)

Remove a transport from an existing stream. Note: This method overwrites the private id in the incoming network location

Parameters:: privId - Private id of the service that wants to add the location
(type=AccessGrid.GUID.GUID); streamId - The id of the stream to which to add the transport
(type=AccessGrid.GUID.GUID); networkId - The id of the network location (transport) to remove
(type=AccessGrid.GUID.GUID)

RemoveNetworkService(self, nid)

RemoveNetworkService removes a netservice from those in the venue

RemoveService(self, sid)

RemoveService removes persistent service from the Virtual Venue.

Raises:: ServiceNotFound - When a service not present is removed.

RemoveStream(self, streamDesc)

Remove the given stream from the venue

Parameters:: streamDesc - Description of stream to be removed.
(type=Descriptions.StreamDescription)

Raises:: BadStreamDescription - Invalid stream description.

SetConnections(self, connectionList)

Interface for setting all the connections in a venue.

Parameters:: connectionList - A list of connection descriptions.
(type=[Descriptions.ConnectionDescription])

Raises:: BadConnectionDescription - This is raised when an anonymous struct is not converted to a real connection description.

SetDescription(self, description)

Set the venue description.

Parameters:: description - New description for this venue.
(type=string)

SetEncryptMedia(self, value, key)

Turn media encryption on or off.

Parameters:: value - Flag indicating whether encryption should be on or off.
(type=int); key
(type=string)

Keyword Parameters:: key - An optional key for encryption, if not provided, and the value is 1, then one is created. Default value is None.

Returns:: The value of the EncryptMedia flag.
(type=string)

SetName(self, name)

Set the venue name.

Returns:: string

Shutdown(self)

This method cleanly shuts down all active threads associated with the venue.

UnRegisterNetworkService(self, networkServiceDescription)

Removes a network service from the venue

Parameters:: networkServiceDescription - description object of the service to remove
(type=Descriptions.AGNetworkServiceDescription)

UpdateApplication(self, applicationDesc)

Update application.

Parameters:: applicationDesc - Object describing the application.
(type=Descriptions.ApplicationDescription)

Raises:: ApplicationNotFound - Raised when an application is not found for the application id specified.

UpdateClientProfile(self, profile)

UpdateClientProfile allows a VenueClient to update/modify the client profile that is stored by the Virtual Venue that they gave to the Venue when they called the Enter method.

Parameters:: profile - ClientProfile object describing the client
(type=ClientProfile.ClientProfile)

Raises:: invalidClientProfileException - Raised when the client profile is invalid.

UpdateData(self, dataDescription)

Find data with the same name and replace it.

Parameters:: dataDescription - Description of new data
(type=Descriptions.DataDescription)

UpdateService(self, serviceDesc)

The UpdateService method enables VenuesClients to modify a service description.

Returns:: Service description of the update service
(type=Descriptions.ServiceDescription)

Raises:: ServiceNotFound - Raised when service is not found.

Generated by Epydoc 2.1 on Mon Jan 09 13:23:46 2006

http://epydoc.sf.net