client.networking

Interface ServerProxy

All Known Implementing Classes:

GSONServerProxy

public interface ServerProxy

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
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
GameModel	finishTurn() Notifies the server that the user has finished his turn
GameModel	getGameModel(int version) Retrieves the game model from the server
int	getUserId() Gets the player ID
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

Method Detail

loginUser

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

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

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

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

Registers a user with the specified username and password

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

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

Fetches a list of ongoing games

Returns:

a list of all ongoing games on the server

Throws:

ServerProxyException

getUserName

java.lang.String getUserName()
                      throws ServerProxyException

Gets the current user's name

Returns:

Throws:

ServerProxyException - if not logged in

getUserId

int getUserId()

Gets the player ID

Returns:

createGame

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

Creates a game on the server

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

void joinGame(int id,
              CatanColor color)
       throws ServerProxyException

Parameters:

color - the color the user wishes to represent him

Throws:

ServerProxyException - if something goes wrong

getGameModel

GameModel getGameModel(int version)
                throws ServerProxyException

Retrieves the game model from the server

Parameters:

version - the current version of the model in the client

Returns:

a GameModel object

Throws:

ServerProxyException - if something goes wrong

addAI

void addAI(AIType aiType)
    throws ServerProxyException

Adds an AI to the game

Parameters:

aiType - the type of AI the user wishes to add

Throws:

ServerProxyException - if there is no logged in user

listAI

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

Returns:

a list of supported AI player types

Throws:

ServerProxyException - if there is no logged in user

sendChat

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

Sends a chat message from the specified user to the server

Parameters:

content - The content of the chat message

Returns:

A GameModel object

Throws:

ServerProxyException - if there is no logged in user

rollNumber

GameModel rollNumber(int roll)
              throws ServerProxyException

Reports the result of a dice roll to the server

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

GameModel robPlayer(int victimIndex,
                    Coordinate location)
             throws ServerProxyException

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

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

GameModel finishTurn()
              throws ServerProxyException

Notifies the server that the user has finished his turn

Parameters:

user - The User who has finished his turn

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

buyDevCard

GameModel buyDevCard()
              throws ServerProxyException

Notifies the server that the user has bought a development card

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

yearOfPlentyCard

GameModel yearOfPlentyCard(ResourceType resource1,
                           ResourceType resource2)
                    throws ServerProxyException

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

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

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

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

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

GameModel soldierCard(int victimIndex,
                      Coordinate location)
               throws ServerProxyException

Notifies the server that the user has played a soldier card

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

GameModel monopolyCard(ResourceType resource)
                throws ServerProxyException

Notifies the server that the user has played a monopoly card

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

GameModel monumentCard()
                throws ServerProxyException

Notifies the server that the user has played a monument card

Returns:

a GameModel object that reflects the current state of the Game

Throws:

ServerProxyException - if there is no logged in user

buildRoad

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

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

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

GameModel buildSettlement(Coordinate location,
                          boolean free)
                   throws ServerProxyException

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

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

GameModel buildCity(Coordinate location)
             throws ServerProxyException

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

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

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

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

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

GameModel acceptTrade(boolean willAccept)
               throws ServerProxyException

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

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

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

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

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

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

Notifies the server that the user has discarded cards

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