StreamError.java

  1. /**
  2.  *
  3.  * Copyright 2003-2005 Jive Software.
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */

  18. package org.jivesoftware.smack.packet;

  20. import java.util.List;
  21. import java.util.Map;

  23. import org.jivesoftware.smack.util.StringUtils;
  24. import org.jivesoftware.smack.util.XmlStringBuilder;

  26. /**
  27.  * Represents a stream error packet. Stream errors are unrecoverable errors where the server
  28.  * will close the underlying TCP connection after the stream error was sent to the client.
  29.  * These is the list of stream errors as defined in the XMPP spec:
  30.  *
  31.  * <table border=1>
  32.  *      <caption>Stream Errors</caption>
  33.  *      <tr><td><b>Code</b></td><td><b>Description</b></td></tr>
  34.  *      <tr><td> bad-format </td><td> the entity has sent XML that cannot be processed </td></tr>
  35.  *      <tr><td> unsupported-encoding </td><td>  the entity has sent a namespace prefix that is
  36.  *          unsupported </td></tr>
  37.  *      <tr><td> bad-namespace-prefix </td><td> Remote Server Timeout </td></tr>
  38.  *      <tr><td> conflict </td><td> the server is closing the active stream for this entity
  39.  *          because a new stream has been initiated that conflicts with the existing
  40.  *          stream. </td></tr>
  41.  *      <tr><td> connection-timeout </td><td> the entity has not generated any traffic over
  42.  *          the stream for some period of time. </td></tr>
  43.  *      <tr><td> host-gone </td><td> the value of the 'to' attribute provided by the initiating
  44.  *          entity in the stream header corresponds to a hostname that is no longer hosted by
  45.  *          the server. </td></tr>
  46.  *      <tr><td> host-unknown </td><td> the value of the 'to' attribute provided by the
  47.  *          initiating entity in the stream header does not correspond to a hostname that is
  48.  *          hosted by the server. </td></tr>
  49.  *      <tr><td> improper-addressing </td><td> a stanza sent between two servers lacks a 'to'
  50.  *          or 'from' attribute </td></tr>
  51.  *      <tr><td> internal-server-error </td><td> the server has experienced a
  52.  *          misconfiguration. </td></tr>
  53.  *      <tr><td> invalid-from </td><td> the JID or hostname provided in a 'from' address does
  54.  *          not match an authorized JID. </td></tr>
  55.  *      <tr><td> invalid-namespace </td><td> the streams namespace name is invalid. </td></tr>
  56.  *      <tr><td> invalid-xml </td><td> the entity has sent invalid XML over the stream. </td></tr>
  57.  *      <tr><td> not-authorized </td><td> the entity has attempted to send data before the
  58.  *          stream has been authenticated </td></tr>
  59.  *      <tr><td> policy-violation </td><td> the entity has violated some local service
  60.  *          policy. </td></tr>
  61.  *      <tr><td> remote-connection-failed </td><td> the server is unable to properly connect
  62.  *          to a remote entity. </td></tr>
  63.  *      <tr><td> resource-constraint </td><td> the server lacks the system resources necessary
  64.  *          to service the stream. </td></tr>
  65.  *      <tr><td> restricted-xml </td><td> the entity has attempted to send restricted XML
  66.  *          features. </td></tr>
  67.  *      <tr><td> see-other-host </td><td>  the server will not provide service to the initiating
  68.  *          entity but is redirecting traffic to another host. </td></tr>
  69.  *      <tr><td> system-shutdown </td><td> the server is being shut down and all active streams
  70.  *          are being closed. </td></tr>
  71.  *      <tr><td> undefined-condition </td><td> the error condition is not one of those defined
  72.  *          by the other conditions in this list. </td></tr>
  73.  *      <tr><td> unsupported-encoding </td><td> the initiating entity has encoded the stream in
  74.  *          an encoding that is not supported. </td></tr>
  75.  *      <tr><td> unsupported-stanza-type </td><td> the initiating entity has sent a first-level
  76.  *          child of the stream that is not supported. </td></tr>
  77.  *      <tr><td> unsupported-version </td><td> the value of the 'version' attribute provided by
  78.  *          the initiating entity in the stream header specifies a version of XMPP that is not
  79.  *          supported. </td></tr>
  80.  *      <tr><td> not-well-formed </td><td> the initiating entity has sent XML that is not
  81.  *          well-formed. </td></tr>
  82.  * </table>
  83.  * <p>
  84.  * Stream error syntax:
  85.  * <pre>
  86.  * {@code
  87.  * <stream:error>
  88.  *   <defined-condition xmlns='urn:ietf:params:xml:ns:xmpp-streams'/>
  89.  *   [<text xmlns='urn:ietf:params:xml:ns:xmpp-streams'
  90.  *      xml:lang='langcode'>
  91.  *   OPTIONAL descriptive text
  92.  *   </text>]
  93.  *   [OPTIONAL application-specific condition element]
  94.  * </stream:error>
  95.  * }
  96.  * </pre>
  97.  *
  98.  * @author Gaston Dombiak
  99.  */
  100. public class StreamError extends AbstractError implements Nonza {

  102.     public static final String ELEMENT = "stream:error";
  103.     public static final String NAMESPACE = "urn:ietf:params:xml:ns:xmpp-streams";

  105.     private final Condition condition;
  106.     private final String conditionText;

  108.     public StreamError(Condition condition, String conditionText, Map<String, String> descriptiveTexts, List<XmlElement> extensions) {
  109.         super(descriptiveTexts, extensions);
  110.         // Some implementations may send the condition as non-empty element containing the empty string, that is
  111.         // <condition xmlns='foo'></condition>, in this case the parser may calls this constructor with the empty string
  112.         // as conditionText, therefore reset it to null if it's the empty string
  113.         if (StringUtils.isNullOrEmpty(conditionText)) {
  114.             conditionText = null;
  115.         }
  116.         if (conditionText != null) {
  117.             switch (condition) {
  118.             case see_other_host:
  119.                 break;
  120.             default:
  121.                 throw new IllegalArgumentException("The given condition '" + condition
  122.                                 + "' can not contain a conditionText");
  123.             }
  124.         }
  125.         this.condition = condition;
  126.         this.conditionText = conditionText;
  127.     }

  129.     public Condition getCondition() {
  130.         return condition;
  131.     }

  133.     public String getConditionText() {
  134.         return conditionText;
  135.     }

  137.     @Override
  138.     public String toString() {
  139.         return toXML().toString();
  140.     }

  142.     @Override
  143.     public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
  144.         XmlStringBuilder xml = new XmlStringBuilder();
  145.         xml.openElement(ELEMENT);
  146.         xml.halfOpenElement(condition.toString()).xmlnsAttribute(NAMESPACE).closeEmptyElement();
  147.         addDescriptiveTextsAndExtensions(xml);
  148.         xml.closeElement(ELEMENT);
  149.         return xml;
  150.     }

  152.     /**
  153.      * The defined stream error conditions, see RFC 6120 ยง 4.9.3.
  154.      *
  155.      */
  156.     public enum Condition {
  157.         bad_format,
  158.         bad_namespace_prefix,
  159.         conflict,
  160.         connection_timeout,
  161.         host_gone,
  162.         host_unknown,
  163.         improper_addressing,
  164.         internal_server_error,
  165.         invalid_from,
  166.         invalid_namespace,
  167.         invalid_xml,
  168.         not_authorized,
  169.         not_well_formed,
  170.         policy_violation,
  171.         remote_connection_failed,
  172.         reset,
  173.         resource_constraint,
  174.         restricted_xml,
  175.         see_other_host,
  176.         system_shutdown,
  177.         undefined_condition,
  178.         unsupported_encoding,
  179.         unsupported_feature,
  180.         unsupported_stanza_type,
  181.         unsupported_version;

  183.         @Override
  184.         public String toString() {
  185.             return this.name().replace('_', '-');
  186.         }

  188.         public static Condition fromString(String string) {
  189.             // Backwards compatibility for older implementations still using RFC 3920. RFC 6120
  190.             // changed 'xml-not-well-formed' to 'not-well-formed'.
  191.             if ("xml-not-well-formed".equals(string)) {
  192.                 string = "not-well-formed";
  193.             }
  194.             string = string.replace('-', '_');
  195.             Condition condition = null;
  196.             try {
  197.                 condition = Condition.valueOf(string);
  198.             } catch (Exception e) {
  199.                 throw new IllegalStateException("Could not transform string '" + string
  200.                                 + "' to XMPPErrorCondition", e);
  201.             }
  202.             return condition;
  203.         }
  204.     }

  206.     @Override
  207.     public String getNamespace() {
  208.         return NAMESPACE;
  209.     }

  211.     @Override
  212.     public String getElementName() {
  213.         return ELEMENT;
  214.     }
  215. }
Created with JaCoCo 0.8.6.202009150832