net.sf.freecol.common.networking

Class CurrentPlayerNetworkRequestHandler

java.lang.Object

net.sf.freecol.server.control.FreeColServerHolder

net.sf.freecol.common.networking.CurrentPlayerNetworkRequestHandler

All Implemented Interfaces:

NetworkRequestHandler

public abstract class CurrentPlayerNetworkRequestHandler
extends FreeColServerHolder
implements NetworkRequestHandler

A network request handler for the current player will automatically return an error ("not your turn") if called by a connection other than that of the currently active player. If no game is active or if the player is unknown the same error is returned.

Constructor Summary

Constructors

Constructor and Description
CurrentPlayerNetworkRequestHandler(FreeColServer freeColServer) Create a new current player request handler.

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Element	handle(Connection conn, org.w3c.dom.Element element) Handle a request represented by an Element and return another Element or null as the answer.
protected abstract org.w3c.dom.Element	handle(Player player, Connection conn, org.w3c.dom.Element element) Handle a request for the current player.
private boolean	isCurrentPlayer(Player player) Check if a player is the current player.

Methods inherited from class net.sf.freecol.server.control.FreeColServerHolder

getFreeColServer, getGame

Methods inherited from class java.lang.Object

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

Constructor Detail

CurrentPlayerNetworkRequestHandler

public CurrentPlayerNetworkRequestHandler(FreeColServer freeColServer)

Create a new current player request handler.

Parameters:

freeColServer - The enclosing FreeColServer.

Method Detail

isCurrentPlayer

private boolean isCurrentPlayer(Player player)

Check if a player is the current player.

Parameters:

player - The Player to check.

Returns:

true if a game is active and the player is the current one.

handle

public final org.w3c.dom.Element handle(Connection conn,
                                        org.w3c.dom.Element element)

Handle a request represented by an Element and return another Element or null as the answer.

Specified by:

handle in interface NetworkRequestHandler

Parameters:

conn - The message's Connection.

element - The root Element of the message.

Returns:

The reply Element, which may be null.

handle

protected abstract org.w3c.dom.Element handle(Player player,
                                              Connection conn,
                                              org.w3c.dom.Element element)

Handle a request for the current player.

Parameters:

player - The requesting Player.

conn - The Connection the request originates from.

element - The Element with the request.

Returns:

An answerering Element, which may be null.