wcg.main

Class Manager

java.lang.Object

wcg.main.Manager

public class Manager
extends java.lang.Object

An instance of this class is responsible for managing users and game instances.

The methods of this class are those needed by web client thus it follows the Facade design pattern. It also follows the Singleton design pattern to provide a single instance of this class to the application.

Author:

José Paulo Leal jpleal@fc.up.pt

Method Summary

Modifier and Type	Method and Description
void	addBotPlayer(java.lang.String gameId) Add a bot to the given game instance.
void	addPlayer(java.lang.String gameId, java.lang.String nick, java.lang.String password) Add a player to a given game instance.
java.lang.String	createGame(java.lang.String name) Create a new game instance of the game with given name.
java.util.List<GameInfo>	getAvailableGameInfos() A list with information on games available to be played.
java.util.List<java.lang.String>	getGameNames() A list of available game names, required to create a new game instance.
(package private) static Manager	getInstance() Single instance of this class.
java.util.List<GameEvent>	getRecentEvents(java.lang.String nick, java.lang.String password) Get a list of recent events sent to the given user by game instances.
void	playCards(java.lang.String gameId, java.lang.String nick, java.lang.String password, java.util.List<Card> cards) Play cards on a game on behalf of an authenticated user.
void	registerPlayer(java.lang.String nick, java.lang.String password) Register a human player (an user) to participate in card games.
(package private) void	reset() Resets manager's fields to enable unit testing.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

static Manager getInstance()
                    throws CardGameException

Single instance of this class.

Returns:

singleton.

Throws:

CardGameException - if an error occurs in the instantiation of the UserPool

reset

void reset()

Resets manager's fields to enable unit testing. This method must only be used during testing and shoudn't be public.

getGameNames

public java.util.List<java.lang.String> getGameNames()

A list of available game names, required to create a new game instance.

Returns:

list of game names.

createGame

public java.lang.String createGame(java.lang.String name)
                            throws CardGameException

Create a new game instance of the game with given name. The game name must be one in the list returned by getGameNames().

Parameters:

name - of game.

Returns:

a game instance id.

Throws:

CardGameException - if name is invalid.

getAvailableGameInfos

public java.util.List<GameInfo> getAvailableGameInfos()

A list with information on games available to be played. Information on games includes their gameId, required join and play in a specific game instance.

Returns:

list of games.

registerPlayer

public void registerPlayer(java.lang.String nick,
                           java.lang.String password)
                    throws CardGameException

Register a human player (an user) to participate in card games.

Parameters:

nick - of player

password - of player

Throws:

CardGameException - if user exists, or if either nick or password are null.

addPlayer

public void addPlayer(java.lang.String gameId,
                      java.lang.String nick,
                      java.lang.String password)
               throws CardGameException

Add a player to a given game instance. The player must have been previously registered, and the game must be accepting players, otherwise and exception is raised. The game will automatically start when the required number of players is added to the game.

Parameters:

gameId - of game instance to join.

nick - of player.

password - of player.

Throws:

CardGameException - if gameId is invalid or player authentication failed.

addBotPlayer

public void addBotPlayer(java.lang.String gameId)
                  throws CardGameException

Add a bot to the given game instance. Adding a bot will allow users to play, event if other human opponents are not available. The game will automatically start when the required number of players is added to the game.

Parameters:

gameId - of game instance to add player.

Throws:

CardGameException - if gameId is invalid.

playCards

public void playCards(java.lang.String gameId,
                      java.lang.String nick,
                      java.lang.String password,
                      java.util.List<Card> cards)
               throws CardGameException

Play cards on a game on behalf of an authenticated user.

Parameters:

gameId - of game instance.

nick - of player.

password - of players.

cards - to play.

Throws:

CardGameException - if gameId is invalid, authentication fails, or given cards cannot be played

getRecentEvents

public java.util.List<GameEvent> getRecentEvents(java.lang.String nick,
                                                 java.lang.String password)
                                          throws CardGameException

Get a list of recent events sent to the given user by game instances. This list may contain multiple events, sent from multiple game instances. The returned events will not returned again by this method.

Parameters:

nick - of player.

password - of player.

Returns:

list of events.

Throws:

CardGameException - if authentication fails.