Skip to content
Back to top

# Source code for slixmpp.plugins.xep_0332.stanza.response

    # Slixmpp: The Slick XMPP Library
    # Implementation of HTTP over XMPP transport
    # http://xmpp.org/extensions/xep-0332.html
    # Copyright (C) 2015 Riptide IO, sangeeth@riptideio.com
    # This file is part of slixmpp.
    # See the file LICENSE for copying permission.
    from slixmpp.xmlstream import ElementBase

    class HTTPResponse(ElementBase):

        """
        When the HTTP Server responds, it does so by sending an `iq` stanza
        response (type=`result`) back to the client containing the `resp` element.
        Since response are asynchronous, and since multiple requests may be active
        at the same time, responses may be returned in a different order than the
        in which the original requests were made.

        Examples:
        ::

            <iq type='result'
                from='httpserver@clayster.com'
                to='httpclient@clayster.com/browser' id='2'>
                <resp xmlns='urn:xmpp:http'
                      version='1.1'
                      statusCode='200'
                      statusMessage='OK'>
                    <headers xmlns='http://jabber.org/protocol/shim'>
                        <header name='Date'>Fri, 03 May 2013 16:39:54GMT-4</header>
                        <header name='Server'>Clayster</header>
                        <header name='Content-Type'>text/turtle</header>
                        <header name='Content-Length'>...</header>
                        <header name='Connection'>Close</header>
                    </headers>
                    <data>
                        <text>
                            ...
                        </text>
                    </data>
                </resp>
            </iq>
        """

        name = 'response'
        namespace = 'urn:xmpp:http'
        interfaces = {'code', 'message', 'version'}
        plugin_attrib = 'http-resp'

        def get_code(self):
            code = self._get_attr('statusCode', None)
            return int(code) if code is not None else code

        def set_code(self, code):
            self._set_attr('statusCode', str(code))

        def get_message(self):
            return self._get_attr('statusMessage', '')

        def set_message(self, message):
            self._set_attr('statusMessage', message)

        def set_version(self, version='1.1'):
            self._set_attr('version', version)