org.jivesoftware.smackx.workgroup.packet.DepartQueuePacket Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smack-legacy Show documentation

Smack legacy extensions. Usually XEPs in the state 'retracted', 'rejected', 'deprecated', 'obsolete' or in a long standing 'deferred' state.

There is a newer version: 4.5.0-beta5

Show newest version

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

package org.jivesoftware.smackx.workgroup.packet;

import org.jivesoftware.smack.packet.IQ;

import org.jxmpp.jid.EntityBareJid;
import org.jxmpp.jid.EntityJid;

/**
 * A IQ stanza used to depart a workgroup queue. There are two cases for issuing a depart
 * queue request:
 *     The user wants to leave the queue. In this case, an instance of this class
 *         should be created without passing in a user address.
 *     
An administrator or the server removes wants to remove a user from the queue.
 *         In that case, the address of the user to remove from the queue should be
 *         used to create an instance of this class.
 *
 * @author loki der quaeler
 */
public class DepartQueuePacket extends IQ {

    private final EntityJid user;

    /**
     * Creates a depart queue request stanza to the specified workgroup.
     *
     * @param workgroup the workgroup to depart.
     */
    public DepartQueuePacket(EntityBareJid workgroup) {
        this(workgroup, null);
    }

    /**
     * Creates a depart queue request to the specified workgroup and for the
     * specified user.
     *
     * @param workgroup the workgroup to depart.
     * @param user the user to make depart from the queue.
     */
    @SuppressWarnings("this-escape")
    public DepartQueuePacket(EntityBareJid workgroup, EntityJid user) {
        super("depart-queue", "http://jabber.org/protocol/workgroup");
        this.user = user;

        setTo(workgroup);
        setType(IQ.Type.set);
        setFrom(user);
    }

    @Override
    protected IQChildElementXmlStringBuilder getIQChildElementBuilder(IQChildElementXmlStringBuilder buf) {
        buf.rightAngleBracket();

        if (this.user != null) {
            buf.append("").append(this.user).append("");
        }

        return buf;
    }
}