2004-12-15 20:02:39 +01:00
|
|
|
/**
|
|
|
|
*
|
2007-02-12 01:59:05 +01:00
|
|
|
* Copyright 2003-2007 Jive Software.
|
2004-12-15 20:02:39 +01:00
|
|
|
*
|
2014-02-17 18:57:38 +01:00
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
2004-12-15 20:02:39 +01:00
|
|
|
* 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.muc;
|
|
|
|
|
2015-02-14 17:15:02 +01:00
|
|
|
import java.util.logging.Logger;
|
|
|
|
|
2017-06-14 17:12:43 +02:00
|
|
|
import org.jivesoftware.smack.packet.Presence;
|
|
|
|
|
2014-07-14 19:22:02 +02:00
|
|
|
import org.jivesoftware.smackx.muc.packet.MUCItem;
|
2014-02-15 11:35:08 +01:00
|
|
|
import org.jivesoftware.smackx.muc.packet.MUCUser;
|
2017-06-14 17:12:43 +02:00
|
|
|
|
2015-05-27 19:29:51 +02:00
|
|
|
import org.jxmpp.jid.EntityFullJid;
|
2015-02-14 17:15:02 +01:00
|
|
|
import org.jxmpp.jid.Jid;
|
|
|
|
import org.jxmpp.jid.parts.Resourcepart;
|
2004-12-15 20:02:39 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Represents the information about an occupant in a given room. The information will always have
|
|
|
|
* the affiliation and role of the occupant in the room. The full JID and nickname are optional.
|
|
|
|
*
|
|
|
|
* @author Gaston Dombiak
|
|
|
|
*/
|
|
|
|
public class Occupant {
|
2015-02-14 17:15:02 +01:00
|
|
|
|
|
|
|
private static final Logger LOGGER = Logger.getLogger(Occupant.class.getName());
|
|
|
|
|
2004-12-15 20:02:39 +01:00
|
|
|
// Fields that must have a value
|
2014-08-24 18:30:18 +02:00
|
|
|
private final MUCAffiliation affiliation;
|
|
|
|
private final MUCRole role;
|
2004-12-15 20:02:39 +01:00
|
|
|
// Fields that may have a value
|
2015-02-14 17:15:02 +01:00
|
|
|
private final Jid jid;
|
|
|
|
private final Resourcepart nick;
|
2004-12-15 20:02:39 +01:00
|
|
|
|
2014-07-14 19:22:02 +02:00
|
|
|
Occupant(MUCItem item) {
|
2004-12-15 20:02:39 +01:00
|
|
|
this.jid = item.getJid();
|
|
|
|
this.affiliation = item.getAffiliation();
|
|
|
|
this.role = item.getRole();
|
|
|
|
this.nick = item.getNick();
|
|
|
|
}
|
|
|
|
|
|
|
|
Occupant(Presence presence) {
|
|
|
|
MUCUser mucUser = (MUCUser) presence.getExtension("x",
|
|
|
|
"http://jabber.org/protocol/muc#user");
|
2014-07-14 19:22:02 +02:00
|
|
|
MUCItem item = mucUser.getItem();
|
2004-12-15 20:02:39 +01:00
|
|
|
this.jid = item.getJid();
|
|
|
|
this.affiliation = item.getAffiliation();
|
|
|
|
this.role = item.getRole();
|
2005-02-02 23:42:57 +01:00
|
|
|
// Get the nickname from the FROM attribute of the presence
|
2015-05-27 19:29:51 +02:00
|
|
|
EntityFullJid from = presence.getFrom().asEntityFullJidIfPossible();
|
2015-02-14 17:15:02 +01:00
|
|
|
if (from == null) {
|
|
|
|
LOGGER.warning("Occupant presence without resource: " + presence.getFrom());
|
|
|
|
this.nick = null;
|
2018-05-09 23:06:12 +02:00
|
|
|
} else {
|
2015-02-14 17:15:02 +01:00
|
|
|
this.nick = from.getResourcepart();
|
|
|
|
}
|
2004-12-15 20:02:39 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the full JID of the occupant. If this information was extracted from a presence and
|
|
|
|
* the room is semi or full-anonymous then the answer will be null. On the other hand, if this
|
|
|
|
* information was obtained while maintaining the voice list or the moderator list then we will
|
|
|
|
* always have a full JID.
|
|
|
|
*
|
|
|
|
* @return the full JID of the occupant.
|
|
|
|
*/
|
2015-02-14 17:15:02 +01:00
|
|
|
public Jid getJid() {
|
2004-12-15 20:02:39 +01:00
|
|
|
return jid;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the affiliation of the occupant. Possible affiliations are: "owner", "admin",
|
|
|
|
* "member", "outcast". This information will always be available.
|
|
|
|
*
|
|
|
|
* @return the affiliation of the occupant.
|
|
|
|
*/
|
2014-08-24 18:30:18 +02:00
|
|
|
public MUCAffiliation getAffiliation() {
|
2004-12-15 20:02:39 +01:00
|
|
|
return affiliation;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the current role of the occupant in the room. This information will always be
|
|
|
|
* available.
|
|
|
|
*
|
|
|
|
* @return the current role of the occupant in the room.
|
|
|
|
*/
|
2014-08-24 18:30:18 +02:00
|
|
|
public MUCRole getRole() {
|
2004-12-15 20:02:39 +01:00
|
|
|
return role;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the current nickname of the occupant in the room. If this information was extracted
|
|
|
|
* from a presence then the answer will be null.
|
|
|
|
*
|
|
|
|
* @return the current nickname of the occupant in the room or null if this information was
|
|
|
|
* obtained from a presence.
|
|
|
|
*/
|
2015-02-14 17:15:02 +01:00
|
|
|
public Resourcepart getNick() {
|
2004-12-15 20:02:39 +01:00
|
|
|
return nick;
|
|
|
|
}
|
2006-07-11 03:45:45 +02:00
|
|
|
|
2017-02-11 16:16:41 +01:00
|
|
|
@Override
|
2006-07-11 03:45:45 +02:00
|
|
|
public boolean equals(Object obj) {
|
2017-05-23 16:45:04 +02:00
|
|
|
if (!(obj instanceof Occupant)) {
|
2006-07-11 03:45:45 +02:00
|
|
|
return false;
|
|
|
|
}
|
2017-05-23 16:45:04 +02:00
|
|
|
Occupant occupant = (Occupant) obj;
|
2006-07-11 03:45:45 +02:00
|
|
|
return jid.equals(occupant.jid);
|
|
|
|
}
|
|
|
|
|
2017-02-11 16:16:41 +01:00
|
|
|
@Override
|
2006-07-11 03:45:45 +02:00
|
|
|
public int hashCode() {
|
|
|
|
int result;
|
|
|
|
result = affiliation.hashCode();
|
|
|
|
result = 17 * result + role.hashCode();
|
2017-05-19 09:16:18 +02:00
|
|
|
result = 17 * result + (jid != null ? jid.hashCode() : 0);
|
2006-07-11 03:45:45 +02:00
|
|
|
result = 17 * result + (nick != null ? nick.hashCode() : 0);
|
|
|
|
return result;
|
|
|
|
}
|
2004-12-15 20:02:39 +01:00
|
|
|
}
|