WebServiceInterfaces

UserPreferences

class AGNetworkService(SOAPInteface):

        __init__(self, impl) :
        _authorize(self, *args, **kw) : True, False
        
        Transform(self, streamList : list of StreamDescriptions) : List of StreamDescriptions
        StopTransform(self, streamList : list of StreamDescriptions) : None

class AGServiceI(SOAPInterface):

        def __init__(self, impl) :
        def _authorize(self, *args, **kw) : True, False
        
        def Start(self) : Nothing
        def Stop(self) : Nothing
        def GetCapabilities(self) : Capability List?
        def GetResource(self) : AGResource
        def SetResource(self, resourceStruct : AGResource) : Nothing
        def SetConfiguration(self, serviceConfig :  ??? ) : Nothing
        def GetConfiguration( self ) :  List of Configuration Things?
        def ConfigureStream( self, streamDescStruct : StreamDescription) : 1, 0
        def IsStarted( self ) : 1, 0
        def SetEnabled(self, enabled : True or False) : Nothing
        def GetEnabled(self) : 1, 0
        def Shutdown(self) : Nothing
        def SetIdentity(self, profileStruct : ClientProfile) : Nothing
        
class AGServiceManagerI(SOAPInterface):

        def __init__(self, impl : AGServiceManager) :
        def _authorize(self, *args, **kw) : True, False
        
        def Shutdown(self) : Nothing
        def GetResources(self) : List of AGResources
        def DiscoverResources(self) : Nothing
        def AddServicePackage( self, serviceFile : string (path), resourceStruct : AGResource, serviceConfigStruct : ???) : ServiceDescription
        def AddService(self, serviceDescStruct : AGServiceDescription, resourceStruct : AGResource,  serviceConfigStruct : ???) : ServiceDescription
        def RemoveService(self, serviceDescStruct : AGServiceDescription) : Nothing
        def RemoveServices(self) : Nothing
        def GetServices(self) : List of ServiceDescriptions
        def GetAvailableServices(self) : List of ServiceDescriptions
        def StopServices(self) : Nothing

class SharedApplicationI(SOAPInterface, AuthorizationIMixIn):

        def __init__(self, impl):
        def _authorize(self, *args, **kw) : True, False
        
        def GetId(self) : string
        def Join(self, clientProfile : ClientProfile): (public id: string, private id: string)
        def GetComponents(self, private_token : string) : List of AppParticipantDescriptions
        def GetParticipants(self, private_token : string) : List of AppParticipantDescriptions
        def Leave(self, private_token : string) : 1
        def SetData(self, private_token : string, key : string, value : <unconstrained>) : None
        def GetData(self, private_token : string, key : string) : <unconstrained data types>
        def GetDataKeys(self, private_token : string) : List of strings
        def GetDataChannel(self, private_token : string) : (channel id: string, location: (host : string, port : integer))
        def GetVenueURL(self, private_token : string) : string
        def SetParticipantStatus(self, private_token : string, status : string) : None
        def SetParticipantProfile(self, private_token : string, profile : ClientProfile) : None
        def GetState(self, private_token : string) : Dictionary of Application State

class VenueI(SOAPInterface, AuthorizationIMixIn):

        def __init__(self, impl):
        def _authorize(self, *args, **kw) : True, False
        
        def Enter(self, clientProfileStruct) : (state : VenueState, private id : string, stream descriptions : List of StreamDescriptions)
        def GetClients(self) : List of ClientProfiles
        def RegisterNetworkService(self, networkServiceDescription : NetworkServiceDescription) : Nothing
        def UnRegisterNetworkService(self, networkServiceDescription : NetworkServiceDescription) : Nothing
        def AddNetworkService(self, clientType, privateId: string) : private id : string
        def RemoveNetworkService(self, privateId : string) : Nothing
        def GetNetworkServices(self) : List of NetworkServiceDescriptions
        def GetCachedProfiles(self) : List of ClientProfiles
        def Shutdown(self) : Nothing
        def AddService(self, servDescStruct : ServiceDescription ) : ServiceDescription
        def RemoveService(self, servDescStruct :  ServiceDescription ) : ServiceDescription
        def UpdateService(self, servDescStruct : ServiceDescription ) : ServiceDescription
        def GetServices(self) : List of ServiceDescriptions
        def SetConnections(self, connDescStructList : ConnectionDescription List) : Nothing
        def AddConnection(self, connectionDescStruct : ConnectionDescription) : Nothing
        def RemoveConnection(self, connectionDescription : ConnectionDescription) : Nothing
        def GetConnections(self) : List of ConnectionDescriptions
        def SetEncryptMedia(self, value : True or False, key : string) : True, False
        def GetEncryptMedia(self) : key : string
        def RegenerateEncryptionKeys(self) : key : string
        def SetDescription(self, description : string) : Nothing
        def GetDescription(self) : description : string
        def SetName(self, name : string): Nothing
        def GetName(self) : name : string
        def AddStream(self, inStreamDescription : StreamDescription) : Nothing
        def RemoveStream(self, inStreamDescription : StreamDescription) : Nothing
        def GetStreams(self) : List of StreamDescriptions
        def GetStaticStreams(self) : List of StreamDescriptions
        def Exit(self, privateId : string) : Nothing
        def UpdateClientProfile(self, clientProfileStruct : ClientProfile) : Nothing
        def RemoveData(self, dataDescriptionStruct : DataDescription) : DataDescription
        def UpdateData(self, dataDescriptionStruct : DataDescription) : None, DataDescription
        def GetDataStoreInformation(self) : (Upload URL : string, Venue URL : string)
        def GetDataDescriptions(self) : List of DataDescriptions
        def GetUploadDescriptor(self) : Upload URL : string
        def GetApplication(self, aid : string) : Application State : Dictionary of Application State
        def GetApplications(self) : List of ApplicationDescriptions
        def CreateApplication(self, name : string, description : string, mimeType : string, aid : string) : ApplicationDescription
        def DestroyApplication(self, appId : string) : Nothing
        def UpdateApplication(self, appDescStruct : ApplicationDescription) : ApplicationDescription
        def AddNetworkLocationToStream(self, privateId : string, streamId : string, networkLocationStruct : NetworkLocation) : Id : string
        def GetEventServiceLocation(self) : ( location: , venue id : string )
        def ImportAuthorizationPolicy(self, policy : string) : Nothing
        def AllocateMulticastLocation(self) : MulticastNetworkLocation
        def RecycleMulticastLocation(self, location : MulticastNetworkLocation) : Nothing
        
        # Legacy calls to be removed
        def AddData(self, dataDescriptionStruct : DataDescription) : Nothing
        def AddSubjectToRole(self, subject : string, role_string : string) : Nothing
        def RemoveSubjectFromRole(self, subject : string, role : string) : Nothing
        def SetSubjectsInRole(self, subject_list : list of string, role_string : string) : Nothing
        def FlushRoles(self) : Nothing
        def GetUsersInRole(self, role_string : string) : List of Distinguished Names : List of strings
        def GetRoleNames(self) : List of Role Names : List of strings
        def DetermineSubjectRoles(self) : List of Role Names : List of strings
        
class VenueServerI(SOAPInterface, AuthorizationIMixIn):
        def __init__(self, impl):
        def _authorize(self, *args, **kw) : True, False
        
        def Shutdown(self, secondsFromNow : integer) : Nothing
        def Checkpoint(self) : 1, 0, Nothing
        def AddVenue(self, venueDescStruct : VenueDescription) : Venue URL : string
        def ModifyVenue(self, URL, venueDescStruct : VenueDescription) : Nothing
        def RemoveVenue(self, URL : string) : Nothing
        def GetVenues(self) : List of VenueDescriptions
        def GetDefaultVenue(self) : Venue URL : string
        def SetDefaultVenue(self, URL : string) : Venue URL : string
        def SetStorageLocation(self, location : string) : Storage URL : string
        def GetStorageLocation(self) : Storage URL : string
        def SetAddressAllocationMethod(self, method : enum { RANDOM, INTERVAL } ) : Nothing
        def GetAddressAllocationMethod(self) : method : enum { RANDOM, INTERVAL }
        def SetEncryptAllMedia(self, value : True or False) : value : True or False
        def GetEncryptAllMedia(self) : value : True or False
        def RegenerateEcryptionKeys(self) : Nothing
        def SetBackupServer(self, server : string) : Backup Server URL : string
        def GetBackupServer(self) : Backup Server URL : string
        def SetBaseAddress(self, address : string) : Nothing
        def GetBaseAddress(self) : Base Address : string
        def SetAddressMask(self, mask : string) : Nothing
        def GetAddressMask(self) : Address Mask : string
        def DumpDebugInfo(self,flag : True or False) : Nothing

        # Legacy Calls, to be removed
        def AddAdministrator(self, subjStr : string) : Distinguished Name : string
        def RemoveAdministrator(self, string : string) : Distinguished Name : string
        def GetAdministrators(self) : List of Distinguished Names: List of strings