atavism.server.plugins

Class ModeratorPlugin

java.lang.Object

atavism.server.engine.EnginePlugin

atavism.server.plugins.ModeratorPlugin

All Implemented Interfaces:

MessageCallback, MessageDispatch, StatusMapCallback, TcpAcceptCallback

public class ModeratorPlugin
extends EnginePlugin
implements TcpAcceptCallback

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModeratorPlugin.GetModeratorResponseMessage Message to return Moderator Data properties.
static class	ModeratorPlugin.ModeratorMessage Message to Request Moderator data using the given properties.
protected class	ModeratorPlugin.SocketHandler

Nested classes/interfaces inherited from class atavism.server.engine.EnginePlugin

EnginePlugin.DeleteHook, EnginePlugin.DeleteSubObjHook, EnginePlugin.GenerateSubObjectHook, EnginePlugin.GetPropertyMessage, EnginePlugin.GetPropertyNamesMessage, EnginePlugin.LoadHook, EnginePlugin.LoadSubObjHook, EnginePlugin.PluginActivateHook, EnginePlugin.PluginStateMessage, EnginePlugin.SaveHook, EnginePlugin.SaveSubObjHook, EnginePlugin.SetPropertyMessage, EnginePlugin.SubObjData, EnginePlugin.TransferFilter, EnginePlugin.TransferObjectMessage, EnginePlugin.UnloadHook, EnginePlugin.UnloadSubObjHook

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	log
static int	LOGIN_IDLE_TIMEOUT
static int	MSGCODE_REQEST
static int	MSGCODE_RESPONSE
static int	PREFAB_MAX_INCOMING_MESSAGE_LENGTH maximum incoming message length
static boolean	SecureToken The master server sends us the account id in a secure manner by default.
static long	TokenValidTime
static java.lang.Integer	WorldId If WorldId is set, the ModeratorPlugin only accepts master tokens that specify the correct world id.

Fields inherited from class atavism.server.engine.EnginePlugin

DevMode, dumpAllThreadSubscription, dumpAllThreadSubscriptionLock, lock, MSG_TYPE_DUMP_ALL_THREAD_STACKS, MSG_TYPE_GET_PROPERTY, MSG_TYPE_GET_PROPERTY_NAMES, MSG_TYPE_PLUGIN_STATE, MSG_TYPE_RELOAD_TEMPLATES, MSG_TYPE_SET_PROPERTY, MSG_TYPE_SET_PROPERTY_NONBLOCK, MSG_TYPE_TRANSFER_OBJECT, pluginStateSubscription, propertySubscription, selectionFilter, selectionSubscription, subObjectSubscription

Fields inherited from interface atavism.msgsys.MessageCallback

NO_FLAGS, RESPONSE_EXPECTED

Constructor Summary

Constructors

Constructor and Description
ModeratorPlugin()

Method Summary

Modifier and Type	Method and Description
int	getTCPPort() This method returns the port the prefab plugin will listen to for incoming tcp connection.
protected ModeratorPlugin.GetModeratorResponseMessage	handleMessage(ModeratorPlugin.ModeratorMessage message, ModeratorPlugin.SocketHandler clientSocket) Respond to a Moderator data request from the client.
void	onActivate() for developers extending the EnginePlugin object, it may be easier to use the onActivate() method which gets called when the plugin is being activated by the Engine.
void	onTcpAccept(java.nio.channels.SocketChannel clientSocket)
void	setTCPPort(int port) Set the port the Moderator plugin will listen to for incoming tcp connection.

Methods inherited from class atavism.server.engine.EnginePlugin

activate, createMBeanInstance, createSubscription, getHookManager, getName, getObjectLockManager, getObjectProperties, getObjectProperties, getObjectProperty, getObjectPropertyNames, getPercentCPULoad, getPluginAvailable, getPluginInfo, getPluginNamespaces, getPluginState, getPluginStatus, getPluginType, getPropertyImpl, getPropertyNamesImpl, getStatusMap, handleMessage, handleMessageImpl, logDepsOutstanding, processKeysAndValues, registerActivateHook, registerDeleteHook, registerLoadHook, registerPluginNamespace, registerPluginNamespaces, registerPluginNamespaces, registerPluginNamespaces, registerSaveHook, registerTransferHook, registerUnloadHook, ReloadTemplates, sendSubObjectResponse, sendSubObjectResponse, sendSubObjectResponse, setName, setObjectProperties, setObjectProperties, setObjectProperties, setObjectPropertiesNoResponse, setObjectPropertiesNoResponse, setObjectPropertiesNoResponse, setObjectProperty, setObjectPropertyNoResponse, setPercentCPULoad, setPluginAvailable, setPluginInfo, setPluginType, setPropertyImpl, transferObject

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final Logger log

MSGCODE_REQEST

public static final int MSGCODE_REQEST

See Also:

Constant Field Values

MSGCODE_RESPONSE

public static final int MSGCODE_RESPONSE

See Also:

Constant Field Values

LOGIN_IDLE_TIMEOUT

public static final int LOGIN_IDLE_TIMEOUT

See Also:

Constant Field Values

PREFAB_MAX_INCOMING_MESSAGE_LENGTH

public static int PREFAB_MAX_INCOMING_MESSAGE_LENGTH

maximum incoming message length

SecureToken

public static boolean SecureToken

The master server sends us the account id in a secure manner by default. If clients bypass the master server, set this to false. This allows people to masquerade as others and should only be used for development purposes.

TokenValidTime

public static long TokenValidTime

WorldId

public static java.lang.Integer WorldId

If WorldId is set, the ModeratorPlugin only accepts master tokens that specify the correct world id.

Constructor Detail

ModeratorPlugin

public ModeratorPlugin()

Method Detail

setTCPPort

public void setTCPPort(int port)

Set the port the Moderator plugin will listen to for incoming tcp connection.

Parameters:

port - the port number used for incoming tcp connections

getTCPPort

public int getTCPPort()

This method returns the port the prefab plugin will listen to for incoming tcp connection.

Returns:

the tcp port number

See Also:

setTCPPort(int)

onActivate

public void onActivate()

Description copied from class: EnginePlugin

for developers extending the EnginePlugin object, it may be easier to use the onActivate() method which gets called when the plugin is being activated by the Engine. this is an alternative to calling registerActivateHook()

Overrides:

onActivate in class EnginePlugin

onTcpAccept

public void onTcpAccept(java.nio.channels.SocketChannel clientSocket)

Specified by:

onTcpAccept in interface TcpAcceptCallback

handleMessage

protected ModeratorPlugin.GetModeratorResponseMessage handleMessage(ModeratorPlugin.ModeratorMessage message,
                                                                    ModeratorPlugin.SocketHandler clientSocket)

Respond to a Moderator data request from the client. The message contains the desired Moderator properties.

Implementations must not read or write data to the clientSocket.