client.networking

Class GSONServerProxy

java.lang.Object

client.networking.GSONServerProxy

All Implemented Interfaces:

ServerProxy

public class GSONServerProxy
extends java.lang.Object
implements ServerProxy

Author:

Parker Ridd

Field Summary

Fields

Modifier and Type	Field and Description
private int	gameID
private java.lang.String	HTTP_GET
private java.lang.String	HTTP_POST
private java.lang.String	SERVER_HOST
private int	SERVER_PORT
private java.lang.String	URL_PREFIX
private UserCookie	userCookie
private int	userIndex
private java.lang.String	userName

Constructor Summary

Constructors

Constructor and Description
GSONServerProxy() Default constructor.
GSONServerProxy(java.lang.String server_host, int server_port) Sets up connection with the server with specified parameters

Method Summary

Modifier and Type	Method and Description
GameModel	acceptTrade(boolean willAccept) Notifies the server whether this player has decided to accept or reject a trade
void	addAI(AIType aiType) Adds an AI to the game
GameModel	buildCity(Coordinate location) Notifies the server that the user has decided to build a city
GameModel	buildRoad(Coordinate start, Coordinate end, boolean free) Notifies the server that the user has decided to build a road
GameModel	buildSettlement(Coordinate location, boolean free) Notifies the server that the user has decided to build a settlement
GameModel	buyDevCard() Notifies the server that the user has bought a development card
void	clearCookies() FOR DEBUGGING ONLY TODO make private for distro Clears all cookies
GameInfo	createGame(boolean randomTiles, boolean randomNumbers, boolean randomPorts, java.lang.String name) Creates a game on the server
GameModel	discardCards(java.util.List<java.lang.Integer> resourceList) Notifies the server that the user has discarded cards
private java.lang.String	doJSONGet(java.lang.String urlPath)
private java.lang.String	doJSONPost(java.lang.String urlPath, java.lang.String postData, boolean getUserCookie, boolean getGameCookie)
GameModel	finishTurn() Notifies the server that the user has finished his turn
GameModel	getGameModel(int version) Retrieves the game model from the server
UserCookie	getUserCookie() Gets the user cookie
int	getUserId() Gets the player ID
int	getUserIndex() Getting for current user index
java.lang.String	getUserName() Gets the current user's name
void	joinGame(int id, CatanColor color)
java.util.List<AIType>	listAI()
java.util.List<GameInfo>	listGames() Fetches a list of ongoing games
boolean	loginUser(java.lang.String username, java.lang.String password) Logs the specified user in and returns a User object if the user was successfully logged in.
GameModel	maritimeTrade(int ratio, ResourceType inputResource, ResourceType outputResource) Notifies the server that the user has decided to initiate a maritime trade
GameModel	monopolyCard(ResourceType resource) Notifies the server that the user has played a monopoly card
GameModel	monumentCard() Notifies the server that the user has played a monument card
GameModel	offerTrade(java.util.List<java.lang.Integer> resourceList, int receiver) Notifies the server that the user has decided to offer a trade to another player
boolean	registerUser(java.lang.String username, java.lang.String password) Registers a user with the specified username and password
GameModel	roadBuildingCard(Coordinate start1, Coordinate end1, Coordinate start2, Coordinate end2) Notifies the server that the user has played a road building card
GameModel	robPlayer(int victimIndex, Coordinate location) Notifies the server that the user has decided to rob another player
GameModel	rollNumber(int roll) Reports the result of a dice roll to the server
GameModel	sendChat(java.lang.String content) Sends a chat message from the specified user to the server
GameModel	soldierCard(int victimIndex, Coordinate location) Notifies the server that the user has played a soldier card
GameModel	yearOfPlentyCard(ResourceType resource1, ResourceType resource2) Notifies the server that the user has played a year of plenty card

Methods inherited from class java.lang.Object

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

Field Detail

userCookie

private UserCookie userCookie

gameID

private int gameID

SERVER_HOST

private java.lang.String SERVER_HOST

SERVER_PORT

private int SERVER_PORT

URL_PREFIX

private java.lang.String URL_PREFIX

HTTP_GET

private final java.lang.String HTTP_GET

See Also:

Constant Field Values

HTTP_POST

private final java.lang.String HTTP_POST

See Also:

Constant Field Values

userIndex

private int userIndex

userName

private java.lang.String userName

Constructor Detail

GSONServerProxy

public GSONServerProxy()

Default constructor. Sets up connection with the server with default parameters.

GSONServerProxy

public GSONServerProxy(java.lang.String server_host,
                       int server_port)

Sets up connection with the server with specified parameters

Parameters:

server_host - this string represents the hostname of the server

server_port - this int is the port to send requests to on the server

Method Detail

getUserIndex

public int getUserIndex()

Getting for current user index

Returns:

getUserId

public int getUserId()

Gets the player ID

Specified by:

getUserId in interface ServerProxy

Returns:

getUserName

public java.lang.String getUserName()
                             throws ServerProxyException

Gets the current user's name

Specified by:

getUserName in interface ServerProxy

Returns:

Throws:

ServerProxyException - if not logged in

loginUser

public boolean loginUser(java.lang.String username,
                         java.lang.String password)
                  throws ServerProxyException

Description copied from interface: ServerProxy

Logs the specified user in and returns a User object if the user was successfully logged in. If not, a null user is returned

Specified by:

loginUser in interface ServerProxy

Parameters:

username - The username of the user to log in

password - The password of the user to log in

Returns:

boolean true when the user could be logged in, false when he couldn't

Throws:

ServerProxyException - if the user could not be logged in

registerUser

public boolean registerUser(java.lang.String username,
                            java.lang.String password)
                     throws ServerProxyException

Description copied from interface: ServerProxy

Registers a user with the specified username and password

Specified by:

registerUser in interface ServerProxy

Parameters:

username - The username of the user to be registered

password - The password of the user to be registered

Returns:

boolean true when the user could be registered, false when he couldn't

Throws:

ServerProxyException - if this user could not be registered

listGames

public java.util.List<GameInfo> listGames()
                                   throws ServerProxyException

Description copied from interface: ServerProxy

Fetches a list of ongoing games

Specified by:

listGames in interface ServerProxy

Returns:

a list of all ongoing games on the server

Throws:

ServerProxyException

createGame

public GameInfo createGame(boolean randomTiles,
                           boolean randomNumbers,
                           boolean randomPorts,
                           java.lang.String name)
                    throws ServerProxyException

Description copied from interface: ServerProxy

Creates a game on the server

Specified by:

createGame in interface ServerProxy

Parameters:

randomTiles - Whether the server should place random tiles

randomNumbers - Whether the server should place random number chits

randomPorts - Whether the server should place random ports

name - The name of the game to be created

Returns:

a GameInfo object that represents the game that was created

Throws:

ServerProxyException - if something goes wrong

joinGame

public void joinGame(int id,
                     CatanColor color)
              throws ServerProxyException

Specified by:

joinGame in interface ServerProxy

color - the color the user wishes to represent him

Throws:

ServerProxyException - if something goes wrong

getGameModel

public GameModel getGameModel(int version)
                       throws ServerProxyException

Description copied from interface: ServerProxy

Retrieves the game model from the server

Specified by:

getGameModel in interface ServerProxy

Parameters:

version - the current version of the model in the client

Returns:

a GameModel object

Throws:

ServerProxyException - if something goes wrong

addAI

public void addAI(AIType aiType)
           throws ServerProxyException

Description copied from interface: ServerProxy

Adds an AI to the game

Specified by:

addAI in interface ServerProxy

Parameters:

aiType - the type of AI the user wishes to add

Throws:

ServerProxyException - if there is no logged in user

listAI

public java.util.List<AIType> listAI()
                              throws ServerProxyException

Specified by:

listAI in interface ServerProxy

Returns:

a list of supported AI player types

Throws:

ServerProxyException - if there is no logged in user

sendChat

public GameModel sendChat(java.lang.String content)
                   throws ServerProxyException

Description copied from interface: ServerProxy

Sends a chat message from the specified user to the server

Specified by:

sendChat in interface ServerProxy

Parameters:

content - The content of the chat message

Returns:

A GameModel object

Throws:

ServerProxyException - if there is no logged in user

rollNumber

public GameModel rollNumber(int roll)
                     throws ServerProxyException

Description copied from interface: ServerProxy

Reports the result of a dice roll to the server

Specified by:

rollNumber in interface ServerProxy

Parameters:

roll - The result of the user's roll

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

robPlayer

public GameModel robPlayer(int victimIndex,
                           Coordinate location)
                    throws ServerProxyException

Description copied from interface: ServerProxy

Notifies the server that the user has decided to rob another player

Specified by:

robPlayer in interface ServerProxy

Parameters:

victimIndex - The index of the victim of the user's robbing

location - The new coordinate location of the robber

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

finishTurn

public GameModel finishTurn()
                     throws ServerProxyException

Description copied from interface: ServerProxy

Notifies the server that the user has finished his turn

Specified by:

finishTurn in interface ServerProxy

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

buyDevCard

public GameModel buyDevCard()
                     throws ServerProxyException

Description copied from interface: ServerProxy

Notifies the server that the user has bought a development card

Specified by:

buyDevCard in interface ServerProxy

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

yearOfPlentyCard

public GameModel yearOfPlentyCard(ResourceType resource1,
                                  ResourceType resource2)
                           throws ServerProxyException

Description copied from interface: ServerProxy

Notifies the server that the user has played a year of plenty card

Specified by:

yearOfPlentyCard in interface ServerProxy

Parameters:

resource1 - The first chosen resource

resource2 - The second chosen resource

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

roadBuildingCard

public GameModel roadBuildingCard(Coordinate start1,
                                  Coordinate end1,
                                  Coordinate start2,
                                  Coordinate end2)
                           throws ServerProxyException

Description copied from interface: ServerProxy

Notifies the server that the user has played a road building card

Specified by:

roadBuildingCard in interface ServerProxy

Parameters:

start1 - The start coordinate of the first road

end1 - The end coordinate of the first road

start2 - The start location of the second road

end2 - The end location of the second road

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

soldierCard

public GameModel soldierCard(int victimIndex,
                             Coordinate location)
                      throws ServerProxyException

Description copied from interface: ServerProxy

Notifies the server that the user has played a soldier card

Specified by:

soldierCard in interface ServerProxy

Parameters:

victimIndex - The index of the player who is being robbed

location - The new location of the robber

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

monopolyCard

public GameModel monopolyCard(ResourceType resource)
                       throws ServerProxyException

Description copied from interface: ServerProxy

Notifies the server that the user has played a monopoly card

Specified by:

monopolyCard in interface ServerProxy

Parameters:

resource - The resource that the player has chosen to have a monopoly on

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

monumentCard

public GameModel monumentCard()
                       throws ServerProxyException

Description copied from interface: ServerProxy

Notifies the server that the user has played a monument card

Specified by:

monumentCard in interface ServerProxy

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

buildRoad

public GameModel buildRoad(Coordinate start,
                           Coordinate end,
                           boolean free)
                    throws ServerProxyException

Description copied from interface: ServerProxy

Notifies the server that the user has decided to build a road

Specified by:

buildRoad in interface ServerProxy

Parameters:

start - the Coordinate where the road starts

end - the Coordinate where the road ends

free - Whether this road was free (only true during the set up phases)

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

buildSettlement

public GameModel buildSettlement(Coordinate location,
                                 boolean free)
                          throws ServerProxyException

Description copied from interface: ServerProxy

Notifies the server that the user has decided to build a settlement

Specified by:

buildSettlement in interface ServerProxy

Parameters:

location - The vertex coordinate of the settlement

free - Whether this settlement was free (only true during the set up phases)

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

buildCity

public GameModel buildCity(Coordinate location)
                    throws ServerProxyException

Description copied from interface: ServerProxy

Notifies the server that the user has decided to build a city

Specified by:

buildCity in interface ServerProxy

Parameters:

location - The vertex location of the city

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

offerTrade

public GameModel offerTrade(java.util.List<java.lang.Integer> resourceList,
                            int receiver)
                     throws ServerProxyException

Description copied from interface: ServerProxy

Notifies the server that the user has decided to offer a trade to another player

Specified by:

offerTrade in interface ServerProxy

Parameters:

resourceList - A list of the resources that the user wishes to trade, in this order: brick, ore, sheep, wheat, and wood. Negative values denotes that this user will give these resources, and positive values denote the resources that will be received

receiver - The index of the player who will receive this trade offer

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

acceptTrade

public GameModel acceptTrade(boolean willAccept)
                      throws ServerProxyException

Description copied from interface: ServerProxy

Notifies the server whether this player has decided to accept or reject a trade

Specified by:

acceptTrade in interface ServerProxy

Parameters:

willAccept - true if the user will accept the trade, false if not

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

maritimeTrade

public GameModel maritimeTrade(int ratio,
                               ResourceType inputResource,
                               ResourceType outputResource)
                        throws ServerProxyException

Description copied from interface: ServerProxy

Notifies the server that the user has decided to initiate a maritime trade

Specified by:

maritimeTrade in interface ServerProxy

Parameters:

ratio - The ratio of resources demanded by the harbor

inputResource - The resources traded away

outputResource - The resource received

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

discardCards

public GameModel discardCards(java.util.List<java.lang.Integer> resourceList)
                       throws ServerProxyException

Description copied from interface: ServerProxy

Notifies the server that the user has discarded cards

Specified by:

discardCards in interface ServerProxy

Parameters:

resourceList - A list of integers that denotes how many of each resource the user will discard. The order is brick, ore, sheep, wheat, and wood

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

doJSONPost

private java.lang.String doJSONPost(java.lang.String urlPath,
                                    java.lang.String postData,
                                    boolean getUserCookie,
                                    boolean getGameCookie)
                             throws ServerProxyException

Throws:

ServerProxyException

doJSONGet

private java.lang.String doJSONGet(java.lang.String urlPath)
                            throws ServerProxyException

Throws:

ServerProxyException

getUserCookie

public UserCookie getUserCookie()

Gets the user cookie

Returns:

the user cookie

clearCookies

public void clearCookies()

FOR DEBUGGING ONLY TODO make private for distro Clears all cookies