Home       Trees       Index       Help   

Access Grid Toolkit

Package AccessGrid :: Module Venue :: Class VenueI
[show private | hide private]
[frames | no frames]

Class VenueI

    SOAPInterface --+        
                    |        
AuthorizationManagerI --+    
                        |    
      AuthorizationIMixIn --+
                            |
            SOAPInterface --+
                            |
                           VenueI

A Virtual Venue is a virtual space for collaboration on the Access Grid.
Method Summary
  __init__(self, impl)
The server side interface object.
  AddConnection(self, connectionDescStruct)
AddConnection allows an administrator to add a connection to a virtual venue to this virtual venue.
  AddData(self, dataDescriptionStruct)
LEGACY: The implementation call is only present to support AG2.0 clients.
  AddNetService(self, clientType, privateId)
AddNetworkService adds a net service to those in the venue
  AddNetworkLocationToStream(self, privateId, streamId, networkLocationStruct)
Add a transport to an existing stream
  AddNetworkService(self, clientType, privateId)
AddNetworkService adds a net service to those in the venue
  AddService(self, servDescStruct)
Interface to add a service to the venue.
  AddStream(self, inStreamDescription)
Add a stream to the list of streams for this venue.
  AddSubjectToRole(self, subject, role_string)
Adds user to list of users authorized for a specific role.
  AllocateMulticastLocation(self)
  CreateApplication(self, name, description, mimeType, aid)
Create a new application object.
  DestroyApplication(self, appId)
Destroy an application object.
  DetermineSubjectRoles(self)
Return a list of roles for the calling subject
  Enter(self, clientProfileStruct)
Interface used to enter a Virtual Venue.
  Exit(self, privateId)
The Exit method is used by a VenueClient to cleanly leave a Virtual Venue.
  FlushRoles(self)
Enforce roles that may have just changed.
  GetApplication(self, aid)
Return the application state for the given application object.
  GetApplications(self)
return the list of application descriptions for this venue.
  GetCachedProfiles(self)
This method returns a list of client profiles that have been registered for this venue.
  GetClients(self)
retrieve the list of clients in the venue.
  GetConnections(self)
GetConnections returns a list of all the connections to other venues that are found within this venue.
  GetDataDescriptions(self)
  GetDataStoreInformation(self)
Retrieve an upload descriptor and a URL to the Venue's DataStore **Arguments:** **Raises:** **Returns:** *(upload description, url)* the upload descriptor to the Venue's DataStore and the url to the DataStore SOAP service.
  GetDescription(self)
GetDescription returns the description for the virtual venue.
  GetEncryptMedia(self)
Return whether we are encrypting streams or not.
  GetEventServiceLocation(self)
  GetName(self)
GetName returns the name for the virtual venue.
  GetNetworkServices(self)
Return data on the existing network services.
  GetRoleNames(self)
Returns a list of role names.
  GetServices(self)
Interface to remove a service from the venue.
  GetStaticStreams(self)
GetStaticStreams returns a list of static stream descriptions to the caller.
  GetStreams(self)
GetStreams returns a list of stream descriptions to the caller.
  GetUploadDescriptor(self)
Retrieve the upload descriptor from the Venue's datastore.
  GetUsersInRole(self, role_string)
Returns a list of strings of users' names.
  ImportAuthorizationPolicy(self, policy)
This method takes a string that is an XML representation of an authorization policy.
  RecycleMulticastLocation(self, location)
  RegenerateEncryptionKeys(self)
RegenerateKeys allows one to regenerate the encryption keys on the venue.
  RegisterNetworkService(self, networkServiceDescription)
Register a network service with the venue.
  RemoveConnection(self, connectionDescription)
RemoveConnection removes a connection to another virtual venue from this virtual venue.
  RemoveData(self, dataDescriptionStruct)
Interface for removing data.
  RemoveNetService(self, privateId)
RemoveNetworkService removes a netservice from those in the venue
  RemoveNetworkLocationFromStream(self, privateId, streamId, networkLocationId)
  RemoveNetworkService(self, privateId)
RemoveNetworkService removes a netservice from those in the venue
  RemoveService(self, servDescStruct)
Interface to remove a service from the venue.
  RemoveStream(self, inStreamDescription)
Remove the given stream from the venue
  RemoveSubjectFromRole(self, subject, role)
Removes a user from list of those authorized for a specific role.
  SetConnections(self, connDescStructList)
Interface for setting all the connections in a venue in a single call.
  SetDescription(self, description)
SetDescription allows an administrator to set the venues description to something new.
  SetEncryptMedia(self, value, key)
Turn media encryption on or off.
  SetName(self, name)
SetName allows an administrator to set the venues name to something new.
  SetSubjectsInRole(self, subject_list, role_string)
Sets the users in a role.
  Shutdown(self)
This method cleanly shuts down all active threads associated with the Virtual Venue.
  UnRegisterNetworkService(self, networkServiceDescription)
UnregisterNetworkService removes a netservice from those in the venue
  UpdateApplication(self, appDescStruct)
Interface to update a service from the venue.
  UpdateClientProfile(self, clientProfileStruct)
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, dataDescriptionStruct)
Replace the current description for dataDescription.name with this one.
  UpdateService(self, servDescStruct)
Interface to update a service from the venue.
  _authorize(self, *args, **kw)
The authorization callback.
    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.
  _GetCaller(self)
This method implements the guts of extracting the subject from the soap call.
  _GetContext(self)
This method implements the guts of extracting the subject and the action from the SOAP call.
  _GetMethodActions(self)
This method extracts all the methods and creates MethodActions for them, which means Authorization can be automatically loaded with actions for all the methods on an interface object.

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)

AddConnection(self, connectionDescStruct)

AddConnection allows an administrator to add a connection to a virtual venue to this virtual venue.

**Arguments:**

*ConnectionDescriptionStruct* An anonymous struct containing a connection description.

**Raises:**

*NotAuthorized* Raised when the caller is not an administrator.

*BadConnectionDescription* Raised when the connection description struct is not successfully converted to a connection description.

AddData(self, dataDescriptionStruct)

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

Interface to Add data to the Venue.

**Arguments:**

*dataDescriptionStruct* The Data Description that's now an anonymous struct that is being added to the venue.

**Raises:**

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

**Returns:**

*dataDescription* A data description is returned on success.

AddNetService(self, clientType, privateId=None)

AddNetworkService adds a net service to those in the venue

AddNetworkLocationToStream(self, privateId, streamId, networkLocationStruct)

Add a transport to an existing stream

**Arguments:**

*streamId* The id of the stream to which to add the transport *networkLocation* The network location (transport) to add

**Raises:**

Note: This method overwrites the private id in the incoming network location

AddNetworkService(self, clientType, privateId=None)

AddNetworkService adds a net service to those in the venue

AddService(self, servDescStruct)

Interface to add a service to the venue.

**Arguments:**

*servDescStruct* an anonymous struct that contains a service description.

**Raises:**

*BadServiceDescription* This is raised if the anonymous struct can't be converted to a real service description.

**Returns:**

*serviceDescription* A service description is returned on success.

AddStream(self, inStreamDescription)

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

**Arguments:**

*inStreamDescription* An anonymous struct containing a stream description.

**Raises:**

*NotAuthorized* This is raised when the caller is not an administrator.

*BadStreamDescription* This is raised when the struct passed in cannot be successfully converted to a real Stream Description.

AddSubjectToRole(self, subject, role_string)

Adds user to list of users authorized for a specific role.

CreateApplication(self, name, description, mimeType, aid=None)

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

**Arguments:**

*name* A name for the application instance.

*description* A description for the new application instance.

*mimeType* A mime-type for the new application, used to match applications with clients.

**Returns:**

*appHandle* A url to the new application object/service.

DestroyApplication(self, appId)

Destroy an application object.

**Arguments:**

*appId* The id of the application object to be destroyed.

**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.

DetermineSubjectRoles(self)

Return a list of roles for the calling subject

Enter(self, clientProfileStruct)

Interface used to enter a Virtual Venue.

**Arguments:**

*clientProfileStruct* An anonymous struct containing a client profile.

**Raises:**

*InvalidClientProfileException* This is raised when the client profile is not successfully converted to a real client profile.

**Returns:**

*(state, privateId, streamDescriptions)* This tuple is returned to the client on success. The state is the current state of the Virtual Venue and includes locations for the text and event services. The private Id is a venue assigned private id for the lifetime of this client session. The stream descriptions are the result of the venue negotiating the client capabilities.

Exit(self, privateId)

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.

**Arguments:**

*privateId* The privateId of the client to be removed from the venue.

**Raises:**

*ClientNotFound* Raised when a privateId is not found in the venues list of clients.

FlushRoles(self)

Enforce roles that may have just changed. Not needed for administrator roles, just allowed entry. Since "VenueUsers" is not fully enforced yet, we'll check the connections.

GetApplication(self, aid)

Return the application state for the given application object.

**Arguments:**

*id* The id of the application being retrieved.

**Raises:**

*ApplicationNotFound* Raised when the application is not found in the venue.

**Returns:**

*appState* The state of the application object.

GetApplications(self)

return the list of application descriptions for this venue.

GetCachedProfiles(self)

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

**Returns:**

*cachedProfiles* A list of ClientProfiles.

GetClients(self)

retrieve the list of clients in the venue.

GetConnections(self)

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

**Returns:**

*ConnectionList* A list of connection descriptions.

GetDataStoreInformation(self) 

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

**Arguments:**

**Raises:**

**Returns:**

    *(upload description, url)* the upload descriptor to the Venue's DataStore
    and the url to the DataStore SOAP service.

GetDescription(self)

GetDescription returns the description for the virtual venue. **Arguments:**

GetEncryptMedia(self)

Return whether we are encrypting streams or not.

GetName(self)

GetName returns the name for the virtual venue.

GetNetworkServices(self)

Return data on the existing network services.

GetRoleNames(self)

Returns a list of role names.

GetServices(self)

Interface to remove a service from the venue.

**Arguments:**

**Raises:**

**Returns:**

*serviceDescriptionList* A service description is returned on success.

GetStaticStreams(self)

GetStaticStreams returns a list of static stream descriptions to the caller.

GetStreams(self)

GetStreams returns a list of stream descriptions to the caller.

GetUploadDescriptor(self)

Retrieve the upload descriptor from the Venue's datastore.

**Arguments:**

**Raises:**

**Returns:**

*upload description* the upload descriptor for the data store.

*''* If there is not data store we return an empty string, because None doesn't serialize right with our SOAP implementation.

GetUsersInRole(self, role_string)

Returns a list of strings of users' names.

ImportAuthorizationPolicy(self, policy)

This method takes a string that is an XML representation of an authorization policy. This policy is parsed and this object is configured to enforce the specified policy.
Parameters:
policy - the policy as a string
           (type=an XML formatted string)

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)

Register a network service with the venue.

RemoveConnection(self, connectionDescription)

RemoveConnection removes a connection to another virtual venue from this virtual venue. This is an administrative operation.

**Arguments:**

*connectionDescriptionStruct* An anonymous struct containing a connection description.

**Raises:**

*NotAuthorized* Raised when the caller is not an administrator.

*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, dataDescriptionStruct)

Interface for removing data.

**Arguments:**

*dataDescriptionStruct* The Data Description that's now an anonymous struct that is being added to the venue.

**Raises:**

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

**Returns:**

*dataDescription* A data description is returned on success.

RemoveNetService(self, privateId)

RemoveNetworkService removes a netservice from those in the venue

RemoveNetworkService(self, privateId)

RemoveNetworkService removes a netservice from those in the venue

RemoveService(self, servDescStruct)

Interface to remove a service from the venue.

**Arguments:**

*servDescStruct* an anonymous struct that contains a service description.

**Raises:**

*BadServiceDescription* This is raised if the anonymous struct can't be converted to a real service description.

**Returns:**

*serviceDescription* A service description is returned on success.

RemoveStream(self, inStreamDescription)

Remove the given stream from the venue

**Arguments:**

*inStreamDescription* An anonymous struct containing a stream description to be removed.

**Raises:**

*NotAuthorized* This is raised when the caller is not an administrator.

*BadStreamDescription* This is raised when the struct passed in cannot be successfully converted to a real Stream Description.

RemoveSubjectFromRole(self, subject, role)

Removes a user from list of those authorized for a specific role.

SetConnections(self, connDescStructList)

Interface for setting all the connections in a venue in a single call.

**Arguments:**

*connDescStructList* a list of connection descriptions that have been converted to anonymous structs by the SOAP module.

**Raises:**

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

SetDescription(self, description)

SetDescription allows an administrator to set the venues description to something new.

**Arguments:**

*description* New description for this venue.

SetEncryptMedia(self, value, key=None)

Turn media encryption on or off.

**Arguments:**

*value* Flag indicating whether encryption should be on or off.

*key=None* An optional key for encryption, if not provided, and the value is 1, then one is created.

**Raises:**

*NotAuthorized* Raised when the caller is not an administrator.

**Returns:**

*value* The value of the EncryptMedia flag.

SetName(self, name)

SetName allows an administrator to set the venues name to something new.

**Arguments:**

*name* New name for this venue.

SetSubjectsInRole(self, subject_list, role_string)

Sets the users in a role. Be extra careful so we don't wipe out all the subjects in this role if there's an error.

Shutdown(self)

This method cleanly shuts down all active threads associated with the Virtual Venue. Currently there are a few threads in the Event Service.

UnRegisterNetworkService(self, networkServiceDescription)

UnregisterNetworkService removes a netservice from those in the venue

UpdateApplication(self, appDescStruct)

Interface to update a service from the venue.

**Arguments:**

*appDescStruct* an anonymous struct that contains an application description.

**Raises:**

*BadApplicationDescription* This is raised if the anonymous struct can't be converted to a real application description.

**Returns:**

*applicationDescription* An app description is returned on success.

UpdateClientProfile(self, clientProfileStruct)

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.

**Arguments:**

*clientProfileStruct* An anonymous struct containing a client profile.

**Raises:**

*InvalidClientProfileException* Raised when the client profile struct cannot be converted to a real client profile.

UpdateData(self, dataDescriptionStruct)

Replace the current description for dataDescription.name with this one.

UpdateService(self, servDescStruct)

Interface to update a service from the venue.

**Arguments:**

*servDescStruct* an anonymous struct that contains a service description.

**Raises:**

*BadServiceDescription* This is raised if the anonymous struct can't be converted to a real service description.

**Returns:**

*serviceDescription* A service description is returned on success.

_authorize(self, *args, **kw)

The authorization callback. We should be able to implement this just once and remove a bunch of the older code.
Overrides:
AccessGrid.Security.AuthorizationManager.AuthorizationManagerI._authorize

   Home       Trees       Index       Help   

Access Grid Toolkit

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