edu.usc.ict.iago.utils

Class GameBridgeUtils

java.lang.Object

edu.usc.ict.iago.utils.GameBridgeUtils

public class GameBridgeUtils
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	GameBridgeUtils.AcceptanceState
static class	GameBridgeUtils.NegotiationMode
(package private) static class	GameBridgeUtils.QuitState

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.logging.Logger	logger

Constructor Summary

Constructors

Constructor and Description
GameBridgeUtils(GameSpec spec) Constructor for GameBridgeUtils.

Method Summary

Modifier and Type	Method and Description
void	doGetHelper(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Method to implement HTTP GET.
void	doPostHelper(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Method to implement HTTP POST.
(package private) GameBridgeUtils.AcceptanceState	getAstate() This method allows other classes in Core (namely the Mediator and VHRunner) to know whether or not the game is over due to mutual acceptance.
(package private) javax.servlet.http.HttpSession	getHttpSession()
(package private) GameBridgeUtils.NegotiationMode	getNMode()
(package private) GameBridgeUtils.QuitState	getQstate() This method allows other classes in Core (namely the Mediator and VHRunner) to know whether or not the game is over due to mutual quitting.
(package private) void	handleClose()
void	onCloseHelper(javax.websocket.Session session, javax.websocket.CloseReason cr) Method that runs when the webpage is closed.
void	onMessageHelper(javax.websocket.Session session, java.lang.String msg, boolean last) Method that runs every time the webpage sends an event to GameBridge.
void	onOpenHelper(javax.websocket.Session session, javax.websocket.EndpointConfig config, GeneralVH agent0, GeneralVH agent1) Method that runs when the webpage is opened.
(package private) void	processEvent(Event e, javax.websocket.Session session) Processes an individual event and adds appropriate events to the history and/or the queue to be sent to opposing agent
(package private) void	sendFinalNotification() When one user FORMAL_END the game, notify the other in H-H mode should only be used in NegotiationRoom class When this function is used, the game is already ended internally
void	setGameSpec(GameSpec spec) Changes the game spec and resets several variables.
void	setMultiplayer(boolean multi)
void	setNegotiationMode(GameBridgeUtils.NegotiationMode nMode)
void	setNRoom(NegotiationRoom nRoom)
void	setSessionOther(javax.servlet.http.HttpSession httpSession, javax.websocket.Session session)

Methods inherited from class java.lang.Object

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

Field Detail

logger

java.util.logging.Logger logger

Constructor Detail

GameBridgeUtils

public GameBridgeUtils(GameSpec spec)

Constructor for GameBridgeUtils. Sets the GameSpec and initializes the locations of items on the board.

Parameters:

spec - The GameSpec for the first game to be played using this GBU.

Method Detail

setGameSpec

public void setGameSpec(GameSpec spec)

Changes the game spec and resets several variables. Is not necessary for single games (and may break things!). Not to be called except from GameBridge.

Parameters:

spec - the new GameSpec

onOpenHelper

public void onOpenHelper(javax.websocket.Session session,
                         javax.websocket.EndpointConfig config,
                         GeneralVH agent0,
                         GeneralVH agent1)
                  throws javax.mail.MessagingException

Method that runs when the webpage is opened. This should only be called from GameBridge's onOpen method. Set's the username of the user for the session, attaches agents to the threads needed to run them, and pairs the two negotiators together.

Parameters:

session - The web session that was just opened.

config -

agent0 - The user's agent. If this is null, then the user does not have an agent and will negotiate on her own behalf.

agent1 - The opponent agent. This should never be null.

Throws:

javax.mail.MessagingException

onCloseHelper

public void onCloseHelper(javax.websocket.Session session,
                          javax.websocket.CloseReason cr)

Method that runs when the webpage is closed. This should only be called from GameBridge's onClose method. Currently only prints a debug line to the log.

Parameters:

session - The web session that closed.

cr - The reason the web session closed.

handleClose

void handleClose()

onMessageHelper

public void onMessageHelper(javax.websocket.Session session,
                            java.lang.String msg,
                            boolean last)

Method that runs every time the webpage sends an event to GameBridge. This should only be called from GameBridge's onMessage method. This handles almost every input that comes from the webpage: time notifications, requests for information needed to configure or reconfigure the webpage, and survey data.

Parameters:

session - the web session that sent the message.

msg - the message sent by the webpage.

last - Indicates whether or not this is the last of a series of messages. Currently unused.

doPostHelper

public void doPostHelper(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws javax.servlet.ServletException,
                         java.io.IOException

Method to implement HTTP POST. Only called from GameBridge.

Parameters:

request -

response -

Throws:

javax.servlet.ServletException

java.io.IOException

doGetHelper

public void doGetHelper(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws javax.servlet.ServletException,
                        java.io.IOException

Method to implement HTTP GET. Only called from GameBridge.

Parameters:

request -

response -

Throws:

javax.servlet.ServletException

java.io.IOException

processEvent

void processEvent(Event e,
                  javax.websocket.Session session)

Processes an individual event and adds appropriate events to the history and/or the queue to be sent to opposing agent

Parameters:

e -

session -

sendFinalNotification

void sendFinalNotification()

When one user FORMAL_END the game, notify the other in H-H mode should only be used in NegotiationRoom class When this function is used, the game is already ended internally

getAstate

GameBridgeUtils.AcceptanceState getAstate()

This method allows other classes in Core (namely the Mediator and VHRunner) to know whether or not the game is over due to mutual acceptance.

Returns:

the state of acceptance.

getQstate

GameBridgeUtils.QuitState getQstate()

This method allows other classes in Core (namely the Mediator and VHRunner) to know whether or not the game is over due to mutual quitting.

Returns:

the state of quitting.

getNMode

GameBridgeUtils.NegotiationMode getNMode()

getHttpSession

javax.servlet.http.HttpSession getHttpSession()

setNRoom

public void setNRoom(NegotiationRoom nRoom)

setNegotiationMode

public void setNegotiationMode(GameBridgeUtils.NegotiationMode nMode)

setSessionOther

public void setSessionOther(javax.servlet.http.HttpSession httpSession,
                            javax.websocket.Session session)

setMultiplayer

public void setMultiplayer(boolean multi)