MUCAdmin.java 7.98 KB
Newer Older
Alexander Ivanov's avatar
Alexander Ivanov committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/**
 * $RCSfile$
 * $Revision$
 * $Date$
 *
 * Copyright 2003-2007 Jive Software.
 *
 * All rights reserved. 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.packet;
22

Alexander Ivanov's avatar
Alexander Ivanov committed
23 24 25 26 27 28 29 30
import org.jivesoftware.smack.packet.IQ;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

/**
31 32 33
 * IQ packet that serves for kicking users, granting and revoking voice, banning users,
 * modifying the ban list, granting and revoking membership and granting and revoking
 * moderator privileges. All these operations are scoped by the
Alexander Ivanov's avatar
Alexander Ivanov committed
34
 * 'http://jabber.org/protocol/muc#admin' namespace.
35
 *
Alexander Ivanov's avatar
Alexander Ivanov committed
36 37 38 39 40 41 42
 * @author Gaston Dombiak
 */
public class MUCAdmin extends IQ {

    private List items = new ArrayList();

    /**
43
     * Returns an Iterator for item childs that holds information about roles, affiliation,
Alexander Ivanov's avatar
Alexander Ivanov committed
44
     * jids and nicks.
45
     *
Alexander Ivanov's avatar
Alexander Ivanov committed
46
     * @return an Iterator for item childs that holds information about roles, affiliation,
47
     * jids and nicks.
Alexander Ivanov's avatar
Alexander Ivanov committed
48 49 50 51 52 53 54 55 56
     */
    public Iterator getItems() {
        synchronized (items) {
            return Collections.unmodifiableList(new ArrayList(items)).iterator();
        }
    }

    /**
     * Adds an item child that holds information about roles, affiliation, jids and nicks.
57
     *
Alexander Ivanov's avatar
Alexander Ivanov committed
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
     * @param item the item child that holds information about roles, affiliation, jids and nicks.
     */
    public void addItem(Item item) {
        synchronized (items) {
            items.add(item);
        }
    }

    public String getChildElementXML() {
        StringBuilder buf = new StringBuilder();
        buf.append("<query xmlns=\"http://jabber.org/protocol/muc#admin\">");
        synchronized (items) {
            for (int i = 0; i < items.size(); i++) {
                Item item = (Item) items.get(i);
                buf.append(item.toXML());
            }
        }
        // Add packet extensions, if any are defined.
        buf.append(getExtensionsXML());
        buf.append("</query>");
        return buf.toString();
    }

    /**
     * Item child that holds information about roles, affiliation, jids and nicks.
     *
     * @author Gaston Dombiak
     */
    public static class Item {
        private String actor;
        private String reason;
        private String affiliation;
        private String jid;
        private String nick;
        private String role;
93

Alexander Ivanov's avatar
Alexander Ivanov committed
94
        /**
95 96
         * Creates a new item child.
         *
Alexander Ivanov's avatar
Alexander Ivanov committed
97
         * @param affiliation the actor's affiliation to the room
98
         * @param role        the privilege level of an occupant within a room.
Alexander Ivanov's avatar
Alexander Ivanov committed
99 100 101 102 103
         */
        public Item(String affiliation, String role) {
            this.affiliation = affiliation;
            this.role = role;
        }
104

Alexander Ivanov's avatar
Alexander Ivanov committed
105 106
        /**
         * Returns the actor (JID of an occupant in the room) that was kicked or banned.
107
         *
Alexander Ivanov's avatar
Alexander Ivanov committed
108 109 110 111 112 113 114 115 116
         * @return the JID of an occupant in the room that was kicked or banned.
         */
        public String getActor() {
            return actor;
        }

        /**
         * Returns the reason for the item child. The reason is optional and could be used to
         * explain the reason why a user (occupant) was kicked or banned.
117
         *
Alexander Ivanov's avatar
Alexander Ivanov committed
118 119 120 121 122 123 124
         * @return the reason for the item child.
         */
        public String getReason() {
            return reason;
        }

        /**
125 126 127
         * Returns the occupant's affiliation to the room. The affiliation is a semi-permanent
         * association or connection with a room. The possible affiliations are "owner", "admin",
         * "member", and "outcast" (naturally it is also possible to have no affiliation). An
Alexander Ivanov's avatar
Alexander Ivanov committed
128
         * affiliation lasts across a user's visits to a room.
129
         *
Alexander Ivanov's avatar
Alexander Ivanov committed
130 131 132 133 134 135 136
         * @return the actor's affiliation to the room
         */
        public String getAffiliation() {
            return affiliation;
        }

        /**
137 138 139
         * Returns the <room@service/nick> by which an occupant is identified within the context
         * of a room. If the room is non-anonymous, the JID will be included in the item.
         *
Alexander Ivanov's avatar
Alexander Ivanov committed
140 141 142 143 144 145 146
         * @return the room JID by which an occupant is identified within the room.
         */
        public String getJid() {
            return jid;
        }

        /**
147 148 149
         * Returns the new nickname of an occupant that is changing his/her nickname. The new
         * nickname is sent as part of the unavailable presence.
         *
Alexander Ivanov's avatar
Alexander Ivanov committed
150 151 152 153 154 155 156
         * @return the new nickname of an occupant that is changing his/her nickname.
         */
        public String getNick() {
            return nick;
        }

        /**
157 158 159 160 161
         * Returns the temporary position or privilege level of an occupant within a room. The
         * possible roles are "moderator", "participant", and "visitor" (it is also possible to
         * have no defined role). A role lasts only for the duration of an occupant's visit to
         * a room.
         *
Alexander Ivanov's avatar
Alexander Ivanov committed
162 163 164 165 166 167 168 169
         * @return the privilege level of an occupant within a room.
         */
        public String getRole() {
            return role;
        }

        /**
         * Sets the actor (JID of an occupant in the room) that was kicked or banned.
170
         *
Alexander Ivanov's avatar
Alexander Ivanov committed
171 172 173 174 175 176 177 178 179
         * @param actor the actor (JID of an occupant in the room) that was kicked or banned.
         */
        public void setActor(String actor) {
            this.actor = actor;
        }

        /**
         * Sets the reason for the item child. The reason is optional and could be used to
         * explain the reason why a user (occupant) was kicked or banned.
180
         *
Alexander Ivanov's avatar
Alexander Ivanov committed
181 182 183 184 185 186 187
         * @param reason the reason why a user (occupant) was kicked or banned.
         */
        public void setReason(String reason) {
            this.reason = reason;
        }

        /**
188
         * Sets the <room@service/nick> by which an occupant is identified within the context
Alexander Ivanov's avatar
Alexander Ivanov committed
189
         * of a room. If the room is non-anonymous, the JID will be included in the item.
190
         *
Alexander Ivanov's avatar
Alexander Ivanov committed
191 192 193 194 195 196 197
         * @param jid the JID by which an occupant is identified within a room.
         */
        public void setJid(String jid) {
            this.jid = jid;
        }

        /**
198
         * Sets the new nickname of an occupant that is changing his/her nickname. The new
Alexander Ivanov's avatar
Alexander Ivanov committed
199
         * nickname is sent as part of the unavailable presence.
200
         *
Alexander Ivanov's avatar
Alexander Ivanov committed
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
         * @param nick the new nickname of an occupant that is changing his/her nickname.
         */
        public void setNick(String nick) {
            this.nick = nick;
        }

        public String toXML() {
            StringBuilder buf = new StringBuilder();
            buf.append("<item");
            if (getAffiliation() != null) {
                buf.append(" affiliation=\"").append(getAffiliation()).append("\"");
            }
            if (getJid() != null) {
                buf.append(" jid=\"").append(getJid()).append("\"");
            }
            if (getNick() != null) {
                buf.append(" nick=\"").append(getNick()).append("\"");
            }
            if (getRole() != null) {
                buf.append(" role=\"").append(getRole()).append("\"");
            }
            if (getReason() == null && getActor() == null) {
                buf.append("/>");
224
            } else {
Alexander Ivanov's avatar
Alexander Ivanov committed
225 226 227 228 229 230 231 232 233 234 235
                buf.append(">");
                if (getReason() != null) {
                    buf.append("<reason>").append(getReason()).append("</reason>");
                }
                if (getActor() != null) {
                    buf.append("<actor jid=\"").append(getActor()).append("\"/>");
                }
                buf.append("</item>");
            }
            return buf.toString();
        }
236 237 238
    }

    ;
Alexander Ivanov's avatar
Alexander Ivanov committed
239
}