Package VASSAL.chat.jabber

Class JabberClient

java.lang.Object

VASSAL.chat.jabber.JabberClient

All Implemented Interfaces:

org.jivesoftware.smack.PacketListener, ServerConnection, ChatServerConnection, LockableChatServerConnection, PlayerEncoder, ServerStatus, ChatControlsInitializer

public class JabberClient
extends Object
implements LockableChatServerConnection, org.jivesoftware.smack.PacketListener, ServerStatus, ChatControlsInitializer, PlayerEncoder

Nested Class Summary

Nested classes/interfaces inherited from interface VASSAL.chat.ServerStatus

ServerStatus.ModuleSummary

Field Summary

Fields

Modifier and Type	Field	Description
protected PropertyChangeListener	idChangeListener
protected org.jivesoftware.smackx.muc.InvitationListener	inviteListener
static String	JID_RESOURCE
protected org.jivesoftware.smackx.muc.UserStatusListener	kickListener
static String	OWNER
protected JabberPlayer.Manager	playerMgr
protected SimpleStatusControlsInitializer	playerStatusControls
protected PrivateChatEncoder	privateChatEncoder
static String	ROOM_CONFIG
static String	ROOM_JID
static String	ROOM_NAME
protected RoomInteractionControlsInitializer	roomControls
protected JabberRoom.Manager	roomMgr
protected SoundEncoder	soundEncoder
protected org.jivesoftware.smackx.muc.ParticipantStatusListener	userListener

Fields inherited from interface VASSAL.chat.ChatServerConnection

AVAILABLE_ROOMS, DEFAULT_ROOM_NAME, INCOMING_MSG, PLAYER_INFO, ROOM, STATUS, STATUS_SERVER

Fields inherited from interface VASSAL.build.module.ServerConnection

CONNECTED

Constructor Summary

Constructors

Constructor	Description
JabberClient(CommandEncoder encoder, String host, int port, AccountInfo account)

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener l)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener l)	Register a PropertyChangeListener.
protected String	decodeMessage(String encodedMessage)	Encode text encoded by encodeMessage
void	doInvite(String playerId, String roomName)	Process an invitation
void	doKick(Player kickee)	Kick a player from this room
protected String	encodeMessage(String clearText)	Messages must be encoded to pass through Jabber: 1.
protected void	fireRoomsUpdated()
protected void	fireStatus(String msg)
Room[]	getAvailableRooms()	Return an array of all rooms on the server
String	getConferenceService()
org.jivesoftware.smack.XMPPConnection	getConnection()
LockableRoom	getCurrentRoom()
String	getCurrentRoomJID()
String	getDefaultRoomName()	Return the name of the default room
CommandEncoder	getEncoder()
ServerStatus.ModuleSummary[]	getHistory(String timeRange)
String	getHost()
MessageBoard	getMessageServer()
String	getModule()
Room	getRoom()	Return the room currently occupied by the player
JabberRoom	getRoomByName(String name)
ServerStatus.ModuleSummary[]	getStatus()	Return the current connections to the server
ServerStatus	getStatusServer()
String[]	getSupportedTimeRanges()
Player	getUserInfo()	Return a Player instance representing the current player
void	initializeControls(ChatServerControls controls)	Register all event listeners
boolean	isConnected()
boolean	isDefaultRoom(Room r)	Is specified room the default room?
boolean	isInvitable(Player invitee)	Can a player be invited to this room?
boolean	isKickable(Player kickee)	Is a player kickable from this room?
void	lockRoom(LockableRoom r)	Toggle the lock state on the room.
static void	main(String[] args)
String	playerToString(Player p)
void	processPacket(org.jivesoftware.smack.packet.Packet packet)
void	processServerMessage(String subject, String message)
void	sendInvite(Player invitee)	Send invitation to player
void	sendTo(Player recipient, Command c)	Send a Command to a particular player
void	sendToOthers(Command c)	Send a command to other players on the server
void	setConnected(boolean connect)
void	setEncoder(CommandEncoder encoder)
void	setRoom(String roomName)
void	setRoom(Room r)	Join the given room
void	setUserInfo(Player p)	Set the Player instance representing this player
Player	stringToPlayer(String s)
static String	testConnection(String host, String port, String login, String passwd)
static String	unescapeNode(String node)
void	uninitializeControls(ChatServerControls controls)	Remove all previously-registered event listeners

Methods inherited from class java.lang.Object

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

Field Details

JID_RESOURCE

public static final String JID_RESOURCE

See Also:

Constant Field Values

ROOM_CONFIG

public static final String ROOM_CONFIG

See Also:

Constant Field Values

ROOM_JID

public static final String ROOM_JID

See Also:

Constant Field Values

ROOM_NAME

public static final String ROOM_NAME

See Also:

Constant Field Values

OWNER

public static final String OWNER

See Also:

Constant Field Values

soundEncoder

protected SoundEncoder soundEncoder

privateChatEncoder

protected PrivateChatEncoder privateChatEncoder

roomControls

protected RoomInteractionControlsInitializer roomControls

playerStatusControls

protected SimpleStatusControlsInitializer playerStatusControls

playerMgr

protected JabberPlayer.Manager playerMgr

roomMgr

protected JabberRoom.Manager roomMgr

idChangeListener

protected PropertyChangeListener idChangeListener

kickListener

protected org.jivesoftware.smackx.muc.UserStatusListener kickListener

inviteListener

protected org.jivesoftware.smackx.muc.InvitationListener inviteListener

userListener

protected org.jivesoftware.smackx.muc.ParticipantStatusListener userListener

Constructor Details

JabberClient

public JabberClient(CommandEncoder encoder,
String host,
int port,
AccountInfo account)

Method Details

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
PropertyChangeListener l)

Description copied from interface: ServerConnection

Register a PropertyChangeListener. Changes to connection status triggers a PropertyChangeEvent, and concrete implementations may define other properties

Specified by:

addPropertyChangeListener in interface ServerConnection

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

isConnected

public boolean isConnected()

Specified by:

isConnected in interface ServerConnection

sendToOthers

public void sendToOthers(Command c)

Description copied from interface: ServerConnection

Send a command to other players on the server

Specified by:

sendToOthers in interface ServerConnection

setConnected

public void setConnected(boolean connect)

Specified by:

setConnected in interface ServerConnection

initializeControls

public void initializeControls(ChatServerControls controls)

Description copied from interface: ChatControlsInitializer

Register all event listeners

Specified by:

initializeControls in interface ChatControlsInitializer

uninitializeControls

public void uninitializeControls(ChatServerControls controls)

Description copied from interface: ChatControlsInitializer

Remove all previously-registered event listeners

Specified by:

uninitializeControls in interface ChatControlsInitializer

processPacket

public void processPacket(org.jivesoftware.smack.packet.Packet packet)

Specified by:

processPacket in interface org.jivesoftware.smack.PacketListener

processServerMessage

public void processServerMessage(String subject,
String message)

getRoom

public Room getRoom()

Description copied from interface: ChatServerConnection

Return the room currently occupied by the player

Specified by:

getRoom in interface ChatServerConnection

getRoomByName

public JabberRoom getRoomByName(String name)

getCurrentRoomJID

public String getCurrentRoomJID()

getCurrentRoom

public LockableRoom getCurrentRoom()

setRoom

public void setRoom(String roomName)

setRoom

public void setRoom(Room r)

Description copied from interface: ChatServerConnection

Join the given room

Specified by:

setRoom in interface ChatServerConnection

getAvailableRooms

public Room[] getAvailableRooms()

Description copied from interface: ChatServerConnection

Return an array of all rooms on the server

Specified by:

getAvailableRooms in interface ChatServerConnection

fireRoomsUpdated

protected void fireRoomsUpdated()

fireStatus

protected void fireStatus(String msg)

getUserInfo

public Player getUserInfo()

Description copied from interface: ChatServerConnection

Return a Player instance representing the current player

Specified by:

getUserInfo in interface ChatServerConnection

setUserInfo

public void setUserInfo(Player p)

Description copied from interface: ChatServerConnection

Set the Player instance representing this player

Specified by:

setUserInfo in interface ChatServerConnection

getDefaultRoomName

public String getDefaultRoomName()

Description copied from interface: LockableChatServerConnection

Return the name of the default room

Specified by:

getDefaultRoomName in interface LockableChatServerConnection

isDefaultRoom

public boolean isDefaultRoom(Room r)

Description copied from interface: LockableChatServerConnection

Is specified room the default room?

Specified by:

isDefaultRoom in interface LockableChatServerConnection

sendTo

public void sendTo(Player recipient,
Command c)

Description copied from interface: ChatServerConnection

Send a Command to a particular player

Specified by:

sendTo in interface ChatServerConnection

isInvitable

public boolean isInvitable(Player invitee)

Can a player be invited to this room?

Specified by:

isInvitable in interface LockableChatServerConnection

sendInvite

public void sendInvite(Player invitee)

Send invitation to player

Specified by:

sendInvite in interface LockableChatServerConnection

doInvite

public void doInvite(String playerId,
String roomName)

Process an invitation

Specified by:

doInvite in interface LockableChatServerConnection

isKickable

public boolean isKickable(Player kickee)

Is a player kickable from this room?

Specified by:

isKickable in interface LockableChatServerConnection

doKick

public void doKick(Player kickee)

Kick a player from this room

Specified by:

doKick in interface LockableChatServerConnection

getMessageServer

public MessageBoard getMessageServer()

getStatusServer

public ServerStatus getStatusServer()

getConnection

public org.jivesoftware.smack.XMPPConnection getConnection()

getModule

public String getModule()

getConferenceService

public String getConferenceService()

unescapeNode

public static String unescapeNode(String node)

encodeMessage

protected String encodeMessage(String clearText)

Messages must be encoded to pass through Jabber: 1. To remove Escape characters (Vassal sub-command separator) 2. To hide the raw Vassal commands from observers on the chat room using a Jabber Client.

Parameters:

clearText -

Returns:

encoded text

decodeMessage

protected String decodeMessage(String encodedMessage)

Encode text encoded by encodeMessage

Parameters:

encodedMessage -

Returns:

decoded text

lockRoom

public void lockRoom(LockableRoom r)

Toggle the lock state on the room.

Specified by:

lockRoom in interface LockableChatServerConnection

getEncoder

public CommandEncoder getEncoder()

setEncoder

public void setEncoder(CommandEncoder encoder)

getHistory

public ServerStatus.ModuleSummary[] getHistory(String timeRange)

Specified by:

getHistory in interface ServerStatus

Returns:

the connections to the server within time milliseconds of the current time

getStatus

public ServerStatus.ModuleSummary[] getStatus()

Description copied from interface: ServerStatus

Return the current connections to the server

Specified by:

getStatus in interface ServerStatus

getSupportedTimeRanges

public String[] getSupportedTimeRanges()

Specified by:

getSupportedTimeRanges in interface ServerStatus

main

public static void main(String[] args)

getHost

public String getHost()

playerToString

public String playerToString(Player p)

Specified by:

playerToString in interface PlayerEncoder

stringToPlayer

public Player stringToPlayer(String s)

Specified by:

stringToPlayer in interface PlayerEncoder

testConnection

public static String testConnection(String host,
String port,
String login,
String passwd)