com.electrotank.electroserver.plugins
Class AbstractEventHandler

java.lang.Object
  BaseExtension
      com.electrotank.electroserver.plugins.AbstractEventHandler

public abstract class AbstractEventHandler

extends BaseExtension

This abstract class represents either a login or logout event handler. All event handlers (of either type) need to extend AbstractEventHandler.

See Also:

Serialized Form

Constructor Summary

AbstractEventHandler()

Method Summary

abstract void	eventInit(Map parameters) Invoked automatically at server start-up.
EventHelper	getEventHelper() Gets a reference to an EventHelper that can be used to interact with the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEventHandler

public AbstractEventHandler()

Method Detail

eventInit

public abstract void eventInit(Map parameters)
                        throws EventException

Invoked automatically at server start-up. All parameters specified in the configuration.xml file will be passed into this method via the parameters Map.

Parameters:

parameters - A Map containing all the initialization parameters specified in the configuration.xml file.

Throws:

EventException - if any error occurs while using the parameters.

getEventHelper

public EventHelper getEventHelper()

Gets a reference to an EventHelper that can be used to interact with the server.

Returns:

an EventHelper that can be used to interact with the server.