Class WebClientSocketThread

java.lang.Object

java.lang.Thread

net.sf.colossus.webclient.WebClientSocketThread

All Implemented Interfaces:

Runnable, IWebServer

public class WebClientSocketThread
extends Thread
implements IWebServer

This implements the webserver/client communication at client side. It implements the server interface on client side; i.e. something server wanted to execute for a client, is read from the client socket input stream, parsed, and executed by the (WebClient)SocketThread. This also contains the methods which are called by the client (WebClient's GUI) and are sent over the socket to the server (note that those calls mostly happen in the EDT).

Author:

Clemens Katzer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	WebClientSocketThread.AckWaiter
class	WebClientSocketThread.WcstException

Nested classes/interfaces inherited from class Thread

Thread.Builder, Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field	Description
private WebClientSocketThread.AckWaiter	ackWaiter
private final Charset	charset
private boolean	closingForcefullyToCancel
private static final Object	connectOngoingMutex
private static int	counter
private static WebClientSocketThread	currentAttempt
private String	email
private WebClientSocketThread.WcstException	failedException
private boolean	force
private final HashMap<String,GameInfo>	gameHash
private String	hostname
private BufferedReader	in
private boolean	loggedIn
private static final Logger	LOGGER
private PrintWriter	out
private String	password
private final int	port
private static final String	sep
private Socket	socket
private boolean	stillNeedsRun
private String	username
private IWebClient	webClient

Fields inherited from class Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Fields inherited from interface IWebServer

Cancel, ChangePassword, ChatSubmit, ConfirmCommand, ConfirmRegistration, DumpInfo, Echo, Enroll, generalChatName, LocallyGameOver, Login, Logout, PingResponse, Propose, RegisterUser, RequestUserAttention, RereadLoginMessage, ShutdownServer, Start, StartAtPlayer, StartedByPlayer, Unenroll, WatchGame, WebProtocolSeparator

Constructor Summary

Constructors

Constructor	Description
WebClientSocketThread(IWebClient wcGUI, String hostname, int port, String username, String password, boolean force, String email, String confCode, HashMap<String,GameInfo> gameHash)

Method Summary

Modifier and Type	Method	Description
static void	cancelConnectAttempt()
void	cancelGame(String gameId, String byUser)
String	changeProperties(String username, String oldPW, String newPW, String email, Boolean isAdminObj)
void	chatSubmit(String chatId, String sender, String message)
private void	closeSocketForcefully()
private void	confirm(String confCode)	Send the confirmation code
void	confirmCommand(String cmd, String arg1, String arg2, String arg3)
private void	connect()
void	dispose()
private void	doCleanup()
void	dumpInfo()
void	enrollUserToGame(String gameId, String username)
WebClientSocketThread.WcstException	getException()
String	getOneLine()
String	getUsername()
private void	handleAckNack(String command, String[] tokens)
void	informLocallyGameOver(String gameId)
void	informStartedByPlayer(String gameId)
private void	login()
void	logout()
void	pingResponse(String arg1, String arg2, String arg3)
GameInfo	proposeGame(String initiator, String variant, String viewmode, long startAt, int duration, String summary, String expire, boolean unlimitedMulligans, boolean balancedTowers, int min, int target, int max)
private void	register()	Initial registration attempt
void	requestUserAttention(long when, String sender, boolean isAdmin, String recipient, String message, int beepCount, long beepInterval, boolean windows)
void	rereadLoginMessage()
private GameInfo	restoreGameInfo(String[] tokens)
void	run()
private void	send(String s)
void	shutdownServer()
void	sleepFor(long millis)
void	startGame(String gameId, User byUser)
void	startGameOnPlayerHost(String gameId, String hostingPlayer, String playerHost, int port)	A game was started by a WebClient user locally on his computer and is ready to accept the other players as remote client; so we notify them and tell them host and port to where to connect.
boolean	stillNeedsRun()
void	submitAnyText(String text)
void	unenrollUserFromGame(String gameId, String username)
void	watchGame(String gameId, String username)
private void	writeLog(String s)

Methods inherited from class Thread

activeCount, checkAccess, clone, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, isVirtual, join, join, join, join, ofPlatform, ofVirtual, onSpinWait, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, sleep, start, startVirtualThread, stop, threadId, toString, yield

Methods inherited from class Object

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

Field Details

LOGGER

private static final Logger LOGGER

webClient

private IWebClient webClient

gameHash

private final HashMap<String,GameInfo> gameHash

hostname

private String hostname

port

private final int port

username

private String username

password

private String password

force

private boolean force

email

private String email

socket

private Socket socket

in

private BufferedReader in

out

private PrintWriter out

stillNeedsRun

private boolean stillNeedsRun

sep

private static final String sep

See Also:

• Constant Field Values

loggedIn

private boolean loggedIn

ackWaiter

private WebClientSocketThread.AckWaiter ackWaiter

failedException

private WebClientSocketThread.WcstException failedException

counter

private static int counter

currentAttempt

private static WebClientSocketThread currentAttempt

closingForcefullyToCancel

private boolean closingForcefullyToCancel

connectOngoingMutex

private static final Object connectOngoingMutex

charset

private final Charset charset

Constructor Details

WebClientSocketThread

public WebClientSocketThread(IWebClient wcGUI,
 String hostname,
 int port,
 String username,
 String password,
 boolean force,
 String email,
 String confCode,
 HashMap<String,GameInfo> gameHash)

Method Details

getOneLine

public String getOneLine()
                  throws IOException

Throws:

IOException

getException

public WebClientSocketThread.WcstException getException()

cancelConnectAttempt

public static void cancelConnectAttempt()

closeSocketForcefully

private void closeSocketForcefully()

connect

private void connect()
              throws WebClientSocketThread.WcstException

Throws:

WebClientSocketThread.WcstException

register

private void register()
               throws WebClientSocketThread.WcstException

Initial registration attempt

Throws:

WebClientSocketThread.WcstException

confirm

private void confirm(String confCode)
              throws WebClientSocketThread.WcstException

Send the confirmation code

Throws:

WebClientSocketThread.WcstException

login

private void login()
            throws WebClientSocketThread.WcstException

Throws:

WebClientSocketThread.WcstException

stillNeedsRun

public boolean stillNeedsRun()

getUsername

public String getUsername()

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

restoreGameInfo

private GameInfo restoreGameInfo(String[] tokens)

doCleanup

private void doCleanup()

dispose

public void dispose()

send

private void send(String s)

logout

public void logout()

Specified by:

logout in interface IWebServer

changeProperties

public String changeProperties(String username,
 String oldPW,
 String newPW,
 String email,
 Boolean isAdminObj)

Specified by:

changeProperties in interface IWebServer

handleAckNack

private void handleAckNack(String command,
 String[] tokens)

proposeGame

public GameInfo proposeGame(String initiator,
 String variant,
 String viewmode,
 long startAt,
 int duration,
 String summary,
 String expire,
 boolean unlimitedMulligans,
 boolean balancedTowers,
 int min,
 int target,
 int max)

Specified by:

proposeGame in interface IWebServer

enrollUserToGame

public void enrollUserToGame(String gameId,
 String username)

Specified by:

enrollUserToGame in interface IWebServer

unenrollUserFromGame

public void unenrollUserFromGame(String gameId,
 String username)

Specified by:

unenrollUserFromGame in interface IWebServer

cancelGame

public void cancelGame(String gameId,
 String byUser)

Specified by:

cancelGame in interface IWebServer

startGame

public void startGame(String gameId,
 User byUser)

Specified by:

startGame in interface IWebServer

informStartedByPlayer

public void informStartedByPlayer(String gameId)

Specified by:

informStartedByPlayer in interface IWebServer

informLocallyGameOver

public void informLocallyGameOver(String gameId)

Specified by:

informLocallyGameOver in interface IWebServer

startGameOnPlayerHost

public void startGameOnPlayerHost(String gameId,
 String hostingPlayer,
 String playerHost,
 int port)

Description copied from interface: IWebServer

A game was started by a WebClient user locally on his computer and is ready to accept the other players as remote client; so we notify them and tell them host and port to where to connect.

Specified by:

startGameOnPlayerHost in interface IWebServer

chatSubmit

public void chatSubmit(String chatId,
 String sender,
 String message)

Specified by:

chatSubmit in interface IWebServer

pingResponse

public void pingResponse(String arg1,
 String arg2,
 String arg3)

watchGame

public void watchGame(String gameId,
 String username)

Specified by:

watchGame in interface IWebServer

sleepFor

public void sleepFor(long millis)

confirmCommand

public void confirmCommand(String cmd,
 String arg1,
 String arg2,
 String arg3)

requestUserAttention

public void requestUserAttention(long when,
 String sender,
 boolean isAdmin,
 String recipient,
 String message,
 int beepCount,
 long beepInterval,
 boolean windows)

Specified by:

requestUserAttention in interface IWebServer

shutdownServer

public void shutdownServer()

Specified by:

shutdownServer in interface IWebServer

rereadLoginMessage

public void rereadLoginMessage()

Specified by:

rereadLoginMessage in interface IWebServer

dumpInfo

public void dumpInfo()

Specified by:

dumpInfo in interface IWebServer

submitAnyText

public void submitAnyText(String text)

writeLog

private void writeLog(String s)