AbstractHttpOverXmpp.java

  1. /**
  2.  *
  3.  * Copyright 2014 Andriy Tsykholyas
  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.  */
  17. package org.jivesoftware.smackx.hoxt.packet;

  19. import javax.xml.namespace.QName;

  21. import org.jivesoftware.smack.packet.ExtensionElement;
  22. import org.jivesoftware.smack.packet.IQ;
  23. import org.jivesoftware.smack.packet.NamedElement;
  24. import org.jivesoftware.smack.util.Objects;
  25. import org.jivesoftware.smack.util.XmlStringBuilder;

  27. import org.jivesoftware.smackx.shim.packet.HeadersExtension;

  29. /**
  30.  * Abstract parent for Req and Resp IQ packets.
  31.  *
  32.  * @author Andriy Tsykholyas
  33.  * @see <a href="http://xmpp.org/extensions/xep-0332.html">XEP-0332: HTTP over XMPP transport</a>
  34.  */
  35. public abstract class AbstractHttpOverXmpp extends IQ {

  37.     public static final String NAMESPACE = "urn:xmpp:http";

  39.     private final HeadersExtension headers;
  40.     private final Data data;

  42.     private final String version;

  44.     protected AbstractHttpOverXmpp(String element, Builder<?, ?> builder) {
  45.         super(element, NAMESPACE);
  46.         this.headers = builder.headers;
  47.         this.data = builder.data;
  48.         this.version = Objects.requireNonNull(builder.version, "version must not be null");
  49.     }

  51.     @Override
  52.     protected IQChildElementXmlStringBuilder getIQChildElementBuilder(IQChildElementXmlStringBuilder xml) {
  53.         IQChildElementXmlStringBuilder builder = getIQHoxtChildElementBuilder(xml);
  54.         builder.optAppend(headers);
  55.         builder.optAppend(data);
  56.         return builder;
  57.     }

  59.     /**
  60.      * Returns start tag.
  61.      *
  62.      * @param xml builder.
  63.      * @return start tag
  64.      */
  65.     protected abstract IQChildElementXmlStringBuilder getIQHoxtChildElementBuilder(IQChildElementXmlStringBuilder xml);

  67.     /**
  68.      * Returns version attribute.
  69.      *
  70.      * @return version attribute
  71.      */
  72.     public String getVersion() {
  73.         return version;
  74.     }

  76.     /**
  77.      * Returns Headers element.
  78.      *
  79.      * @return Headers element
  80.      */
  81.     public HeadersExtension getHeaders() {
  82.         return headers;
  83.     }

  85.     /**
  86.      * Returns Data element.
  87.      *
  88.      * @return Data element
  89.      */
  90.     public Data getData() {
  91.         return data;
  92.     }

  94.     /**
  95.      * A builder for XMPP connection configurations.
  96.      * <p>
  97.      * See ConnectionConfiguration Builder for more details.
  98.      * </p>
  99.      *
  100.      * @param <B> the builder type parameter.
  101.      * @param <C> the resulting HttpOverXmpp IQ
  102.      */
  103.     public abstract static class Builder<B extends Builder<B, C>, C extends AbstractHttpOverXmpp> {

  105.         private HeadersExtension headers;
  106.         private Data data;

  108.         private String version = "1.1";

  110.         /**
  111.          * Sets Data element.
  112.          *
  113.          * @param data Headers element
  114.          *
  115.          * @return the builder
  116.          */
  117.         public B setData(Data data) {
  118.             this.data = data;
  119.             return getThis();
  120.         }

  122.         /**
  123.          * Sets Headers element.
  124.          *
  125.          * @param headers Headers element
  126.          *
  127.          * @return the builder
  128.          */
  129.         public B setHeaders(HeadersExtension headers) {
  130.             this.headers = headers;
  131.             return getThis();
  132.         }

  134.         /**
  135.          * Sets version attribute.
  136.          *
  137.          * @param version version attribute
  138.          *
  139.          * @return the builder
  140.          */
  141.         public B setVersion(String version) {
  142.             this.version = version;
  143.             return getThis();
  144.         }

  146.         public abstract C build();

  148.         protected abstract B getThis();
  149.     }

  151.     private abstract static class HoxExtensionElement implements ExtensionElement {
  152.         @Override
  153.         public final String getNamespace() {
  154.             return NAMESPACE;
  155.         }
  156.     }

  158.     /**
  159.      * Representation of Data element.
  160.      * <p>
  161.      * This class is immutable.
  162.      */
  163.     public static class Data extends HoxExtensionElement {

  165.         public static final String ELEMENT = "data";
  166.         public static final QName QNAME = new QName(NAMESPACE, ELEMENT);

  168.         private final NamedElement child;

  170.         /**
  171.          * Creates Data element.
  172.          *
  173.          * @param child element nested by Data
  174.          */
  175.         public Data(NamedElement child) {
  176.             this.child = child;
  177.         }

  179.         /**
  180.          * Returns string containing xml representation of this object.
  181.          *
  182.          * @return xml representation of this object
  183.          */
  184.         @Override
  185.         public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
  186.             XmlStringBuilder xml = new XmlStringBuilder(this, enclosingNamespace);
  187.             xml.rightAngleBracket();
  188.             xml.append(child);
  189.             xml.closeElement(this);
  190.             return xml;
  191.         }

  193.         /**
  194.          * Returns element nested by Data.
  195.          *
  196.          * @return element nested by Data
  197.          */
  198.         public NamedElement getChild() {
  199.             return child;
  200.         }

  202.         @Override
  203.         public String getElementName() {
  204.             return ELEMENT;
  205.         }
  206.     }

  208.     /**
  209.      * Representation of Text element.
  210.      * <p>
  211.      * This class is immutable.
  212.      */
  213.     public static class Text extends HoxExtensionElement {

  215.         public static final String ELEMENT = "text";
  216.         public static final QName QNAME = new QName(NAMESPACE, ELEMENT);

  218.         private final String text;

  220.         /**
  221.          * Creates this element.
  222.          *
  223.          * @param text value of text
  224.          */
  225.         public Text(String text) {
  226.             this.text = text;
  227.         }

  229.         @Override
  230.         public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
  231.             XmlStringBuilder xml = new XmlStringBuilder(this, enclosingNamespace);
  232.             xml.optTextChild(text, this);
  233.             return xml;
  234.         }

  236.         /**
  237.          * Returns text of this element.
  238.          *
  239.          * @return text TODO javadoc me please
  240.          */
  241.         public String getText() {
  242.             return text;
  243.         }

  245.         @Override
  246.         public String getElementName() {
  247.             return ELEMENT;
  248.         }
  249.     }

  251.     /**
  252.      * Representation of Base64 element.
  253.      * <p>
  254.      * This class is immutable.
  255.      */
  256.     public static class Base64 extends HoxExtensionElement {

  258.         public static final String ELEMENT = "base64";
  259.         public static final QName QNAME = new QName(NAMESPACE, ELEMENT);

  261.         private final String text;

  263.         /**
  264.          * Creates this element.
  265.          *
  266.          * @param text value of text
  267.          */
  268.         public Base64(String text) {
  269.             this.text = text;
  270.         }

  272.         @Override
  273.         public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
  274.             XmlStringBuilder xml = new XmlStringBuilder(this, enclosingNamespace);
  275.             xml.optTextChild(text, this);
  276.             return xml;
  277.         }

  279.         /**
  280.          * Returns text of this element.
  281.          *
  282.          * @return text TODO javadoc me please
  283.          */
  284.         public String getText() {
  285.             return text;
  286.         }

  288.         @Override
  289.         public String getElementName() {
  290.             return ELEMENT;
  291.         }
  292.     }

  294.     /**
  295.      * Representation of Xml element.
  296.      * <p>
  297.      * This class is immutable.
  298.      */
  299.     public static class Xml extends HoxExtensionElement {

  301.         public static final String ELEMENT = "xml";
  302.         public static final QName QNAME = new QName(NAMESPACE, ELEMENT);

  304.         private final String text;

  306.         /**
  307.          * Creates this element.builder.toString().
  308.          *
  309.          * @param text value of text
  310.          */
  311.         public Xml(String text) {
  312.             this.text = text;
  313.         }

  315.         @Override
  316.         public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
  317.             XmlStringBuilder xml = new XmlStringBuilder(this, enclosingNamespace);
  318.             xml.optTextChild(text, this);
  319.             return xml;
  320.         }

  322.         /**
  323.          * Returns text of this element.
  324.          *
  325.          * @return text TODO javadoc me please
  326.          */
  327.         public String getText() {
  328.             return text;
  329.         }

  331.         @Override
  332.         public String getElementName() {
  333.             return ELEMENT;
  334.         }
  335.     }

  337.     /**
  338.      * Representation of ChunkedBase64 element.
  339.      * <p>
  340.      * This class is immutable.
  341.      */
  342.     public static class ChunkedBase64 extends HoxExtensionElement {

  344.         public static final String ELEMENT = "chunkedBase64";
  345.         public static final QName QNAME = new QName(NAMESPACE, ELEMENT);

  347.         private final String streamId;

  349.         /**
  350.          * Creates ChunkedBase86 element.
  351.          *
  352.          * @param streamId streamId attribute
  353.          */
  354.         public ChunkedBase64(String streamId) {
  355.             this.streamId = streamId;
  356.         }

  358.         @Override
  359.         public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
  360.             XmlStringBuilder xml = new XmlStringBuilder(this, enclosingNamespace);
  361.             xml.attribute("streamId", streamId);
  362.             xml.closeEmptyElement();
  363.             return xml;
  364.         }

  366.         /**
  367.          * Returns streamId attribute.
  368.          *
  369.          * @return streamId attribute
  370.          */
  371.         public String getStreamId() {
  372.             return streamId;
  373.         }

  375.         @Override
  376.         public String getElementName() {
  377.             return ELEMENT;
  378.         }
  379.     }

  381.     /**
  382.      * Representation of Ibb element.
  383.      * <p>
  384.      * This class is immutable.
  385.      */
  386.     public static class Ibb extends HoxExtensionElement {

  388.         public static final String ELEMENT = "ibb";
  389.         public static final QName QNAME = new QName(NAMESPACE, ELEMENT);

  391.         private final String sid;

  393.         /**
  394.          * Creates Ibb element.
  395.          *
  396.          * @param sid sid attribute
  397.          */
  398.         public Ibb(String sid) {
  399.             this.sid = sid;
  400.         }

  402.         @Override
  403.         public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
  404.             XmlStringBuilder xml = new XmlStringBuilder(this, enclosingNamespace);
  405.             xml.attribute("sid", sid);
  406.             xml.closeEmptyElement();
  407.             return xml;
  408.         }

  410.         /**
  411.          * Returns sid attribute.
  412.          *
  413.          * @return sid attribute
  414.          */
  415.         public String getSid() {
  416.             return sid;
  417.         }

  419.         @Override
  420.         public String getElementName() {
  421.             return ELEMENT;
  422.         }
  423.     }
  424. }
Created with JaCoCo 0.8.6.202009150832