Package net.sf.colossus.webcommon

Interface IWebServer

All Known Implementing Classes:

WebClientSocketThread, WebServer

public interface IWebServer

Interface for what WebClient sends to WebServer

Author:

Clemens Katzer

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	Cancel
static java.lang.String	ChangePassword
static java.lang.String	ChatSubmit
static java.lang.String	ConfirmCommand
static java.lang.String	ConfirmRegistration
static java.lang.String	DumpInfo
static java.lang.String	Echo
static java.lang.String	Enroll
static java.lang.String	generalChatName
static java.lang.String	LocallyGameOver
static java.lang.String	Login
static java.lang.String	Logout
static java.lang.String	PingResponse
static java.lang.String	Propose
static java.lang.String	RegisterUser
static java.lang.String	RequestUserAttention
static java.lang.String	RereadLoginMessage
static java.lang.String	ShutdownServer
static java.lang.String	Start
static java.lang.String	StartAtPlayer
static java.lang.String	StartedByPlayer
static java.lang.String	Unenroll
static java.lang.String	WatchGame
static java.lang.String	WebProtocolSeparator

Method Summary

Modifier and Type	Method	Description
void	cancelGame(java.lang.String gameId, java.lang.String byUser)
java.lang.String	changeProperties(java.lang.String username, java.lang.String oldPW, java.lang.String newPW, java.lang.String email, java.lang.Boolean isAdminObj)
void	chatSubmit(java.lang.String chatId, java.lang.String sender, java.lang.String message)
void	dumpInfo()
void	enrollUserToGame(java.lang.String gameId, java.lang.String username)
void	informLocallyGameOver(java.lang.String gameId)
void	informStartedByPlayer(java.lang.String gameId)
void	logout()
GameInfo	proposeGame(java.lang.String initiator, java.lang.String variant, java.lang.String viewmode, long startAt, int duration, java.lang.String summary, java.lang.String expire, boolean unlimMulli, boolean balTowers, int min, int target, int max)
void	requestUserAttention(long when, java.lang.String sender, boolean isAdmin, java.lang.String recipient, java.lang.String message, int beepCount, long beepInterval, boolean windows)
void	rereadLoginMessage()
void	shutdownServer()
void	startGame(java.lang.String gameId, User user)
void	startGameOnPlayerHost(java.lang.String gameId, java.lang.String hostingPlayer, java.lang.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.
void	unenrollUserFromGame(java.lang.String gameId, java.lang.String username)
void	watchGame(java.lang.String gameId, java.lang.String username)

Field Detail

Login

static final java.lang.String Login

See Also:

Constant Field Values

Logout

static final java.lang.String Logout

See Also:

Constant Field Values

RegisterUser

static final java.lang.String RegisterUser

See Also:

Constant Field Values

ConfirmRegistration

static final java.lang.String ConfirmRegistration

See Also:

Constant Field Values

ChangePassword

static final java.lang.String ChangePassword

See Also:

Constant Field Values

Propose

static final java.lang.String Propose

See Also:

Constant Field Values

Enroll

static final java.lang.String Enroll

See Also:

Constant Field Values

Unenroll

static final java.lang.String Unenroll

See Also:

Constant Field Values

Start

static final java.lang.String Start

See Also:

Constant Field Values

StartAtPlayer

static final java.lang.String StartAtPlayer

See Also:

Constant Field Values

StartedByPlayer

static final java.lang.String StartedByPlayer

See Also:

Constant Field Values

LocallyGameOver

static final java.lang.String LocallyGameOver

See Also:

Constant Field Values

Cancel

static final java.lang.String Cancel

See Also:

Constant Field Values

ChatSubmit

static final java.lang.String ChatSubmit

See Also:

Constant Field Values

ShutdownServer

static final java.lang.String ShutdownServer

See Also:

Constant Field Values

Echo

static final java.lang.String Echo

See Also:

Constant Field Values

RereadLoginMessage

static final java.lang.String RereadLoginMessage

See Also:

Constant Field Values

RequestUserAttention

static final java.lang.String RequestUserAttention

See Also:

Constant Field Values

PingResponse

static final java.lang.String PingResponse

See Also:

Constant Field Values

WatchGame

static final java.lang.String WatchGame

See Also:

Constant Field Values

ConfirmCommand

static final java.lang.String ConfirmCommand

See Also:

Constant Field Values

DumpInfo

static final java.lang.String DumpInfo

See Also:

Constant Field Values

generalChatName

static final java.lang.String generalChatName

See Also:

Constant Field Values

WebProtocolSeparator

static final java.lang.String WebProtocolSeparator

See Also:

Constant Field Values

Method Detail

proposeGame

GameInfo proposeGame(java.lang.String initiator,
                     java.lang.String variant,
                     java.lang.String viewmode,
                     long startAt,
                     int duration,
                     java.lang.String summary,
                     java.lang.String expire,
                     boolean unlimMulli,
                     boolean balTowers,
                     int min,
                     int target,
                     int max)

enrollUserToGame

void enrollUserToGame(java.lang.String gameId,
                      java.lang.String username)

unenrollUserFromGame

void unenrollUserFromGame(java.lang.String gameId,
                          java.lang.String username)

cancelGame

void cancelGame(java.lang.String gameId,
                java.lang.String byUser)

startGameOnPlayerHost

void startGameOnPlayerHost(java.lang.String gameId,
                           java.lang.String hostingPlayer,
                           java.lang.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.

startGame

void startGame(java.lang.String gameId,
               User user)

informStartedByPlayer

void informStartedByPlayer(java.lang.String gameId)

informLocallyGameOver

void informLocallyGameOver(java.lang.String gameId)

chatSubmit

void chatSubmit(java.lang.String chatId,
                java.lang.String sender,
                java.lang.String message)

requestUserAttention

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

watchGame

void watchGame(java.lang.String gameId,
               java.lang.String username)

rereadLoginMessage

void rereadLoginMessage()

shutdownServer

void shutdownServer()

dumpInfo

void dumpInfo()

changeProperties

java.lang.String changeProperties(java.lang.String username,
                                  java.lang.String oldPW,
                                  java.lang.String newPW,
                                  java.lang.String email,
                                  java.lang.Boolean isAdminObj)

logout

void logout()