Skip to content
Back to top
View this page

# XEP-0086: Error Condition Mappings

XEP-0086 on xmpp.org

class slixmpp.plugins.xep_0086.XEP_0086(xmpp, config=None)

  XEP-0086: Error Condition Mappings

  Older XMPP implementations used code based error messages, similar to HTTP response codes. Since then, error condition elements have been introduced. XEP-0086 provides a mapping between the new condition elements and a combination of error types and the older response codes.

  Also see <http://xmpp.org/extensions/xep-0086.html>.

  Configuration Values:

      override -- Indicates if applying legacy error codes should
                  be done automatically. Defaults to True.
                  If False, then inserting legacy error codes can
                  be done using:
                      iq['error']['legacy']['condition'] = ...

  default_config: ClassVar[dict[str, Any]] = {'override': True}

    The basic, standard configuration for the plugin, which may be overridden when initializing the plugin. The configuration fields included here may be accessed directly as attributes of the plugin. For example, including the configuration field ‘foo’ would mean accessing plugin.foo returns the current value of plugin.config[‘foo’].

## Stanza elements

class slixmpp.plugins.xep_0086.stanza.LegacyError(xml=None, parent=None)

  Older XMPP implementations used code based error messages, similar to HTTP response codes. Since then, error condition elements have been introduced. XEP-0086 provides a mapping between the new condition elements and a combination of error types and the older response codes.

  Also see <http://xmpp.org/extensions/xep-0086.html>.

  Example legacy error stanzas:

      <error xmlns="jabber:client" code="501" type="cancel">
        <feature-not-implemented
              xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" />
      </error>

      <error code="402" type="auth">
        <payment-required
              xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" />
      </error>

  Variables:

    error_map – A map of error conditions to error types and code values.

  error_map = {'bad-request': ('modify', '400'), 'conflict': ('cancel', '409'), 'feature-not-implemented': ('cancel', '501'), 'forbidden': ('auth', '403'), 'gone': ('modify', '302'), 'internal-server-error': ('wait', '500'), 'item-not-found': ('cancel', '404'), 'jid-malformed': ('modify', '400'), 'not-acceptable': ('modify', '406'), 'not-allowed': ('cancel', '405'), 'not-authorized': ('auth', '401'), 'payment-required': ('auth', '402'), 'recipient-unavailable': ('wait', '404'), 'redirect': ('modify', '302'), 'registration-required': ('auth', '407'), 'remote-server-not-found': ('cancel', '404'), 'remote-server-timeout': ('wait', '504'), 'resource-constraint': ('wait', '500'), 'service-unavailable': ('cancel', '503'), 'subscription-required': ('auth', '407'), 'undefined-condition': (None, '500'), 'unexpected-request': ('wait', '400')}
  interfaces: ClassVar[set[str]] = {'condition'}

    The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the `plugin_attrib` value of any registered stanza plugins.

  name: ClassVar[str] = 'legacy'

    The XML tag name of the element, not including any namespace prefixes. For example, an `ElementBase` object for `<message />` would use `name = 'message'`.

  namespace: str = 'jabber:client'

    The XML namespace for the element. Given `<foo xmlns="bar" />`, then `namespace = "bar"` should be used. The default namespace is `jabber:client` since this is being used in an XMPP library.

  overrides: ClassVar[list[str]] = ['set_condition']

    In some cases you may wish to override the behaviour of one of the parent stanza’s interfaces. The `overrides` list specifies the interface name and access method to be overridden. For example, to override setting the parent’s `'condition'` interface you would use:

        overrides = ['set_condition']

    Getting and deleting the `'condition'` interface would not be affected.

    Added in version 1.0-Beta5.

  plugin_attrib: ClassVar[str] = 'legacy'

    For `ElementBase` subclasses which are intended to be used as plugins, the `plugin_attrib` value defines the plugin name. Plugins may be accessed by using the `plugin_attrib` value as the interface. An example using `plugin_attrib = 'foo'`:

        register_stanza_plugin(Message, FooPlugin)
        msg = Message()
        msg['foo']['an_interface_from_the_foo_plugin']

  set_condition(value)

    Set the error type and code based on the given error condition value.

    Parameters:

      value – The new error condition.

  setup(xml)

    Don’t create XML for the plugin.