io.nadron.service

Interface GameAdminService

All Known Implementing Classes:

SimpleGameAdminService

public interface GameAdminService

This interface defines methods that are of an Administrative nature. These methods can be used to load and unload games and game rooms.

Author:

Abraham Menacherry

Method Summary

Methods

Modifier and Type	Method and Description
Object	loadGame(long gameId, String gameName) Loads a game based on the game id OR game name.
Object	loadGameRoom(Game game, long gameRoomId, String gameRoomName) Loads a game room based on the game room id OR game name.
boolean	registerGame(Game game) Implementation method will internally add this game instance to a set.
void	shutdown() Unloads all the games and game rooms that is stored in the admin services internal set.
Object	unLoadGame(Game game) Unloads a game based on the game instance passed in.
Object	unLoadGame(long gameId, String gameName) Unloads a game based on the game id OR game name.
Object	unloadGameRoom(Game game, long gameRoomId) Unloads a game room of a game based on the instance of the game, the unique identifier of the game room or the string game room name.
void	unloadGameRoom(GameRoom gameRoom) Unloads a game room based on the game room instance passed in.
Object	unloadGameRoom(Game game, String gameRoomName) Unloads a game room of a game based on the instance of the game and the name of the game room.

Method Detail

registerGame

boolean registerGame(Game game)

Implementation method will internally add this game instance to a set.

Parameters:

game - The game instance to register with the admin service.

Returns:

True if addition is successful, false if a duplicate is present in the set.

loadGame

Object loadGame(long gameId,
              String gameName)

Loads a game based on the game id OR game name. The first preference is to id. The id will be ignored if it is a negative number and game name will be used to retrieve the game.

Parameters:

gameId - The unique number identifier for the game. Most probably a database key.

gameName - The unique name for a game.

Returns:

Optionally returns an object, if it is an asynchronous operation, then it would return a Future object, otherwise it would return a boolean suggesting success or failure.

unLoadGame

Object unLoadGame(long gameId,
                String gameName)

Unloads a game based on the game id OR game name. The first preference is to id. The id will be ignored if it is a negative number and game name will be used to retrieve the game. Side affect will be the closing of any resources, GameRooms or PlayerSessions associated with this game.

Parameters:

gameId - The unique number identifier for the game. Most probably a database key.

gameName - The unique name for a game.

Returns:

Optionally returns an object, if it is an asynchronous operation, then it would return a Future object, otherwise it would return a boolean suggesting success(true) or failure(false).

unLoadGame

Object unLoadGame(Game game)

Unloads a game based on the game instance passed in. Since the instance will internally contain the unique id or String name, this method will delegate to the overloaded method which takes id and String. Side affect will be the closing of any resources, GameRooms or PlayerSessions associated with this game.

Parameters:

game - The instance of the game to unload.

Returns:

Optionally returns an object, if it is an asynchronous operation, then it would return a Future object, otherwise it would return a boolean suggesting success(true) or failure(false).

loadGameRoom

Object loadGameRoom(Game game,
                  long gameRoomId,
                  String gameRoomName)

Loads a game room based on the game room id OR game name. The first preference is to id. The id will be ignored if it is a negative number and game room name will be used to retrieve the game room.

Parameters:

game - The game for which the game room need to be loaded.

gameRoomId - The unique identifier for the game room. Most probably a database id.

gameRoomName - The name of the game room to load.

Returns:

Optionally returns an object, if it is an asynchronous operation, then it would return a Future object, otherwise it would return a boolean suggesting success(true) or failure(false).

unloadGameRoom

void unloadGameRoom(GameRoom gameRoom)

Unloads a game room based on the game room instance passed in. Since the instance will internally contain the unique id or String name, this method will delegate to the overloaded method which takes id and String. Side affect will be the closing of any resources like PlayerSessions associated with this game room.

Parameters:

gameRoom - The game room instance which is to be unloaded.

unloadGameRoom

Object unloadGameRoom(Game game,
                    long gameRoomId)

Unloads a game room of a game based on the instance of the game, the unique identifier of the game room or the string game room name. Side affect will be the closing of any resources like PlayerSessions associated with this game room.

Parameters:

game - The instance of the game for which the game room needs to be removed.

gameRoomId - The unique identifier for the game room. Most probably a database id.

Returns:

Optionally returns an object, if it is an asynchronous operation, then it would return a Future object, otherwise it would return a boolean suggesting success(true) or failure(false).

unloadGameRoom

Object unloadGameRoom(Game game,
                    String gameRoomName)

Unloads a game room of a game based on the instance of the game and the name of the game room. Side affect will be the closing of any resources like PlayerSessions associated with this game room.

Parameters:

game - The instance of the game for which the game room needs to be removed

gameRoomName - The name of the game room to unload.

Returns:

Optionally returns an object, if it is an asynchronous operation, then it would return a Future object, otherwise it would return a boolean suggesting success(true) or failure(false).

shutdown

void shutdown()

Unloads all the games and game rooms that is stored in the admin services internal set.