001/**
002 *
003 * Copyright the original author or authors
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.jivesoftware.smackx.bytestreams.ibb.packet;
018
019import org.jivesoftware.smack.packet.IQ;
020
021/**
022 * Represents a request to close an In-Band Bytestream.
023 *
024 * @author Henning Staib
025 */
026public class Close extends IQ {
027
028    public static final String ELEMENT = "close";
029    public static final String NAMESPACE = DataPacketExtension.NAMESPACE;
030
031    /* unique session ID identifying this In-Band Bytestream */
032    private final String sessionID;
033
034    /**
035     * Creates a new In-Band Bytestream close request packet.
036     *
037     * @param sessionID unique session ID identifying this In-Band Bytestream
038     */
039    @SuppressWarnings("this-escape")
040    public Close(String sessionID) {
041        super(ELEMENT, NAMESPACE);
042        if (sessionID == null || "".equals(sessionID)) {
043            throw new IllegalArgumentException("Session ID must not be null or empty");
044        }
045        this.sessionID = sessionID;
046        setType(Type.set);
047    }
048
049    /**
050     * Returns the unique session ID identifying this In-Band Bytestream.
051     *
052     * @return the unique session ID identifying this In-Band Bytestream
053     */
054    public String getSessionID() {
055        return sessionID;
056    }
057
058    @Override
059    protected IQChildElementXmlStringBuilder getIQChildElementBuilder(IQChildElementXmlStringBuilder xml) {
060        xml.attribute("sid", sessionID);
061        xml.setEmptyElement();
062        return xml;
063    }
064
065}