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 org.jivesoftware.smack.packet.IQ;
  20. import org.jivesoftware.smack.packet.NamedElement;
  21. import org.jivesoftware.smack.util.XmlStringBuilder;
  22. import org.jivesoftware.smackx.shim.packet.HeadersExtension;

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

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

  34.     protected AbstractHttpOverXmpp(String element) {
  35.         super(element, NAMESPACE);
  36.     }

  38.     private HeadersExtension headers;
  39.     private Data data;

  41.     protected String version;

  43.     protected IQChildElementXmlStringBuilder getIQChildElementBuilder(IQChildElementXmlStringBuilder xml) {
  44.         IQChildElementXmlStringBuilder builder = getIQHoxtChildElementBuilder(xml);
  45.         builder.append(headers.toXML());
  46.         builder.append(data.toXML());

  48.         return builder;
  49.     }

  51.     /**
  52.      * Returns start tag.
  53.      *
  54.      * @return start tag
  55.      */
  56.     protected abstract IQChildElementXmlStringBuilder getIQHoxtChildElementBuilder(IQChildElementXmlStringBuilder xml);

  58.     /**
  59.      * Returns version attribute.
  60.      *
  61.      * @return version attribute
  62.      */
  63.     public String getVersion() {
  64.         return version;
  65.     }

  67.     /**
  68.      * Sets version attribute.
  69.      *
  70.      * @param version version attribute
  71.      */
  72.     public void setVersion(String version) {
  73.         this.version = version;
  74.     }

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

  85.     /**
  86.      * Sets Headers element.
  87.      *
  88.      * @param headers Headers element
  89.      */
  90.     public void setHeaders(HeadersExtension headers) {
  91.         this.headers = headers;
  92.     }

  94.     /**
  95.      * Returns Data element.
  96.      *
  97.      * @return Data element
  98.      */
  99.     public Data getData() {
  100.         return data;
  101.     }

  103.     /**
  104.      * Sets Data element.
  105.      *
  106.      * @param data Headers element
  107.      */
  108.     public void setData(Data data) {
  109.         this.data = data;
  110.     }

  112.     /**
  113.      * Representation of Data element.<p>
  114.      * This class is immutable.
  115.      */
  116.     public static class Data {

  118.         private final NamedElement child;

  120.         /**
  121.          * Creates Data element.
  122.          *
  123.          * @param child element nested by Data
  124.          */
  125.         public Data(NamedElement child) {
  126.             this.child = child;
  127.         }

  129.         /**
  130.          * Returns string containing xml representation of this object.
  131.          *
  132.          * @return xml representation of this object
  133.          */
  134.         public String toXML() {
  135.             StringBuilder builder = new StringBuilder();
  136.             builder.append("<data>");
  137.             builder.append(child.toXML());
  138.             builder.append("</data>");
  139.             return builder.toString();
  140.         }

  142.         /**
  143.          * Returns element nested by Data.
  144.          *
  145.          * @return element nested by Data
  146.          */
  147.         public NamedElement getChild() {
  148.             return child;
  149.         }
  150.     }

  152.     /**
  153.      * Representation of Text element.<p>
  154.      * This class is immutable.
  155.      */
  156.     public static class Text implements NamedElement {

  158.         public static final String ELEMENT = "text";

  160.         private final String text;

  162.         /**
  163.          * Creates this element.
  164.          *
  165.          * @param text value of text
  166.          */
  167.         public Text(String text) {
  168.             this.text = text;
  169.         }

  171.         @Override
  172.         public XmlStringBuilder toXML() {
  173.             XmlStringBuilder xml = new XmlStringBuilder(this);
  174.             xml.rightAngleBracket();
  175.             xml.optAppend(text);
  176.             xml.closeElement(this);
  177.             return xml;
  178.         }

  180.         /**
  181.          * Returns text of this element.
  182.          *
  183.          * @return text
  184.          */
  185.         public String getText() {
  186.             return text;
  187.         }

  189.         @Override
  190.         public String getElementName() {
  191.             return ELEMENT;
  192.         }
  193.     }

  195.     /**
  196.      * Representation of Base64 element.<p>
  197.      * This class is immutable.
  198.      */
  199.     public static class Base64 implements NamedElement {

  201.         public static final String ELEMENT = "base64";

  203.         private final String text;

  205.         /**
  206.          * Creates this element.
  207.          *
  208.          * @param text value of text
  209.          */
  210.         public Base64(String text) {
  211.             this.text = text;
  212.         }

  214.         @Override
  215.         public XmlStringBuilder toXML() {
  216.             XmlStringBuilder xml = new XmlStringBuilder(this);
  217.             xml.rightAngleBracket();
  218.             xml.optAppend(text);
  219.             xml.closeElement(this);
  220.             return xml;
  221.         }

  223.         /**
  224.          * Returns text of this element.
  225.          *
  226.          * @return text
  227.          */
  228.         public String getText() {
  229.             return text;
  230.         }

  232.         @Override
  233.         public String getElementName() {
  234.             return ELEMENT;
  235.         }
  236.     }

  238.     /**
  239.      * Representation of Xml element.<p>
  240.      * This class is immutable.
  241.      */
  242.     public static class Xml implements NamedElement {

  244.         public static final String ELEMENT = "xml";

  246.         private final String text;

  248.         /**
  249.          * Creates this element.builder.toString();
  250.          *
  251.          * @param text value of text
  252.          */
  253.         public Xml(String text) {
  254.             this.text = text;
  255.         }

  257.         @Override
  258.         public XmlStringBuilder toXML() {
  259.             XmlStringBuilder xml = new XmlStringBuilder(this);
  260.             xml.rightAngleBracket();
  261.             xml.optAppend(text);
  262.             xml.closeElement(this);
  263.             return xml;
  264.         }

  266.         /**
  267.          * Returns text of this element.
  268.          *
  269.          * @return text
  270.          */
  271.         public String getText() {
  272.             return text;
  273.         }

  275.         @Override
  276.         public String getElementName() {
  277.             return ELEMENT;
  278.         }
  279.     }

  281.     /**
  282.      * Representation of ChunkedBase64 element.<p>
  283.      * This class is immutable.
  284.      */
  285.     public static class ChunkedBase64 implements NamedElement {

  287.         public static final String ELEMENT = "chunkedBase64";

  289.         private final String streamId;

  291.         /**
  292.          * Creates ChunkedBase86 element.
  293.          *
  294.          * @param streamId streamId attribute
  295.          */
  296.         public ChunkedBase64(String streamId) {
  297.             this.streamId = streamId;
  298.         }

  300.         @Override
  301.         public XmlStringBuilder toXML() {
  302.             XmlStringBuilder xml = new XmlStringBuilder(this);
  303.             xml.attribute("streamId", streamId);
  304.             xml.closeEmptyElement();
  305.             return xml;
  306.         }

  308.         /**
  309.          * Returns streamId attribute.
  310.          *
  311.          * @return streamId attribute
  312.          */
  313.         public String getStreamId() {
  314.             return streamId;
  315.         }

  317.         @Override
  318.         public String getElementName() {
  319.             return ELEMENT;
  320.         }
  321.     }

  323.     /**
  324.      * Representation of Ibb element.<p>
  325.      * This class is immutable.
  326.      */
  327.     public static class Ibb implements NamedElement {

  329.         public static final String ELEMENT = "ibb";

  331.         private final String sid;

  333.         /**
  334.          * Creates Ibb element.
  335.          *
  336.          * @param sid sid attribute
  337.          */
  338.         public Ibb(String sid) {
  339.             this.sid = sid;
  340.         }

  342.         @Override
  343.         public XmlStringBuilder toXML() {
  344.             XmlStringBuilder xml = new XmlStringBuilder(this);
  345.             xml.attribute("sid", sid);
  346.             xml.closeEmptyElement();
  347.             return xml;
  348.         }

  350.         /**
  351.          * Returns sid attribute.
  352.          *
  353.          * @return sid attribute
  354.          */
  355.         public String getSid() {
  356.             return sid;
  357.         }

  359.         @Override
  360.         public String getElementName() {
  361.             return ELEMENT;
  362.         }
  363.     }
  364. }
Created with JaCoCo 0.7.4.201502262128