client.networking

Class RealEarlyServerProxy

java.lang.Object

client.networking.RealEarlyServerProxy

All Implemented Interfaces:

EarlyServerProxy

public class RealEarlyServerProxy
extends java.lang.Object
implements EarlyServerProxy

Author:

pbridd

Field Summary

Fields

Modifier and Type	Field and Description
private Deserializer	deserializer
private int	gameID
private java.lang.String	HTTP_GET
private java.lang.String	HTTP_POST
private Serializer	serializer
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
RealEarlyServerProxy() Default constructor.
RealEarlyServerProxy(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
NetGameModel	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
NetGameModel	buildCity(VertexLocation vertexLocation) Notifies the server that the user has decided to build a city
NetGameModel	buildRoad(EdgeLocation edgeLocation, boolean free) Notifies the server that the user has decided to build a road
NetGameModel	buildSettlement(VertexLocation vertexLocation, boolean free) Notifies the server that the user has decided to build a settlement
NetGameModel	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
NetGame	createGame(boolean randomTiles, boolean randomNumbers, boolean randomPorts, java.lang.String name) Creates a game on the server
NetGameModel	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)
NetGameModel	finishTurn() Notifies the server that the user has finished his turn
NetGameModel	getGameModel() 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<NetGame>	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.
NetGameModel	maritimeTrade(int ratio, ResourceType inputResource, ResourceType outputResource) Notifies the server that the user has decided to initiate a maritime trade
NetGameModel	monopolyCard(ResourceType resource) Notifies the server that the user has played a monopoly card
NetGameModel	monumentCard() Notifies the server that the user has played a monument card
NetGameModel	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
NetGameModel	roadBuildingCard(EdgeLocation location1, EdgeLocation location2) Notifies the server that the user has played a road building card
NetGameModel	robPlayer(int victimIndex, HexLocation location) Notifies the server that the user has decided to rob another player
NetGameModel	rollNumber(int roll) Reports the result of a dice roll to the server
NetGameModel	sendChat(java.lang.String content) Sends a chat message from the specified user to the server
NetGameModel	soldierCard(int victimIndex, HexLocation hexLocation) Notifies the server that the user has played a soldier card
NetGameModel	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

serializer

private Serializer serializer

deserializer

private Deserializer deserializer

userIndex

private int userIndex

userName

private java.lang.String userName

Constructor Detail

RealEarlyServerProxy

public RealEarlyServerProxy()

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

RealEarlyServerProxy

public RealEarlyServerProxy(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 EarlyServerProxy

Returns:

getUserName

public java.lang.String getUserName()
                             throws ServerProxyException

Gets the current user's name

Specified by:

getUserName in interface EarlyServerProxy

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: EarlyServerProxy

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 EarlyServerProxy

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: EarlyServerProxy

Registers a user with the specified username and password

Specified by:

registerUser in interface EarlyServerProxy

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<NetGame> listGames()
                                  throws ServerProxyException

Description copied from interface: EarlyServerProxy

Fetches a list of ongoing games

Specified by:

listGames in interface EarlyServerProxy

Returns:

a list of all ongoing games on the server

Throws:

ServerProxyException

createGame

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

Description copied from interface: EarlyServerProxy

Creates a game on the server

Specified by:

createGame in interface EarlyServerProxy

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 ProxyGame 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 EarlyServerProxy

color - the color the user wishes to represent him

Throws:

ServerProxyException - if something goes wrong

getGameModel

public NetGameModel getGameModel()
                          throws ServerProxyException

Description copied from interface: EarlyServerProxy

Retrieves the game model from the server

Specified by:

getGameModel in interface EarlyServerProxy

Returns:

a NetGameModel object

Throws:

ServerProxyException - if something goes wrong

addAI

public void addAI(AIType aiType)
           throws ServerProxyException

Description copied from interface: EarlyServerProxy

Adds an AI to the game

Specified by:

addAI in interface EarlyServerProxy

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 EarlyServerProxy

Returns:

a list of supported AI player types

Throws:

ServerProxyException - if there is no logged in user

sendChat

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

Description copied from interface: EarlyServerProxy

Sends a chat message from the specified user to the server

Specified by:

sendChat in interface EarlyServerProxy

Parameters:

content - The content of the chat message

Returns:

A NetGameModel object

Throws:

ServerProxyException - if there is no logged in user

rollNumber

public NetGameModel rollNumber(int roll)
                        throws ServerProxyException

Description copied from interface: EarlyServerProxy

Reports the result of a dice roll to the server

Specified by:

rollNumber in interface EarlyServerProxy

Parameters:

roll - The result of the user's roll

Returns:

a NetGameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

robPlayer

public NetGameModel robPlayer(int victimIndex,
                              HexLocation location)
                       throws ServerProxyException

Description copied from interface: EarlyServerProxy

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

Specified by:

robPlayer in interface EarlyServerProxy

Parameters:

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

location - The new hex location of the robber

Returns:

a NetGameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

finishTurn

public NetGameModel finishTurn()
                        throws ServerProxyException

Description copied from interface: EarlyServerProxy

Notifies the server that the user has finished his turn

Specified by:

finishTurn in interface EarlyServerProxy

Returns:

a NetGameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

buyDevCard

public NetGameModel buyDevCard()
                        throws ServerProxyException

Description copied from interface: EarlyServerProxy

Notifies the server that the user has bought a development card

Specified by:

buyDevCard in interface EarlyServerProxy

Returns:

a NetGameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

yearOfPlentyCard

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

Description copied from interface: EarlyServerProxy

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

Specified by:

yearOfPlentyCard in interface EarlyServerProxy

Parameters:

resource1 - The first chosen resource

resource2 - The second chosen resource

Returns:

a NetGameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

roadBuildingCard

public NetGameModel roadBuildingCard(EdgeLocation location1,
                                     EdgeLocation location2)
                              throws ServerProxyException

Description copied from interface: EarlyServerProxy

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

Specified by:

roadBuildingCard in interface EarlyServerProxy

Parameters:

location1 - The EdgeLocation location of the first road

location2 - The EdgeLocation location of the second card

Returns:

a NetGameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

soldierCard

public NetGameModel soldierCard(int victimIndex,
                                HexLocation hexLocation)
                         throws ServerProxyException

Description copied from interface: EarlyServerProxy

Notifies the server that the user has played a soldier card

Specified by:

soldierCard in interface EarlyServerProxy

Parameters:

victimIndex - The index of the player who is being robbed

hexLocation - The new hex location of the robber

Returns:

a NetGameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

monopolyCard

public NetGameModel monopolyCard(ResourceType resource)
                          throws ServerProxyException

Description copied from interface: EarlyServerProxy

Notifies the server that the user has played a monopoly card

Specified by:

monopolyCard in interface EarlyServerProxy

Parameters:

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

Returns:

a NetGameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

monumentCard

public NetGameModel monumentCard()
                          throws ServerProxyException

Description copied from interface: EarlyServerProxy

Notifies the server that the user has played a monument card

Specified by:

monumentCard in interface EarlyServerProxy

Returns:

a NetGameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

buildRoad

public NetGameModel buildRoad(EdgeLocation edgeLocation,
                              boolean free)
                       throws ServerProxyException

Description copied from interface: EarlyServerProxy

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

Specified by:

buildRoad in interface EarlyServerProxy

Parameters:

edgeLocation - The edge location of the road

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

Returns:

a NetGameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

buildSettlement

public NetGameModel buildSettlement(VertexLocation vertexLocation,
                                    boolean free)
                             throws ServerProxyException

Description copied from interface: EarlyServerProxy

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

Specified by:

buildSettlement in interface EarlyServerProxy

Parameters:

vertexLocation - The vertex location of the settlement

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

Returns:

a NetGameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

buildCity

public NetGameModel buildCity(VertexLocation vertexLocation)
                       throws ServerProxyException

Description copied from interface: EarlyServerProxy

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

Specified by:

buildCity in interface EarlyServerProxy

Parameters:

vertexLocation - The vertex location of the city

Returns:

a NetGameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

offerTrade

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

Description copied from interface: EarlyServerProxy

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

Specified by:

offerTrade in interface EarlyServerProxy

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 NetGameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

acceptTrade

public NetGameModel acceptTrade(boolean willAccept)
                         throws ServerProxyException

Description copied from interface: EarlyServerProxy

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

Specified by:

acceptTrade in interface EarlyServerProxy

Parameters:

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

Returns:

a NetGameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

maritimeTrade

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

Description copied from interface: EarlyServerProxy

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

Specified by:

maritimeTrade in interface EarlyServerProxy

Parameters:

ratio - The ratio of resources demanded by the harbor

inputResource - The resources traded away

outputResource - The resource received

Returns:

a NetGameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

discardCards

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

Description copied from interface: EarlyServerProxy

Notifies the server that the user has discarded cards

Specified by:

discardCards in interface EarlyServerProxy

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 NetGameModel 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