Package org.jivesoftware.openfire.muc.spi

Class LocalMUCRoom

  • All Implemented Interfaces:
    Externalizable, Serializable, GroupEventListener, MUCRoom, org.xmpp.resultsetmanagement.Result
    public class LocalMUCRoom
extends Object
implements MUCRoom, GroupEventListener
    Implementation of a chatroom that is being hosted by this JVM. A LocalMUCRoom could represent a persistent room which means that its configuration will be maintained in synch with its representation in the database.

    When running in a cluster each cluster node will have its own copy of local rooms. Persistent rooms will be loaded by each cluster node when starting up. Not persistent rooms will be copied from the senior cluster member. All room occupants will be copied from the senior cluster member too.

    Author:
    Gaston Dombiak
    See Also:
    Serialized Form

    • Constructor Detail

      • LocalMUCRoom

        public LocalMUCRoom()
        Do not use this constructor. It was added to implement the Externalizable interface required to work inside of a cluster.

    • Method Detail

      • getName

        public String getName()
        Description copied from interface: MUCRoom
        Get the name of this room.
        Specified by:
        getName in interface MUCRoom
        Returns:
        The name for this room

      • getJID

        public org.xmpp.packet.JID getJID()
        Description copied from interface: MUCRoom
        Get the full JID of this room.
        Specified by:
        getJID in interface MUCRoom
        Returns:
        the JID for this room.

      • getMUCService

        public MultiUserChatService getMUCService()
        Description copied from interface: MUCRoom
        Get the multi user chat service the room is attached to.
        Specified by:
        getMUCService in interface MUCRoom
        Returns:
        the MultiUserChatService instance that the room is attached to.

      • setMUCService

        public void setMUCService​(MultiUserChatService service)
        Description copied from interface: MUCRoom
        Sets the multi user chat service the room is attached to.
        Specified by:
        setMUCService in interface MUCRoom
        Parameters:
        service - The MultiUserChatService that the room is attached to (cannot be null).

      • getID

        public long getID()
        Description copied from interface: MUCRoom
        Obtain a unique numerical id for this room. Useful for storing rooms in databases. If the room is persistent or is logging the conversation then the returned ID won't be -1.
        Specified by:
        getID in interface MUCRoom
        Returns:
        The unique id for this room or -1 if the room is temporary and is not logging the conversation.

      • setID

        public void setID​(long roomID)
        Description copied from interface: MUCRoom
        Sets a new room ID if the room has just been saved to the database or sets the saved ID of the room in the database while loading the room.
        Specified by:
        setID in interface MUCRoom
        Parameters:
        roomID - the saved ID of the room in the DB or a new one if the room is being saved to the DB.

      • getCreationDate

        public Date getCreationDate()
        Description copied from interface: MUCRoom
        Returns the date when the room was created.
        Specified by:
        getCreationDate in interface MUCRoom
        Returns:
        the date when the room was created.

      • setCreationDate

        public void setCreationDate​(Date creationDate)
        Description copied from interface: MUCRoom
        Sets the date when the room was created.
        Specified by:
        setCreationDate in interface MUCRoom
        Parameters:
        creationDate - the date when the room was created (cannot be null).

      • getModificationDate

        public Date getModificationDate()
        Description copied from interface: MUCRoom
        Returns the last date when the room's configuration was modified. If the room's configuration was never modified then the creation date will be returned.
        Specified by:
        getModificationDate in interface MUCRoom
        Returns:
        the last date when the room's configuration was modified.

      • setModificationDate

        public void setModificationDate​(Date modificationDate)
        Description copied from interface: MUCRoom
        Sets the last date when the room's configuration was modified. If the room's configuration was never modified then the initial value will be the same as the creation date.
        Specified by:
        setModificationDate in interface MUCRoom
        Parameters:
        modificationDate - the last date when the room's configuration was modified (cannot be null).

      • setEmptyDate

        public void setEmptyDate​(Date emptyDate)
        Description copied from interface: MUCRoom
        Sets the date when the last occupant left the room. A null value means that there are occupants in the room at the moment.
        Specified by:
        setEmptyDate in interface MUCRoom
        Parameters:
        emptyDate - the date when the last occupant left the room or null if there are occupants in the room (can be null).

      • getEmptyDate

        public Date getEmptyDate()
        Description copied from interface: MUCRoom
        Returns the date when the last occupant left the room. A null value means that there are occupants in the room at the moment.
        Specified by:
        getEmptyDate in interface MUCRoom
        Returns:
        the date when the last occupant left the room or null if there are occupants in the room at the moment.

      • getRole

        public MUCRole getRole()
        Description copied from interface: MUCRoom
        Obtain the role of the chat server (mainly for addressing messages and presence).
        Specified by:
        getRole in interface MUCRoom
        Returns:
        The role for the chat room itself

      • getOccupantsByNickname

        public List<MUCRole> getOccupantsByNickname​(String nickname)
                                     throws UserNotFoundException
        Description copied from interface: MUCRoom
        Obtain the roles of a given user by nickname. A user can be connected to a room more than once.
        Specified by:
        getOccupantsByNickname in interface MUCRoom
        Parameters:
        nickname - The nickname of the user you'd like to obtain (cannot be null)
        Returns:
        The user's role in the room
        Throws:
        UserNotFoundException - If there is no user with the given nickname

      • getOccupantsByBareJID

        public List<MUCRole> getOccupantsByBareJID​(org.xmpp.packet.JID jid)
                                    throws UserNotFoundException
        Description copied from interface: MUCRoom
        Obtain the roles of a given user in the room by his bare JID. A user can have several roles, one for each client resource from which the user has joined the room.
        Specified by:
        getOccupantsByBareJID in interface MUCRoom
        Parameters:
        jid - The bare jid of the user you'd like to obtain (cannot be null).
        Returns:
        The user's roles in the room
        Throws:
        UserNotFoundException - If there is no user with the given nickname

      • getOccupantByFullJID

        public MUCRole getOccupantByFullJID​(org.xmpp.packet.JID jid)
        Description copied from interface: MUCRoom
        Returns the role of a given user in the room by his full JID or null if no role was found for the specified user.
        Specified by:
        getOccupantByFullJID in interface MUCRoom
        Parameters:
        jid - The full jid of the user you'd like to obtain (cannot be null).
        Returns:
        The user's role in the room or null if not found.

      • getOccupants

        public Collection<MUCRole> getOccupants()
        Description copied from interface: MUCRoom
        Obtain the roles of all users in the chatroom.
        Specified by:
        getOccupants in interface MUCRoom
        Returns:
        a collection with all users in the chatroom

      • getOccupantsCount

        public int getOccupantsCount()
        Description copied from interface: MUCRoom
        Returns the number of occupants in the chatroom at the moment.
        Specified by:
        getOccupantsCount in interface MUCRoom
        Returns:
        int the number of occupants in the chatroom at the moment.

      • hasOccupant

        public boolean hasOccupant​(String nickname)
        Description copied from interface: MUCRoom
        Determine if a given nickname is taken.
        Specified by:
        hasOccupant in interface MUCRoom
        Parameters:
        nickname - The nickname of the user you'd like to obtain (cannot be null).
        Returns:
        True if a nickname is taken

      • getReservedNickname

        public String getReservedNickname​(org.xmpp.packet.JID jid)
        Description copied from interface: MUCRoom
        Returns the reserved room nickname for the bare JID or null if none.
        Specified by:
        getReservedNickname in interface MUCRoom
        Parameters:
        jid - The bare jid of the user of which you'd like to obtain his reserved nickname (cannot be null).
        Returns:
        the reserved room nickname for the bare JID or null if none.

      • getAffiliation

        public MUCRole.Affiliation getAffiliation​(org.xmpp.packet.JID jid)
        Description copied from interface: MUCRoom
        Returns the affiliation state of the user in the room. Possible affiliations are MUCRole.OWNER, MUCRole.ADMINISTRATOR, MUCRole.MEMBER, MUCRole.OUTCAST and MUCRole.NONE.

        Note: Prerequisite - A lock must already be obtained before sending this message.

        Specified by:
        getAffiliation in interface MUCRoom
        Parameters:
        jid - The bare jid of the user of which you'd like to obtain his affiliation (cannot be null).
        Returns:
        the affiliation state of the user in the room.

      • leaveRoom

        public void leaveRoom​(MUCRole leaveRole)
        Description copied from interface: MUCRoom
        Remove a member from the chat room.
        Specified by:
        leaveRoom in interface MUCRoom
        Parameters:
        leaveRole - room occupant that left the room (cannot be null).

      • destroyRoom

        public void destroyRoom​(org.xmpp.packet.JID alternateJID,
                        String reason)
        Description copied from interface: MUCRoom
        Destroys the room. Each occupant will be removed and will receive a presence stanza of type "unavailable" whose "from" attribute will be the occupant's nickname that the user knows he or she has been removed from the room.
        Specified by:
        destroyRoom in interface MUCRoom
        Parameters:
        alternateJID - an optional alternate JID. Commonly used to provide a replacement room. (can be null)
        reason - an optional reason why the room was destroyed (can be null).

      • createPresence

        public org.xmpp.packet.Presence createPresence​(org.xmpp.packet.Presence.Type presenceType)
                                        throws UnauthorizedException
        Description copied from interface: MUCRoom
        Create a new presence in this room for the given role.
        Specified by:
        createPresence in interface MUCRoom
        Parameters:
        presenceType - Type of presence to create (cannot be null).
        Returns:
        The new presence
        Throws:
        UnauthorizedException - If the user doesn't have permission to leave the room

      • serverBroadcast

        public void serverBroadcast​(String msg)
        Description copied from interface: MUCRoom
        Broadcast a given message to all members of this chat room. The sender is always set to be the chatroom.
        Specified by:
        serverBroadcast in interface MUCRoom
        Parameters:
        msg - The message to broadcast (cannot be null)

      • sendPublicMessage

        public void sendPublicMessage​(org.xmpp.packet.Message message,
                              MUCRole senderRole)
                       throws ForbiddenException
        Description copied from interface: MUCRoom
        Sends a message to the all the occupants. In a moderated room, this privilege is restricted to occupants with a role of participant or higher. In an unmoderated room, any occupant can send a message to all other occupants.
        Specified by:
        sendPublicMessage in interface MUCRoom
        Parameters:
        message - The message to send (cannot be null).
        senderRole - the role of the user that is trying to send a public message (cannot be null).
        Throws:
        ForbiddenException - If the user is not allowed to send a public message (i.e. does not have voice in the room).

      • sendPrivatePacket

        public void sendPrivatePacket​(org.xmpp.packet.Packet packet,
                              MUCRole senderRole)
                       throws NotFoundException,
                              ForbiddenException
        Description copied from interface: MUCRoom
        Sends a private packet to a selected occupant. The packet can be a Message for private conversation between room occupants or IQ packets when an occupant wants to send IQ packets to other room occupants.
        Specified by:
        sendPrivatePacket in interface MUCRoom
        Parameters:
        packet - The packet to send.
        senderRole - the role of the user that is trying to send a public message.
        Throws:
        NotFoundException - If the user is sending a packet to a room JID that does not exist.
        ForbiddenException - If a user of this role is not permitted to send private messages in this room.

      • send

        public void send​(org.xmpp.packet.Packet packet)
        Description copied from interface: MUCRoom
        Sends a packet to the user.
        Specified by:
        send in interface MUCRoom
        Parameters:
        packet - The packet to send

      • getChatLength

        public long getChatLength()
        Description copied from interface: MUCRoom
        Returns the total length of the chat session.
        Specified by:
        getChatLength in interface MUCRoom
        Returns:
        length of chat session in milliseconds.

      • addFirstOwner

        public void addFirstOwner​(org.xmpp.packet.JID bareJID)
        Description copied from interface: MUCRoom
        Adds a new user to the list of owners. The user is the actual creator of the room. Only the MultiUserChatServer should use this method. Regular owners list maintenance MUST be done through MUCRoom.addOwner(JID jid,MUCRole).
        Specified by:
        addFirstOwner in interface MUCRoom
        Parameters:
        bareJID - The bare JID of the user to add as owner (cannot be null).

      • addOwner

        public List<org.xmpp.packet.Presence> addOwner​(org.xmpp.packet.JID jid,
                                               MUCRole sendRole)
                                        throws ForbiddenException
        Description copied from interface: MUCRoom
        Adds a new user to the list of owners.
        Specified by:
        addOwner in interface MUCRoom
        Parameters:
        jid - The JID of the user to add as owner (cannot be null).
        sendRole - the role of the user that is trying to modify the owners list (cannot be null).
        Returns:
        the list of updated presences of all the client resources that the client used to join the room.
        Throws:
        ForbiddenException - If the user is not allowed to modify the owner list.

      • addAdmin

        public List<org.xmpp.packet.Presence> addAdmin​(org.xmpp.packet.JID jid,
                                               MUCRole sendRole)
                                        throws ForbiddenException,
                                               ConflictException
        Description copied from interface: MUCRoom
        Adds a new user to the list of admins.
        Specified by:
        addAdmin in interface MUCRoom
        Parameters:
        jid - The JID of the user to add as admin (cannot be null).
        sendRole - The role of the user that is trying to modify the admins list (cannot be null).
        Returns:
        the list of updated presences of all the client resources that the client used to join the room.
        Throws:
        ForbiddenException - If the user is not allowed to modify the admin list.
        ConflictException - If the room was going to lose all its owners.

      • addMember

        public List<org.xmpp.packet.Presence> addMember​(org.xmpp.packet.JID jid,
                                                String nickname,
                                                MUCRole sendRole)
                                         throws ForbiddenException,
                                                ConflictException
        Description copied from interface: MUCRoom
        Adds a new user to the list of members.
        Specified by:
        addMember in interface MUCRoom
        Parameters:
        jid - The JID of the user to add as a member (cannot be null).
        nickname - The reserved nickname of the member for the room or null if none.
        sendRole - the role of the user that is trying to modify the members list (cannot be null).
        Returns:
        the list of updated presences of all the client resources that the client used to join the room.
        Throws:
        ForbiddenException - If the user is not allowed to modify the members list.
        ConflictException - If the desired room nickname is already reserved for the room or if the room was going to lose all its owners.

      • addOutcast

        public List<org.xmpp.packet.Presence> addOutcast​(org.xmpp.packet.JID jid,
                                                 String reason,
                                                 MUCRole senderRole)
                                          throws NotAllowedException,
                                                 ForbiddenException,
                                                 ConflictException
        Description copied from interface: MUCRoom
        Adds a new user to the list of outcast users.
        Specified by:
        addOutcast in interface MUCRoom
        Parameters:
        jid - The JID of the user to add as an outcast (cannot be null).
        reason - an optional reason why the user was banned (can be null).
        senderRole - The role of the user that initiated the ban (cannot be null).
        Returns:
        the list of updated presences of all the client resources that the client used to join the room.
        Throws:
        NotAllowedException - Thrown if trying to ban an owner or an administrator.
        ForbiddenException - If the user is not allowed to modify the outcast list.
        ConflictException - If the room was going to lose all its owners.

      • addNone

        public List<org.xmpp.packet.Presence> addNone​(org.xmpp.packet.JID jid,
                                              MUCRole senderRole)
                                       throws ForbiddenException,
                                              ConflictException
        Description copied from interface: MUCRoom
        Removes the user from all the other affiliation list thus giving the user a NONE affiliation.
        Specified by:
        addNone in interface MUCRoom
        Parameters:
        jid - The JID of the user to keep with a NONE affiliation (cannot be null).
        senderRole - The role of the user that set the affiliation to none (cannot be null).
        Returns:
        the list of updated presences of all the client resources that the client used to join the room or null if none was updated.
        Throws:
        ForbiddenException - If the user is not allowed to modify the none list.
        ConflictException - If the room was going to lose all its owners.

      • isLocked

        public boolean isLocked()
        Description copied from interface: MUCRoom
        Returns true if the room is locked. The lock will persist for a defined period of time. If the room owner does not configure the room within the timeout period, the room owner is assumed to have accepted the default configuration.
        Specified by:
        isLocked in interface MUCRoom
        Returns:
        true if the room is locked.

      • isManuallyLocked

        public boolean isManuallyLocked()
        Description copied from interface: MUCRoom
        Returns true if the room is locked and it was locked by a room owner after the room was initially configured.
        Specified by:
        isManuallyLocked in interface MUCRoom
        Returns:
        true if the room is locked and it was locked by a room owner after the room was initially configured.

      • presenceUpdated

        public void presenceUpdated​(MUCRole occupantRole,
                            org.xmpp.packet.Presence newPresence)
        Handles occupants updating their presence in the chatroom. Assumes the user updates their presence whenever their availability in the room changes. This method should not be called to handle other presence related updates, such as nickname changes. An event callback fired whenever an occupant updated his presence in the chatroom.
        Specified by:
        presenceUpdated in interface MUCRoom
        Parameters:
        occupantRole - occupant that changed his presence in the room (cannot be null).
        newPresence - presence sent by the occupant (cannot be null).

      • presenceUpdated

        public void presenceUpdated​(UpdatePresence updatePresence)
        Updates the presence of an occupant with the new presence included in the request.
        Parameters:
        updatePresence - request to update an occupant's presence.

      • occupantUpdated

        public void occupantUpdated​(UpdateOccupant update)

      • memberAdded

        public void memberAdded​(AddMember addMember)

      • affiliationAdded

        public void affiliationAdded​(AddAffiliation affiliation)

      • nicknameChanged

        public void nicknameChanged​(MUCRole occupantRole,
                            org.xmpp.packet.Presence newPresence,
                            String oldNick,
                            String newNick)
        Description copied from interface: MUCRoom
        An event callback fired whenever an occupant changes his nickname within the chatroom.
        Specified by:
        nicknameChanged in interface MUCRoom
        Parameters:
        occupantRole - occupant that changed his nickname in the room (cannot be null).
        newPresence - presence sent by the occupant with the new nickname (cannot be null).
        oldNick - old nickname within the room (cannot be null).
        newNick - new nickname within the room (cannot be null).

      • nicknameChanged

        public void nicknameChanged​(ChangeNickname changeNickname)

      • changeSubject

        public void changeSubject​(org.xmpp.packet.Message packet,
                          MUCRole role)
                   throws ForbiddenException
        Description copied from interface: MUCRoom
        Changes the room's subject if the occupant has enough permissions. The occupant must be a moderator or the room must be configured so that anyone can change its subject. Otherwise a forbidden exception will be thrown.

        The new subject will be added to the history of the room.

        Specified by:
        changeSubject in interface MUCRoom
        Parameters:
        packet - the sent packet to change the room's subject (cannot be null).
        role - the role of the user that is trying to change the subject (cannot be null).
        Throws:
        ForbiddenException - If the user is not allowed to change the subject.

      • getSubject

        public String getSubject()
        Description copied from interface: MUCRoom
        Returns the last subject that some occupant set to the room.
        Specified by:
        getSubject in interface MUCRoom
        Returns:
        the last subject that some occupant set to the room.

      • setSubject

        public void setSubject​(String subject)
        Description copied from interface: MUCRoom
        Sets the last subject that some occupant set to the room. This message will only be used when loading a room from the database.
        Specified by:
        setSubject in interface MUCRoom
        Parameters:
        subject - the last known subject of the room (cannot be null).

      • sendInvitation

        public void sendInvitation​(org.xmpp.packet.JID to,
                           String reason,
                           MUCRole senderRole,
                           List<org.dom4j.Element> extensions)
                    throws ForbiddenException,
                           CannotBeInvitedException
        Description copied from interface: MUCRoom
        Sends an invitation to a user. The invitation will be sent as if the room is inviting the user. The invitation will include the original occupant the sent the invitation together with the reason for the invitation if any. Since the invitee could be offline at the moment we need the originating session so that the offline strategy could potentially bounce the message with the invitation.
        Specified by:
        sendInvitation in interface MUCRoom
        Parameters:
        to - the JID of the user that is being invited.
        reason - the reason of the invitation or null if none.
        senderRole - the role of the occupant that sent the invitation.
        extensions - the list of extensions sent with the original message invitation or null if none.
        Throws:
        ForbiddenException - If the user is not allowed to send the invitation.
        CannotBeInvitedException - (Optionally) If the user being invited does not have access to the room

      • sendInvitationRejection

        public void sendInvitationRejection​(org.xmpp.packet.JID to,
                                    String reason,
                                    org.xmpp.packet.JID sender)
        Description copied from interface: MUCRoom
        Sends the rejection to the inviter. The rejection will be sent as if the room is rejecting the invitation is named of the invitee. The rejection will include the address of the invitee together with the reason for the rejection if any. Since the inviter could be offline at the moment we need the originating session so that the offline strategy could potentially bounce the message with the rejection.
        Specified by:
        sendInvitationRejection in interface MUCRoom
        Parameters:
        to - the JID of the user that is originated the invitation.
        reason - the reason for the rejection or null if none.
        sender - the JID of the invitee that is rejecting the invitation.

      • getRoomHistory

        public MUCRoomHistory getRoomHistory()
        Description copied from interface: MUCRoom
        Returns the history of the room which includes chat transcripts.
        Specified by:
        getRoomHistory in interface MUCRoom
        Returns:
        the history of the room which includes chat transcripts.

      • getOwners

        public Collection<org.xmpp.packet.JID> getOwners()
        Description copied from interface: MUCRoom
        Returns a collection with the current list of owners. The collection contains the bareJID of the users with owner affiliation.
        Specified by:
        getOwners in interface MUCRoom
        Returns:
        a collection with the current list of owners.

      • getAdmins

        public Collection<org.xmpp.packet.JID> getAdmins()
        Description copied from interface: MUCRoom
        Returns a collection with the current list of admins. The collection contains the bareJID of the users with admin affiliation.
        Specified by:
        getAdmins in interface MUCRoom
        Returns:
        a collection with the current list of admins.

      • getMembers

        public Collection<org.xmpp.packet.JID> getMembers()
        Description copied from interface: MUCRoom
        Returns a collection with the current list of room members. The collection contains the bareJID of the users with member affiliation. If the room is not members-only then the list will contain the users that registered with the room and therefore they may have reserved a nickname.
        Specified by:
        getMembers in interface MUCRoom
        Returns:
        a collection with the current list of members.

      • getOutcasts

        public Collection<org.xmpp.packet.JID> getOutcasts()
        Description copied from interface: MUCRoom
        Returns a collection with the current list of outcast users. An outcast user is not allowed to join the room again. The collection contains the bareJID of the users with outcast affiliation.
        Specified by:
        getOutcasts in interface MUCRoom
        Returns:
        a collection with the current list of outcast users.

      • getModerators

        public Collection<MUCRole> getModerators()
        Description copied from interface: MUCRoom
        Returns a collection with the current list of room moderators. The collection contains the MUCRole of the occupants with moderator role.
        Specified by:
        getModerators in interface MUCRoom
        Returns:
        a collection with the current list of moderators.

      • getParticipants

        public Collection<MUCRole> getParticipants()
        Description copied from interface: MUCRoom
        Returns a collection with the current list of room participants. The collection contains the MUCRole of the occupants with participant role.
        Specified by:
        getParticipants in interface MUCRoom
        Returns:
        a collection with the current list of moderators.

      • addModerator

        public org.xmpp.packet.Presence addModerator​(org.xmpp.packet.JID jid,
                                             MUCRole senderRole)
                                      throws ForbiddenException
        Description copied from interface: MUCRoom
        Changes the role of the user within the room to moderator. A moderator is allowed to kick occupants as well as granting/revoking voice from occupants.
        Specified by:
        addModerator in interface MUCRoom
        Parameters:
        jid - The full JID of the occupant to give moderator privileges (cannot be null).
        senderRole - The role of the user that is granting moderator privileges to an occupant (cannot be null).
        Returns:
        the updated presence of the occupant or null if the JID does not belong to an existing occupant.
        Throws:
        ForbiddenException - If the user is not allowed to grant moderator privileges.

      • addParticipant

        public org.xmpp.packet.Presence addParticipant​(org.xmpp.packet.JID jid,
                                               String reason,
                                               MUCRole senderRole)
                                        throws NotAllowedException,
                                               ForbiddenException
        Description copied from interface: MUCRoom
        Changes the role of the user within the room to participant. A participant is allowed to send messages to the room (i.e. has voice) and may change the room's subject.
        Specified by:
        addParticipant in interface MUCRoom
        Parameters:
        jid - The full JID of the occupant to give participant privileges (cannot be null).
        reason - The reason why participant privileges were gave to the user or null if none.
        senderRole - The role of the user that is granting participant privileges to an occupant (cannot be null).
        Returns:
        the updated presence of the occupant or null if the JID does not belong to an existing occupant.
        Throws:
        NotAllowedException - If trying to change the moderator role to an owner or an admin.
        ForbiddenException - If the user is not allowed to grant participant privileges.

      • addVisitor

        public org.xmpp.packet.Presence addVisitor​(org.xmpp.packet.JID jid,
                                           MUCRole senderRole)
                                    throws NotAllowedException,
                                           ForbiddenException
        Description copied from interface: MUCRoom
        Changes the role of the user within the room to visitor. A visitor can receive messages but is not allowed to send messages to the room (i.e. does not has voice) and may invite others to the room.
        Specified by:
        addVisitor in interface MUCRoom
        Parameters:
        jid - the full JID of the occupant to change to visitor (cannot be null).
        senderRole - the role of the user that is changing the role to visitor (cannot be null).
        Returns:
        the updated presence of the occupant or null if the JID does not belong to an existing occupant.
        Throws:
        NotAllowedException - if trying to change the moderator role to an owner or an admin.
        ForbiddenException - if the user is not a moderator.

      • kickOccupant

        public org.xmpp.packet.Presence kickOccupant​(org.xmpp.packet.JID jid,
                                             org.xmpp.packet.JID actorJID,
                                             String actorNickname,
                                             String reason)
                                      throws NotAllowedException
        Description copied from interface: MUCRoom
        Kicks a user from the room. If the user was in the room, the returned updated presence will be sent to the remaining occupants.
        Specified by:
        kickOccupant in interface MUCRoom
        Parameters:
        jid - The full JID of the kicked user (cannot be null).
        actorJID - The JID of the actor that initiated the kick (cannot be null).
        actorNickname - The actor nickname.
        reason - An optional reason why the user was kicked (can be null).
        Returns:
        the updated presence of the kicked user or null if the user was not in the room.
        Throws:
        NotAllowedException - Thrown if trying to ban an owner or an administrator.

      • canAnyoneDiscoverJID

        public boolean canAnyoneDiscoverJID()
        Description copied from interface: MUCRoom
        Returns true if every presence packet will include the JID of every occupant. This configuration can be modified by the owner while editing the room's configuration.
        Specified by:
        canAnyoneDiscoverJID in interface MUCRoom
        Returns:
        true if every presence packet will include the JID of every occupant.

      • setCanAnyoneDiscoverJID

        public void setCanAnyoneDiscoverJID​(boolean canAnyoneDiscoverJID)
        Description copied from interface: MUCRoom
        Sets if every presence packet will include the JID of every occupant. This configuration can be modified by the owner while editing the room's configuration.
        Specified by:
        setCanAnyoneDiscoverJID in interface MUCRoom
        Parameters:
        canAnyoneDiscoverJID - boolean that specifies if every presence packet will include the JID of every occupant.

      • canSendPrivateMessage

        public String canSendPrivateMessage()
        Description copied from interface: MUCRoom
        Returns the minimal role of persons that are allowed to send private messages in the room. The returned value is any one of: "anyone", "moderators", "participants", "none".
        Specified by:
        canSendPrivateMessage in interface MUCRoom
        Returns:
        The minimal role of persons that are allowed to send private messages in the room (never null).

      • setCanSendPrivateMessage

        public void setCanSendPrivateMessage​(String role)
        Description copied from interface: MUCRoom
        Sets the minimal role of persons that are allowed to send private messages in the room. The provided value is any one of: "anyone", "moderators", "participants", "none". If another value is set, "anyone" is used instead.
        Specified by:
        setCanSendPrivateMessage in interface MUCRoom
        Parameters:
        role - The minimal role of persons that are allowed to send private messages in the room (never null).

      • canOccupantsChangeSubject

        public boolean canOccupantsChangeSubject()
        Description copied from interface: MUCRoom
        Returns true if participants are allowed to change the room's subject.
        Specified by:
        canOccupantsChangeSubject in interface MUCRoom
        Returns:
        true if participants are allowed to change the room's subject.

      • setCanOccupantsChangeSubject

        public void setCanOccupantsChangeSubject​(boolean canOccupantsChangeSubject)
        Description copied from interface: MUCRoom
        Sets if participants are allowed to change the room's subject.
        Specified by:
        setCanOccupantsChangeSubject in interface MUCRoom
        Parameters:
        canOccupantsChangeSubject - boolean that specifies if participants are allowed to change the room's subject.

      • canOccupantsInvite

        public boolean canOccupantsInvite()
        Description copied from interface: MUCRoom
        Returns true if occupants can invite other users to the room. If the room does not require an invitation to enter (i.e. is not members-only) then any occupant can send invitations. On the other hand, if the room is members-only and occupants cannot send invitation then only the room owners and admins are allowed to send invitations.
        Specified by:
        canOccupantsInvite in interface MUCRoom
        Returns:
        true if occupants can invite other users to the room.

      • setCanOccupantsInvite

        public void setCanOccupantsInvite​(boolean canOccupantsInvite)
        Description copied from interface: MUCRoom
        Sets if occupants can invite other users to the room. If the room does not require an invitation to enter (i.e. is not members-only) then any occupant can send invitations. On the other hand, if the room is members-only and occupants cannot send invitation then only the room owners and admins are allowed to send invitations.
        Specified by:
        setCanOccupantsInvite in interface MUCRoom
        Parameters:
        canOccupantsInvite - boolean that specified in any occupant can invite other users to the room.

      • getNaturalLanguageName

        public String getNaturalLanguageName()
        Description copied from interface: MUCRoom
        Returns the natural language name of the room. This name can only be modified by room owners. It's mainly used for users while discovering rooms hosted by the Multi-User Chat service.
        Specified by:
        getNaturalLanguageName in interface MUCRoom
        Returns:
        the natural language name of the room.

      • setNaturalLanguageName

        public void setNaturalLanguageName​(String naturalLanguageName)
        Description copied from interface: MUCRoom
        Sets the natural language name of the room. This name can only be modified by room owners. It's mainly used for users while discovering rooms hosted by the Multi-User Chat service.
        Specified by:
        setNaturalLanguageName in interface MUCRoom
        Parameters:
        naturalLanguageName - the natural language name of the room.

      • getDescription

        public String getDescription()
        Description copied from interface: MUCRoom
        Returns a description set by the room's owners about the room. This information will be used when discovering extended information about the room.
        Specified by:
        getDescription in interface MUCRoom
        Returns:
        a description set by the room's owners about the room.

      • setDescription

        public void setDescription​(String description)
        Description copied from interface: MUCRoom
        Sets a description set by the room's owners about the room. This information will be used when discovering extended information about the room.
        Specified by:
        setDescription in interface MUCRoom
        Parameters:
        description - a description set by the room's owners about the room.

      • isMembersOnly

        public boolean isMembersOnly()
        Description copied from interface: MUCRoom
        Returns true if the room requires an invitation to enter. That is if the room is members-only.
        Specified by:
        isMembersOnly in interface MUCRoom
        Returns:
        true if the room requires an invitation to enter.

      • setMembersOnly

        public List<org.xmpp.packet.Presence> setMembersOnly​(boolean membersOnly)
        Description copied from interface: MUCRoom
        Sets if the room requires an invitation to enter. That is if the room is members-only.
        Specified by:
        setMembersOnly in interface MUCRoom
        Parameters:
        membersOnly - if true then the room is members-only.
        Returns:
        the list of updated presences of all the occupants that aren't members of the room if the room is now members-only.

      • isLogEnabled

        public boolean isLogEnabled()
        Description copied from interface: MUCRoom
        Returns true if the room's conversation is being logged. If logging is activated the room conversation will be saved to the database every couple of minutes. The saving frequency is the same for all the rooms and can be configured by changing the property "xmpp.muc.tasks.log.timeout" of MultiUserChatServerImpl.
        Specified by:
        isLogEnabled in interface MUCRoom
        Returns:
        true if the room's conversation is being logged.

      • setLogEnabled

        public void setLogEnabled​(boolean logEnabled)
        Description copied from interface: MUCRoom
        Sets if the room's conversation is being logged. If logging is activated the room conversation will be saved to the database every couple of minutes. The saving frequency is the same for all the rooms and can be configured by changing the property "xmpp.muc.tasks.log.timeout" of MultiUserChatServerImpl.
        Specified by:
        setLogEnabled in interface MUCRoom
        Parameters:
        logEnabled - boolean that specified if the room's conversation must be logged.

      • setLoginRestrictedToNickname

        public void setLoginRestrictedToNickname​(boolean restricted)
        Description copied from interface: MUCRoom
        Sets if registered users can only join the room using their registered nickname. A not_acceptable error will be returned if the user tries to join the room with a nickname different than the reserved nickname.
        Specified by:
        setLoginRestrictedToNickname in interface MUCRoom
        Parameters:
        restricted - if registered users can only join the room using their registered nickname.

      • isLoginRestrictedToNickname

        public boolean isLoginRestrictedToNickname()
        Description copied from interface: MUCRoom
        Returns true if registered users can only join the room using their registered nickname. By default, registered users can join the room using any nickname. A not_acceptable error will be returned if the user tries to join the room with a nickname different than the reserved nickname.
        Specified by:
        isLoginRestrictedToNickname in interface MUCRoom
        Returns:
        true if registered users can only join the room using their registered nickname.

      • setChangeNickname

        public void setChangeNickname​(boolean canChange)
        Description copied from interface: MUCRoom
        Sets if room occupants are allowed to change their nicknames in the room. By default, occupants are allowed to change their nicknames. A not_acceptable error will be returned if an occupant tries to change his nickname and this feature is not enabled.

        Notice that this feature is not supported by the MUC spec so answering a not_acceptable error may break some cliens.

        Specified by:
        setChangeNickname in interface MUCRoom
        Parameters:
        canChange - if room occupants are allowed to change their nicknames in the room.

      • canChangeNickname

        public boolean canChangeNickname()
        Description copied from interface: MUCRoom
        Returns true if room occupants are allowed to change their nicknames in the room. By default, occupants are allowed to change their nicknames. A not_acceptable error will be returned if an occupant tries to change his nickname and this feature is not enabled.

        Notice that this feature is not supported by the MUC spec so answering a not_acceptable error may break some cliens.

        Specified by:
        canChangeNickname in interface MUCRoom
        Returns:
        true if room occupants are allowed to change their nicknames in the room.

      • setRegistrationEnabled

        public void setRegistrationEnabled​(boolean registrationEnabled)
        Description copied from interface: MUCRoom
        Sets if users are allowed to register with the room. By default, room registration is enabled. A not_allowed error will be returned if a user tries to register with the room and this feature is disabled.
        Specified by:
        setRegistrationEnabled in interface MUCRoom
        Parameters:
        registrationEnabled - if users are allowed to register with the room.

      • isRegistrationEnabled

        public boolean isRegistrationEnabled()
        Description copied from interface: MUCRoom
        Returns true if users are allowed to register with the room. By default, room registration is enabled. A not_allowed error will be returned if a user tries to register with the room and this feature is disabled.
        Specified by:
        isRegistrationEnabled in interface MUCRoom
        Returns:
        true if users are allowed to register with the room.

      • getMaxUsers

        public int getMaxUsers()
        Description copied from interface: MUCRoom
        Returns the maximum number of occupants that can be simultaneously in the room. If the number is zero then there is no limit.
        Specified by:
        getMaxUsers in interface MUCRoom
        Returns:
        the maximum number of occupants that can be simultaneously in the room. Zero means unlimited number of occupants.

      • setMaxUsers

        public void setMaxUsers​(int maxUsers)
        Description copied from interface: MUCRoom
        Sets the maximum number of occupants that can be simultaneously in the room. If the number is zero then there is no limit.
        Specified by:
        setMaxUsers in interface MUCRoom
        Parameters:
        maxUsers - the maximum number of occupants that can be simultaneously in the room. Zero means unlimited number of occupants.

      • isModerated

        public boolean isModerated()
        Description copied from interface: MUCRoom
        Returns if the room in which only those with "voice" may send messages to all occupants.
        Specified by:
        isModerated in interface MUCRoom
        Returns:
        if the room in which only those with "voice" may send messages to all occupants.

      • setModerated

        public void setModerated​(boolean moderated)
        Description copied from interface: MUCRoom
        Sets if the room in which only those with "voice" may send messages to all occupants.
        Specified by:
        setModerated in interface MUCRoom
        Parameters:
        moderated - if the room in which only those with "voice" may send messages to all occupants.

      • getPassword

        public String getPassword()
        Description copied from interface: MUCRoom
        Returns the password that the user must provide to enter the room.
        Specified by:
        getPassword in interface MUCRoom
        Returns:
        the password that the user must provide to enter the room.

      • setPassword

        public void setPassword​(String password)
        Description copied from interface: MUCRoom
        Sets the password that the user must provide to enter the room.
        Specified by:
        setPassword in interface MUCRoom
        Parameters:
        password - the password that the user must provide to enter the room.

      • isPasswordProtected

        public boolean isPasswordProtected()
        Description copied from interface: MUCRoom
        Returns true if a user cannot enter without first providing the correct password.
        Specified by:
        isPasswordProtected in interface MUCRoom
        Returns:
        true if a user cannot enter without first providing the correct password.

      • isPersistent

        public boolean isPersistent()
        Description copied from interface: MUCRoom
        Returns true if the room is not destroyed if the last occupant exits. Persistent rooms are saved to the database to make their configurations persistent together with the affiliation of the users.
        Specified by:
        isPersistent in interface MUCRoom
        Returns:
        true if the room is not destroyed if the last occupant exits.

      • wasSavedToDB

        public boolean wasSavedToDB()
        Description copied from interface: MUCRoom
        Returns true if the room has already been made persistent. If the room is temporary the answer will always be false.
        Specified by:
        wasSavedToDB in interface MUCRoom
        Returns:
        true if the room has already been made persistent.

      • setSavedToDB

        public void setSavedToDB​(boolean saved)
        Description copied from interface: MUCRoom
        Sets if the room has already been made persistent.
        Specified by:
        setSavedToDB in interface MUCRoom
        Parameters:
        saved - boolean that indicates if the room was saved to the database.

      • setPersistent

        public void setPersistent​(boolean persistent)
        Description copied from interface: MUCRoom
        Sets if the room is not destroyed if the last occupant exits. Persistent rooms are saved to the database to make their configurations persistent together with the affiliation of the users.
        Specified by:
        setPersistent in interface MUCRoom
        Parameters:
        persistent - if the room is not destroyed if the last occupant exits.

      • isPublicRoom

        public boolean isPublicRoom()
        Description copied from interface: MUCRoom
        Returns true if the room is searchable and visible through service discovery.
        Specified by:
        isPublicRoom in interface MUCRoom
        Returns:
        true if the room is searchable and visible through service discovery.

      • setPublicRoom

        public void setPublicRoom​(boolean publicRoom)
        Description copied from interface: MUCRoom
        Sets if the room is searchable and visible through service discovery.
        Specified by:
        setPublicRoom in interface MUCRoom
        Parameters:
        publicRoom - if the room is searchable and visible through service discovery.

      • getRolesToBroadcastPresence

        public List<String> getRolesToBroadcastPresence()
        Description copied from interface: MUCRoom
        Returns the list of roles of which presence will be broadcasted to the rest of the occupants. This feature is useful for implementing "invisible" occupants.
        Specified by:
        getRolesToBroadcastPresence in interface MUCRoom
        Returns:
        the list of roles of which presence will be broadcasted to the rest of the occupants.

      • setRolesToBroadcastPresence

        public void setRolesToBroadcastPresence​(List<String> rolesToBroadcastPresence)
        Description copied from interface: MUCRoom
        Sets the list of roles of which presence will be broadcasted to the rest of the occupants. This feature is useful for implementing "invisible" occupants.
        Specified by:
        setRolesToBroadcastPresence in interface MUCRoom
        Parameters:
        rolesToBroadcastPresence - the list of roles of which presence will be broadcasted to the rest of the occupants.

      • canBroadcastPresence

        public boolean canBroadcastPresence​(String roleToBroadcast)
        Description copied from interface: MUCRoom
        Returns true if the presences of the requested role will be broadcasted.
        Specified by:
        canBroadcastPresence in interface MUCRoom
        Parameters:
        roleToBroadcast - the role to check if its presences will be broadcasted.
        Returns:
        true if the presences of the requested role will be broadcasted.

      • lock

        public void lock​(MUCRole senderRole)
          throws ForbiddenException
        Description copied from interface: MUCRoom
        Locks the room so that users cannot join the room. Only the owner of the room can lock/unlock the room.
        Specified by:
        lock in interface MUCRoom
        Parameters:
        senderRole - the role of the occupant that locked the room.
        Throws:
        ForbiddenException - If the user is not an owner of the room.

      • unlock

        public void unlock​(MUCRole senderRole)
            throws ForbiddenException
        Description copied from interface: MUCRoom
        Unlocks the room so that users can join the room. The room is locked when created and only the owner of the room can unlock it by sending the configuration form to the Multi-User Chat service.
        Specified by:
        unlock in interface MUCRoom
        Parameters:
        senderRole - the role of the occupant that unlocked the room.
        Throws:
        ForbiddenException - If the user is not an owner of the room.

      • addAdmins

        public List<org.xmpp.packet.Presence> addAdmins​(List<org.xmpp.packet.JID> newAdmins,
                                                MUCRole senderRole)
                                         throws ForbiddenException,
                                                ConflictException
        Description copied from interface: MUCRoom
        Adds a list of users to the list of admins.
        Specified by:
        addAdmins in interface MUCRoom
        Parameters:
        newAdmins - the list of bare JIDs of the users to add to the list of existing admins (cannot be null).
        senderRole - the role of the user that is trying to modify the admins list (cannot be null).
        Returns:
        the list of updated presences of all the clients resources that the clients used to join the room.
        Throws:
        ForbiddenException - If the user is not allowed to modify the admin list.
        ConflictException - If the room was going to lose all its owners.

      • addOwners

        public List<org.xmpp.packet.Presence> addOwners​(List<org.xmpp.packet.JID> newOwners,
                                                MUCRole senderRole)
                                         throws ForbiddenException
        Description copied from interface: MUCRoom
        Adds a list of users to the list of owners.
        Specified by:
        addOwners in interface MUCRoom
        Parameters:
        newOwners - the list of bare JIDs of the users to add to the list of existing owners (cannot be null).
        senderRole - the role of the user that is trying to modify the owners list (cannot be null).
        Returns:
        the list of updated presences of all the clients resources that the clients used to join the room.
        Throws:
        ForbiddenException - If the user is not allowed to modify the owner list.

      • saveToDB

        public void saveToDB()
        Description copied from interface: MUCRoom
        Saves the room configuration to the DB. After the room has been saved to the DB it will become persistent.
        Specified by:
        saveToDB in interface MUCRoom

      • updateConfiguration

        public void updateConfiguration​(LocalMUCRoom otherRoom)

      • getUID

        public String getUID()
        Specified by:
        getUID in interface org.xmpp.resultsetmanagement.Result

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • groupModified

        public void groupModified​(Group group,
                          Map params)
        Description copied from interface: GroupEventListener
        A group's name, description, or an extended property was changed.
        Specified by:
        groupModified in interface GroupEventListener
        Parameters:
        group - the group.
        params - event parameters.

      • adminAdded

        public void adminAdded​(Group group,
                       Map params)
        Description copied from interface: GroupEventListener
        An administrator was added to a group.
        Specified by:
        adminAdded in interface GroupEventListener
        Parameters:
        group - the group.
        params - event parameters.

      • adminRemoved

        public void adminRemoved​(Group group,
                         Map params)
        Description copied from interface: GroupEventListener
        An administrator was removed from a group.
        Specified by:
        adminRemoved in interface GroupEventListener
        Parameters:
        group - the group.
        params - event parameters.