Web Service Interfaces

[Ivan R. Judson]

here's a list of our interfaces, including type information where I could
find it. I'd like someone to take this list and finish the missing type
information and then fill in return type information.

>From this list we can quickly (and probably easily) define the types we care
about for 3.0 and generate wsdl/schemas for them, which will help start work
in the next cycle.

class AGNetworkService(SOAPInteface):
	__init__(self, impl)
	_authorize(self, *args, **kw) : True : False : Exception
	
	Transform(self, streamList : list of StreamDescriptions) :
	StopTransform(self, streamList : list of StreamDescriptions)

class AGServiceI(SOAPInterface):
	def __init__(self,impl):
	def _authorize(self, *args, **kw) : True : False : Exception
	
	def Start(self):
	def Stop(self):
	def GetCapabilities( self ):
	def GetResource( self ):
	def SetResource( self, resourceStruct : AGResource):
	def SetConfiguration(self, serviceConfig :  ??? ):
	def GetConfiguration( self ):
	def ConfigureStream( self, streamDescStruct : StreamDescription):
	def IsStarted( self ):
	def SetEnabled(self, enabled : True or False):
	def GetEnabled(self):
	def Shutdown(self):
	def SetIdentity(self, profileStruct : ClientProfile):
	
class AGServiceManagerI(SOAPInterface):
	def __init__(self, impl : AGServiceManager):
	def _authorize(self, *args, **kw) : True : False : Exception
	
	def Shutdown(self):
	def GetResources(self):
	def DiscoverResources(self):
	def AddServicePackage( self, serviceFile : string (path),
resourceStruct : AGResource, serviceConfigStruct : ???):
	def AddService(self, serviceDescStruct : AGServiceDescription,
resourceStruct : AGResource,  serviceConfigStruct : ???):
	def RemoveService(self, serviceDescStruct : AGServiceDescription):
	def RemoveServices(self):
	def GetServices(self):
	def GetAvailableServices(self):
	def StopServices(self):

class SharedApplicationI(SOAPInterface, AuthorizationIMixIn):
	def __init__(self, impl):
	def _authorize(self, *args, **kw) : True : False : Exception
	
	def GetId(self):
	def Join(self, clientProfile : ClientProfile):
	def GetComponents(self, private_token : string):
	def GetParticipants(self, private_token : string):
	def Leave(self, private_token : string):
	def SetData(self, private_token : string, key : string, value :
<unconstrained>):
	def GetData(self, private_token : string, key : string):
	def GetDataKeys(self, private_token : string):
	def GetDataChannel(self, private_token : string):
	def GetVenueURL(self, private_token : string):
	def SetParticipantStatus(self, private_token : string, status :
string):
	def SetParticipantProfile(self, private_token : string, profile :
ClientProfile):
	def GetState(self, private_token : string):

class VenueI(SOAPInterface, AuthorizationIMixIn):
	def __init__(self, impl):
	def _authorize(self, *args, **kw) : True : False : Exception
	
	def Enter(self, clientProfileStruct):
	def GetClients(self):
	def RegisterNetworkService(self, networkServiceDescription :
NetworkServiceDescription):
	def UnRegisterNetworkService(self, networkServiceDescription :
NetworkServiceDescription):
	def AddNetworkService(self, clientType, privateId: string):
	def RemoveNetworkService(self, privateId : string):
	def GetNetworkServices(self):
	def GetCachedProfiles(self):
	def Shutdown(self):
	def AddService(self, servDescStruct : ServiceDescription ):
	def RemoveService(self, servDescStruct :  ServiceDescription ):
	def UpdateService(self, servDescStruct : ServiceDescription ):
	def GetServices(self):
	def SetConnections(self, connDescStructList : ConnectionDescription
List):
	def AddConnection(self, connectionDescStruct :
ConnectionDescription):
	def RemoveConnection(self, connectionDescription :
ConnectionDescription):
	def GetConnections(self):
	def SetEncryptMedia(self, value : True or False, key : string):
	def GetEncryptMedia(self):
	def RegenerateEncryptionKeys(self):
	def SetDescription(self, description : string):
	def GetDescription(self):
	def SetName(self, name : string):
	def GetName(self):
	def AddStream(self, inStreamDescription : StreamDescription):
	def RemoveStream(self, inStreamDescription : StreamDescription):
	def GetStreams(self):
	def GetStaticStreams(self):
	def Exit(self, privateId : string):
	def UpdateClientProfile(self, clientProfileStruct : ClientProfile):
	def AddData(self, dataDescriptionStruct : DataDescription):
	def RemoveData(self, dataDescriptionStruct : DataDescription):
	def UpdateData(self, dataDescriptionStruct : DataDescription):
	def GetDataStoreInformation(self):
	def GetDataDescriptions(self):
	def GetUploadDescriptor(self):
	def GetApplication(self, aid : string):
	def GetApplications(self):
	def CreateApplication(self, name : string, description : string,
mimeType : string, aid : string):
	def DestroyApplication(self, appId : string):
	def UpdateApplication(self, appDescStruct : ApplicationDescription):
	def AddNetworkLocationToStream(self, privateId : string, streamId :
string, networkLocationStruct : NetworkLocation):
	def GetEventServiceLocation(self):
	def ImportAuthorizationPolicy(self, policy : string):
	def AllocateMulticastLocation(self):
	def RecycleMulticastLocation(self, location :
MulticastNetworkLocation):
	def AddSubjectToRole(self, subject : string, role_string : string):
	def RemoveSubjectFromRole(self, subject : string, role : string):
	def SetSubjectsInRole(self, subject_list : list of string,
role_string : string):
	def FlushRoles(self):
	def GetUsersInRole(self, role_string : string):
	def GetRoleNames(self):
	def DetermineSubjectRoles(self):
	
class VenueServerI(SOAPInterface, AuthorizationIMixIn):
	def __init__(self, impl):
	def _authorize(self, *args, **kw) : True : False : Exception
	
	def Shutdown(self, secondsFromNow : integer):
	def Checkpoint(self):
	def AddVenue(self, venueDescStruct : VenueDescription):
	def ModifyVenue(self, URL, venueDescStruct : VenueDescription):
	def RemoveVenue(self, URL : string):
	def GetVenues(self):
	def GetDefaultVenue(self):
	def SetDefaultVenue(self, URL : string):
	def AddAdministrator(self, subjStr : string):
	def RemoveAdministrator(self, string : string):
	def GetAdministrators(self):
	def SetStorageLocation(self, location : string):
	def GetStorageLocation(self):
	def SetAddressAllocationMethod(self, method : enum { RANDOM,
INTERVAL } ):
	def GetAddressAllocationMethod(self):
	def SetEncryptAllMedia(self, value : True or False):
	def GetEncryptAllMedia(self):
	def RegenerateEcryptionKeys(self):
	def SetBackupServer(self, server : string):
	def GetBackupServer(self):
	def SetBaseAddress(self, address : string):
	def GetBaseAddress(self):
	def SetAddressMask(self, mask : string):
	def GetAddressMask(self):
	def DumpDebugInfo(self,flag : True or False):