Package VASSAL.chat.jabber

Class JabberRoom

java.lang.Object

VASSAL.chat.SimpleRoom

VASSAL.chat.jabber.JabberRoom

All Implemented Interfaces:

LockableRoom, Room

public class JabberRoom
extends SimpleRoom
implements LockableRoom

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JabberRoom.JabberRoomConfig
static class	JabberRoom.Manager

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_CRC
static String	CONFIG_CRC_CHECK
static String	CONFIG_LOCKED
static String	CONFIG_MIN_MODULE_VERSION
static String	CONFIG_MIN_VASSAL_VERSION
static String	CONFIG_MODULE_VERSION
static String	CONFIG_NAME
static String	CONFIG_VASSAL_VERSION

Method Summary

Modifier and Type	Method	Description
void	addOwner(String jid)
String	canJoin(JabberPlayer p)	Is the specified player allowed to join this room?
static Properties	configureNewRoom()
void	decodeConfig(String s)
String	encodeConfig()
boolean	equals(Object o)
String	getCheckCrc()
String	getJID()
String	getModuleOption()
String	getModuleVersion()
Player	getOwningPlayer()
String	getVassalOption()
String	getVassalVersion()
int	hashCode()
boolean	isLocked()
boolean	isMatchCrc()
boolean	isOwnedByMe()
boolean	isOwner(String jid)
boolean	isStartLocked()
org.jivesoftware.smackx.muc.MultiUserChat	join(JabberClient client, JabberPlayer me)
protected void	lock(org.jivesoftware.smackx.muc.MultiUserChat muc)
void	removeOwner(String jid)
void	setConfig(Properties props)
void	setInfo(org.jivesoftware.smackx.muc.RoomInfo info)
void	showConfig()
void	toggleLock(org.jivesoftware.smackx.muc.MultiUserChat muc)
protected void	unlock(org.jivesoftware.smackx.muc.MultiUserChat muc)

Methods inherited from class VASSAL.chat.SimpleRoom

addPlayer, contains, getName, getPlayer, getPlayerList, getPlayers, numPlayers, removePlayer, setName, setPlayers, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface VASSAL.chat.LockableRoom

getName

Field Details

CONFIG_NAME

public static final String CONFIG_NAME

See Also:

Constant Field Values

CONFIG_LOCKED

public static final String CONFIG_LOCKED

See Also:

Constant Field Values

CONFIG_VASSAL_VERSION

public static final String CONFIG_VASSAL_VERSION

See Also:

Constant Field Values

CONFIG_MIN_VASSAL_VERSION

public static final String CONFIG_MIN_VASSAL_VERSION

See Also:

Constant Field Values

CONFIG_MODULE_VERSION

public static final String CONFIG_MODULE_VERSION

See Also:

Constant Field Values

CONFIG_MIN_MODULE_VERSION

public static final String CONFIG_MIN_MODULE_VERSION

See Also:

Constant Field Values

CONFIG_CRC_CHECK

public static final String CONFIG_CRC_CHECK

See Also:

Constant Field Values

CONFIG_CRC

public static final String CONFIG_CRC

See Also:

Constant Field Values

Method Details

getJID

public String getJID()

isLocked

public boolean isLocked()

Specified by:

isLocked in interface LockableRoom

setInfo

public void setInfo(org.jivesoftware.smackx.muc.RoomInfo info)

toggleLock

public void toggleLock(org.jivesoftware.smackx.muc.MultiUserChat muc)

lock

protected void lock(org.jivesoftware.smackx.muc.MultiUserChat muc)
             throws org.jivesoftware.smack.XMPPException

Throws:

org.jivesoftware.smack.XMPPException

unlock

protected void unlock(org.jivesoftware.smackx.muc.MultiUserChat muc)
               throws org.jivesoftware.smack.XMPPException

Throws:

org.jivesoftware.smack.XMPPException

join

public org.jivesoftware.smackx.muc.MultiUserChat join(JabberClient client,
JabberPlayer me)
                                               throws org.jivesoftware.smack.XMPPException

Throws:

org.jivesoftware.smack.XMPPException

equals

public boolean equals(Object o)

Overrides:

equals in class SimpleRoom

hashCode

public int hashCode()

Overrides:

hashCode in class SimpleRoom

isOwnedByMe

public boolean isOwnedByMe()

isOwner

public boolean isOwner(String jid)

Specified by:

isOwner in interface LockableRoom

addOwner

public void addOwner(String jid)

removeOwner

public void removeOwner(String jid)

getOwningPlayer

public Player getOwningPlayer()

Specified by:

getOwningPlayer in interface LockableRoom

setConfig

public void setConfig(Properties props)

encodeConfig

public String encodeConfig()

decodeConfig

public void decodeConfig(String s)

isStartLocked

public boolean isStartLocked()

isMatchCrc

public boolean isMatchCrc()

getCheckCrc

public String getCheckCrc()

getVassalOption

public String getVassalOption()

getVassalVersion

public String getVassalVersion()

getModuleOption

public String getModuleOption()

getModuleVersion

public String getModuleVersion()

showConfig

public void showConfig()

canJoin

public String canJoin(JabberPlayer p)

Is the specified player allowed to join this room?

Parameters:

p - A JabberPlayer

Returns:

null = false, non-null = error message

configureNewRoom

public static Properties configureNewRoom()