net.sf.freecol.server.control

Class InputHandler

java.lang.Object

net.sf.freecol.server.control.FreeColServerHolder

net.sf.freecol.server.control.InputHandler

All Implemented Interfaces:

MessageHandler

Direct Known Subclasses:

InGameInputHandler, PreGameInputHandler

public abstract class InputHandler
extends FreeColServerHolder
implements MessageHandler

Handles the network messages.

See Also:

Controller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	InputHandler.DisconnectHandler

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,NetworkRequestHandler>	_handlerMap The handler map provides named handlers for network requests.
private static java.util.logging.Logger	logger

Constructor Summary

Constructors

Constructor and Description
InputHandler(FreeColServer freeColServer) The constructor to use.

Method Summary

Modifier and Type	Method and Description
protected org.w3c.dom.Element	createErrorReply(java.lang.String message) Create a reply message with an error.
org.w3c.dom.Element	handle(Connection connection, org.w3c.dom.Element element) Deals with incoming messages that have just been received.
protected abstract org.w3c.dom.Element	logout(Connection connection, org.w3c.dom.Element element) Handles a "logout"-message.
protected void	register(java.lang.String name, NetworkRequestHandler handler) Register a network request handler.
private void	sendReconnectSafely(Connection connection) Send a reconnect message ignoring (but logging) IO errors.
protected boolean	unregister(java.lang.String name, NetworkRequestHandler handler) Unregister a network request handler.

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

Field Detail

logger

private static final java.util.logging.Logger logger

_handlerMap

private final java.util.Map<java.lang.String,NetworkRequestHandler> _handlerMap

The handler map provides named handlers for network requests. Each handler deals with a given request type.

Constructor Detail

InputHandler

public InputHandler(FreeColServer freeColServer)

The constructor to use.

Parameters:

freeColServer - The main server object.

Method Detail

register

protected final void register(java.lang.String name,
                              NetworkRequestHandler handler)

Register a network request handler.

Parameters:

name - The name.

handler - The handler.

unregister

protected final boolean unregister(java.lang.String name,
                                   NetworkRequestHandler handler)

Unregister a network request handler.

Parameters:

name - The name.

handler - The handler.

Returns:

True if the supplied handler was actually removed.

handle

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

Deals with incoming messages that have just been received.

Specified by:

handle in interface MessageHandler

Parameters:

connection - The Connection the message was received on.

element - The root element of the message.

Returns:

The reply.

sendReconnectSafely

private void sendReconnectSafely(Connection connection)

Send a reconnect message ignoring (but logging) IO errors.

Parameters:

connection - The connection.

createErrorReply

protected org.w3c.dom.Element createErrorReply(java.lang.String message)

Create a reply message with an error. FIXME: should this be localized (return message name)?

Parameters:

message - The error message.

Returns:

An error message.

logout

protected abstract org.w3c.dom.Element logout(Connection connection,
                                              org.w3c.dom.Element element)

Handles a "logout"-message.

Parameters:

connection - The Connection the message was received on.

element - The Element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

The reply.