Close.java

  1. /**
  2.  *
  3.  * Copyright the original author or authors
  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.bytestreams.ibb.packet;

  18. import org.jivesoftware.smack.packet.IQ;

  19. /**
  20.  * Represents a request to close an In-Band Bytestream.
  21.  *
  22.  * @author Henning Staib
  23.  */
  24. public class Close extends IQ {

  25.     public static final String ELEMENT = "close";
  26.     public static final String NAMESPACE = DataPacketExtension.NAMESPACE;

  27.     /* unique session ID identifying this In-Band Bytestream */
  28.     private final String sessionID;

  29.     /**
  30.      * Creates a new In-Band Bytestream close request packet.
  31.      *
  32.      * @param sessionID unique session ID identifying this In-Band Bytestream
  33.      */
  34.     public Close(String sessionID) {
  35.         super(ELEMENT, NAMESPACE);
  36.         if (sessionID == null || "".equals(sessionID)) {
  37.             throw new IllegalArgumentException("Session ID must not be null or empty");
  38.         }
  39.         this.sessionID = sessionID;
  40.         setType(Type.set);
  41.     }

  42.     /**
  43.      * Returns the unique session ID identifying this In-Band Bytestream.
  44.      *
  45.      * @return the unique session ID identifying this In-Band Bytestream
  46.      */
  47.     public String getSessionID() {
  48.         return sessionID;
  49.     }

  50.     @Override
  51.     protected IQChildElementXmlStringBuilder getIQChildElementBuilder(IQChildElementXmlStringBuilder xml) {
  52.         xml.attribute("sid", sessionID);
  53.         xml.setEmptyElement();
  54.         return xml;
  55.     }

  56. }