/Users/maurits/Documents/studie/afstuderen/biosphere/python/biosphere/types.py

Go to the documentation of this file.

import base64
import uuid

"""There are several types used by the Bio-SPHERE platform to
model the offered services. Especially the bs_definition and related
classes are very similar in structure to WSDL.

The bs_service_request and bs_service_response classes are used for
making the actual requests and response. They are similar in function
to SOAP."""


class bs_data_type:
    """A class representing a data type in the Bio-SPHERE platform."""
    
    def __init__(self, name):
        self.namename = name
    
    def isBuiltin(self):
        """Check whether this type is one builtin types (which are
        serialized differently) or a custom type. Returns true if it
        is a builtin type.
        """
        if self.namename == 'bs_bool': return True
        elif self.namename == 'bs_string': return True
        elif self.namename == 'bs_byte': return True
        elif self.namename == 'bs_double': return True
        elif self.namename == 'bs_int16': return True
        elif self.namename == 'bs_uint16': return True
        elif self.namename == 'bs_int32': return True
        elif self.namename == 'bs_uint32': return True
        elif self.namename == 'bs_int64': return True
        elif self.namename == 'bs_uint64': return True
        elif self.namename == 'bs_double': return True
        else: return False
    
    def toXML(self):
        return '  <type name="%s" />\n' % self.namename


class bs_message_part:
    """Class representing a message part."""
    
    def __init__(self, name, type):
        self.namename = name
        self.typetype = type
    
    def toXML(self):
        return '    <part name="%s" type="%s" />\n' % (self.namename,
                                                 self.typetype.name)


class bs_message:
    """Class representing a message, consisting of several parts."""
    
    def __init__(self, name, parts=None):
        self.namename = name
        if parts == None: self.partsparts = []
        else: self.partsparts = parts
    
    def toXML(self):
        return '  <message name="%s">\n' % self.namename + \
            ''.join([part.toXML() for part in self.partsparts]) + \
            '  </message>\n'


class bs_operation:
    
    def __init__(self, name, input=None,
                 output=None, fault=None):
        self.namename = name
        self.inputinput = input
        self.outputoutput = output
        self.faultfault = fault
    
    def toXML(self):
        ret = '    <operation name="%s">\n' % self.namename
        if self.inputinput != None:
            ret = ret + '      <input name="%s" />\n' % self.inputinput.name
        if self.outputoutput != None:
            ret = ret + '      <output name="%s" />\n' % self.outputoutput.name
        if self.faultfault != None:
            ret = ret + '      <fault name="%s" />\n' % self.faultfault.name
        return ret + '    </operation>\n'


class bs_port_type:
    
    def __init__(self, name, operations=None):
        self.namename = name
        if operations == None: self.operationsoperations = []
        else: self.operationsoperations = operations
    
    def toXML(self):
        return '  <portType name="%s">\n' % self.namename + \
            ''.join([op.toXML() for op in self.operationsoperations]) + \
            '  </portType>\n'


class bs_port:
    
    def __init__(self, name, type):
        self.namename = name
        self.typetype = type
    
    def toXML(self):
        return '    <port name="%s" type="%s" />\n' % (self.namename,
                                                 self.typetype.name)

class bs_service:
    
    def __init__(self, name, ports=None):
        self.namename = name
        if ports == None: self.portsports = []
        else: self.portsports = ports
    
    def toXML(self):
        return '  <service name="%s">\n' % self.namename + \
            ''.join([port.toXML() for port in self.portsports]) + \
            '  </service>\n'


class bs_definition:
    
    def __init__(self, name, types=None, messages=None,
                 porttypes=None, services=None):
        self.namename = name
        if types == None: self.typestypes = []
        else: self.typestypes = types
        if messages == None: self.messagesmessages = []
        else: self.messagesmessages = messages
        if porttypes == None: self.porttypesporttypes = []
        else: self.porttypesporttypes = porttypes
        if services == None: self.servicesservices = []
        else: self.servicesservices = services
    
    def toXML(self):
        return '<definitions name="%s">\n' % self.namename + \
            ''.join([t.toXML() for t in self.typestypes]) + \
            ''.join([m.toXML() for m in self.messagesmessages]) + \
            ''.join([p.toXML() for p in self.porttypesporttypes]) + \
            ''.join([s.toXML() for s in self.servicesservices]) + \
            '</definitions>\n'


class bs_part_instance:
    
    def __init__(self, name, type, data):
        self.namename = name
        self.typetype = type
        self.datadata = data
    
    def toXML(self):
        ret = '    <part name="%s" type="%s">' % (self.namename,
                                              self.typetype.name)
        if self.typetype.isBuiltin():
            ret = ret + str(self.datadata)
        else:
            ret = ret + base64.b64encode(self.datadata)
        return ret + '</part>\n'
    

class bs_message_instance:
    
    def __init__(self, name, direction='input', parts=None):
        self.namename = name
        self.directiondirection = direction
        if parts == None: self.partsparts = []
        else: self.partsparts = parts
    
    def toXML(self):
        return '  <%s message="%s">\n' % (self.directiondirection, self.namename) + \
            ''.join([p.toXML() for p in self.partsparts]) + \
            '  </%s>\n' % self.directiondirection


class bs_service_request:
    
    def __init__(self, service, port, operation,
                 input=None, u=None):
        self.serviceservice = service
        self.portport = port
        self.operationoperation = operation
        self.inputinput = input
        self.uuiduuid = u
        if self.uuiduuid == None:
            self.uuiduuid = str(uuid.uuid4())
    
    def toXML(self):
        return '<request uuid="%s">\n' % self.uuiduuid + \
            '  <use service="%s" port="%s" operation="%s" />\n' % (self.serviceservice,
                                                               self.portport,
                                                               self.operationoperation) + \
           self.inputinput.toXML() + \
           '</request>\n'


class bs_service_response:
    
    def __init__(self, service, port, operation, uuid,
                 output=None, fault=None):
        self.serviceservice = service
        self.portport = port
        self.operationoperation = operation
        self.outputoutput = output
        self.faultfault = fault
        self.uuiduuid = uuid
    
    def toXML(self):
        ret = '<response uuid="%s">\n' % self.uuiduuid + \
            '  <used service="%s" port="%s" operation="%s" />\n' % (self.serviceservice,
                                                                self.portport,
                                                                self.operationoperation)
        if self.outputoutput != None:
            ret = ret + self.outputoutput.toXML()
        if self.faultfault != None:
            ret = ret + self.faultfault.toXML()
        return ret + '</response>\n'

---