Package tigase.muc

Class Room

java.lang.Object

tigase.muc.Room

All Implemented Interfaces:

RoomConfig.RoomConfigListener

public class Room
extends Object
implements RoomConfig.RoomConfigListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Room.RoomFactory
static interface	Room.RoomListener
static interface	Room.RoomOccupantListener

Field Summary

Fields

Modifier and Type	Field	Description
protected static Room.RoomFactory	factory
static String	FILTERED_OCCUPANTS_COLLECTION
protected static Logger	log
protected PresenceFiltered	presenceFiltered
protected PresenceStore	presences

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Room(RoomConfig rc, Date creationDate, tigase.xmpp.BareJID creatorJid)

Method Summary

Modifier and Type	Method	Description
void	addAffiliationByJid(tigase.xmpp.BareJID jid, Affiliation affiliation)
void	addListener(Room.RoomListener listener)
void	addOccupantByJid(tigase.xmpp.JID senderJid, String nickName, Role role, tigase.xml.Element pe)
void	addOccupantListener(Room.RoomOccupantListener listener)
void	changeNickName(tigase.xmpp.JID senderJid, String nickName)
void	fireOnMessageToOccupants(tigase.xmpp.JID fromJID, tigase.server.Packet msg)
Affiliation	getAffiliation(String nickname)
Affiliation	getAffiliation(tigase.xmpp.BareJID jid)
Collection<tigase.xmpp.BareJID>	getAffiliations()
Collection<tigase.xmpp.JID>	getAllOccupantsJID()
RoomConfig	getConfig()
Date	getCreationDate()
tigase.xmpp.BareJID	getCreatorJid()
String	getDebugInfoOccupants()
tigase.xml.Element	getLastPresenceCopy(tigase.xmpp.BareJID occupantJid, String nickname)
tigase.xml.Element	getLastPresenceCopyByJid(tigase.xmpp.BareJID occupantJid)
int	getOccupantsCount()
tigase.xmpp.BareJID	getOccupantsJidByNickname(String nickname)
Collection<tigase.xmpp.JID>	getOccupantsJidsByNickname(String nickname)
String	getOccupantsNickname(tigase.xmpp.JID jid)
Collection<String>	getOccupantsNicknames()
Collection<String>	getOccupantsNicknames(tigase.xmpp.BareJID bareJid)
PresenceFiltered	getPresenceFiltered()
Role	getRole(String nickname)
Object	getRoomCustomData(String key)
tigase.xmpp.BareJID	getRoomJID()
String	getSubject()
Date	getSubjectChangeDate()
String	getSubjectChangerNick()
boolean	isOccupantInRoom(tigase.xmpp.JID jid)
boolean	isRoomLocked()
static Room	newInstance(RoomConfig rc, Date creationDate, tigase.xmpp.BareJID creatorJid)
void	onConfigChanged(RoomConfig roomConfig, Set<String> modifiedVars)
void	onInitialRoomConfig(RoomConfig roomConfig)
void	removeListener(Room.RoomListener listener)
void	removeOccupant(String occupantNick)
boolean	removeOccupant(tigase.xmpp.JID jid)
void	setAffiliations(Map<tigase.xmpp.BareJID,Affiliation> affiliations)
void	setNewAffiliation(tigase.xmpp.BareJID user, Affiliation affiliation)
void	setNewRole(String nickname, Role newRole)
void	setNewSubject(String msg, String senderNickname)
void	setRoomCustomData(String key, Object data)
void	setRoomLocked(boolean roomLocked)
void	setSubjectChangeDate(Date subjectChangeDate)
void	updatePresenceByJid(tigase.xmpp.JID jid, String nickname, tigase.xml.Element cp)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

factory

protected static Room.RoomFactory factory

log

protected static final Logger log

presences

protected final PresenceStore presences

presenceFiltered

protected final PresenceFiltered presenceFiltered

FILTERED_OCCUPANTS_COLLECTION

public static final String FILTERED_OCCUPANTS_COLLECTION

See Also:

Constant Field Values

Constructor Detail

Room

protected Room(RoomConfig rc,
               Date creationDate,
               tigase.xmpp.BareJID creatorJid)

Method Detail

onInitialRoomConfig

public void onInitialRoomConfig(RoomConfig roomConfig)

Specified by:

onInitialRoomConfig in interface RoomConfig.RoomConfigListener

newInstance

public static Room newInstance(RoomConfig rc,
                               Date creationDate,
                               tigase.xmpp.BareJID creatorJid)

addAffiliationByJid

public void addAffiliationByJid(tigase.xmpp.BareJID jid,
                                Affiliation affiliation)
                         throws tigase.component.exceptions.RepositoryException

Throws:

tigase.component.exceptions.RepositoryException

addListener

public void addListener(Room.RoomListener listener)

addOccupantByJid

public void addOccupantByJid(tigase.xmpp.JID senderJid,
                             String nickName,
                             Role role,
                             tigase.xml.Element pe)
                      throws tigase.util.TigaseStringprepException

Throws:

tigase.util.TigaseStringprepException

addOccupantListener

public void addOccupantListener(Room.RoomOccupantListener listener)

changeNickName

public void changeNickName(tigase.xmpp.JID senderJid,
                           String nickName)

fireOnMessageToOccupants

public void fireOnMessageToOccupants(tigase.xmpp.JID fromJID,
                                     tigase.server.Packet msg)

getAffiliation

public Affiliation getAffiliation(tigase.xmpp.BareJID jid)

getAffiliation

public Affiliation getAffiliation(String nickname)

getAffiliations

public Collection<tigase.xmpp.BareJID> getAffiliations()

getAllOccupantsJID

public Collection<tigase.xmpp.JID> getAllOccupantsJID()

getConfig

public RoomConfig getConfig()

getCreationDate

public Date getCreationDate()

getCreatorJid

public tigase.xmpp.BareJID getCreatorJid()

getDebugInfoOccupants

public String getDebugInfoOccupants()

getLastPresenceCopy

public tigase.xml.Element getLastPresenceCopy(tigase.xmpp.BareJID occupantJid,
                                              String nickname)

getLastPresenceCopyByJid

public tigase.xml.Element getLastPresenceCopyByJid(tigase.xmpp.BareJID occupantJid)

getOccupantsCount

public int getOccupantsCount()

getOccupantsJidByNickname

public tigase.xmpp.BareJID getOccupantsJidByNickname(String nickname)

getOccupantsJidsByNickname

public Collection<tigase.xmpp.JID> getOccupantsJidsByNickname(String nickname)

getOccupantsNickname

public String getOccupantsNickname(tigase.xmpp.JID jid)

getOccupantsNicknames

public Collection<String> getOccupantsNicknames()

getOccupantsNicknames

public Collection<String> getOccupantsNicknames(tigase.xmpp.BareJID bareJid)

getPresenceFiltered

public PresenceFiltered getPresenceFiltered()

getRole

public Role getRole(String nickname)

getRoomCustomData

public Object getRoomCustomData(String key)

getRoomJID

public tigase.xmpp.BareJID getRoomJID()

getSubject

public String getSubject()

getSubjectChangeDate

public Date getSubjectChangeDate()

getSubjectChangerNick

public String getSubjectChangerNick()

isOccupantInRoom

public boolean isOccupantInRoom(tigase.xmpp.JID jid)

isRoomLocked

public boolean isRoomLocked()

onConfigChanged

public void onConfigChanged(RoomConfig roomConfig,
                            Set<String> modifiedVars)

Specified by:

onConfigChanged in interface RoomConfig.RoomConfigListener

removeListener

public void removeListener(Room.RoomListener listener)

removeOccupant

public boolean removeOccupant(tigase.xmpp.JID jid)

Parameters:

jid -

Returns:

true if no more JIDs assigned to nickname. In other words: nickname is removed

removeOccupant

public void removeOccupant(String occupantNick)

setAffiliations

public void setAffiliations(Map<tigase.xmpp.BareJID,Affiliation> affiliations)

setNewAffiliation

public void setNewAffiliation(tigase.xmpp.BareJID user,
                              Affiliation affiliation)

setNewRole

public void setNewRole(String nickname,
                       Role newRole)

setNewSubject

public void setNewSubject(String msg,
                          String senderNickname)
                   throws tigase.component.exceptions.RepositoryException

Throws:

tigase.component.exceptions.RepositoryException

setRoomCustomData

public void setRoomCustomData(String key,
                              Object data)

setRoomLocked

public void setRoomLocked(boolean roomLocked)

setSubjectChangeDate

public void setSubjectChangeDate(Date subjectChangeDate)

updatePresenceByJid

public void updatePresenceByJid(tigase.xmpp.JID jid,
                                String nickname,
                                tigase.xml.Element cp)
                         throws tigase.util.TigaseStringprepException

Throws:

tigase.util.TigaseStringprepException