atavism.agis.plugins

Class PrefabPlugin

java.lang.Object

atavism.server.engine.EnginePlugin

atavism.agis.plugins.PrefabPlugin

All Implemented Interfaces:

MessageCallback, StatusMapCallback, TcpAcceptCallback

public class PrefabPlugin
extends EnginePlugin
implements TcpAcceptCallback

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrefabPlugin.GetIconPrefabMessage
static class	PrefabPlugin.GetIconPrefabResponseMessage Message to return Icon Prefab Data properties.
static class	PrefabPlugin.GetPrefabMessage Message to Request Prefab data using the given properties.
static class	PrefabPlugin.GetPrefabResponseMessage Message to return Prefab Data properties.
protected class	PrefabPlugin.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_ICON_PREFAB_REQEST
static int	MSGCODE_ICON_PREFAB_RESPONSE
static int	MSGCODE_PREFAB_REQEST
static int	MSGCODE_PREFAB_RESPONSE
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 PrefabPlugin only accepts master tokens that specify the correct world id.

Fields inherited from class atavism.server.engine.EnginePlugin

deleteSubObjectSubscription, dumpAllThreadSubscription, dumpAllThreadSubscriptionLock, loadSubObjectSubscription, lock, MSG_TYPE_DUMP_ALL_THREAD_STACKS, MSG_TYPE_GET_PROPERTY, MSG_TYPE_GET_PROPERTY_NAMES, MSG_TYPE_PLUGIN_STATE, MSG_TYPE_SET_PROPERTY, MSG_TYPE_SET_PROPERTY_NONBLOCK, MSG_TYPE_TRANSFER_OBJECT, pluginStateSubscription, propertySubscription, saveSubObjectSubscription, selectionFilter, selectionSubscription, setSubObjectPersistenceSubscription, subObjectSubscription, unloadSubObjectSubscription

Fields inherited from interface atavism.msgsys.MessageCallback

NO_FLAGS, RESPONSE_EXPECTED

Constructor Summary

Constructors

Constructor and Description
PrefabPlugin()

Method Summary

Modifier and Type	Method and Description
void	dbConnect() This method connects to the database.
int	getTCPPort() This method returns the port the prefab plugin will listen to for incoming tcp connection.
protected PrefabPlugin.GetIconPrefabResponseMessage	handleGetIconPrefabMessage(PrefabPlugin.GetIconPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
protected PrefabPlugin.GetPrefabResponseMessage	handleGetPrefabMessage(PrefabPlugin.GetPrefabMessage message, PrefabPlugin.SocketHandler clientSocket) Respond to a prefab data request from the client.
protected java.util.Map<java.lang.String,java.io.Serializable>	loadAbilityIconPrefabData(PrefabPlugin.GetIconPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
protected java.util.Map<java.lang.String,java.io.Serializable>	loadAbilityPrefabData(PrefabPlugin.GetPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
protected java.util.Map<java.lang.String,java.io.Serializable>	loadBuildingObjectIconPrefabData(PrefabPlugin.GetIconPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
protected java.util.Map<java.lang.String,java.io.Serializable>	loadBuildingObjectPrefabData(PrefabPlugin.GetPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
protected java.util.Map<java.lang.String,java.io.Serializable>	loadCraftingRecipeIconPrefabData(PrefabPlugin.GetIconPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
protected java.util.Map<java.lang.String,java.io.Serializable>	loadCraftingRecipePrefabData(PrefabPlugin.GetPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
protected java.util.Map<java.lang.String,java.io.Serializable>	loadCurrencyIconPrefabData(PrefabPlugin.GetIconPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
protected java.util.Map<java.lang.String,java.io.Serializable>	loadCurrencyPrefabData(PrefabPlugin.GetPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
protected java.util.Map<java.lang.String,java.io.Serializable>	loadEffectIconPrefabData(PrefabPlugin.GetIconPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
protected java.util.Map<java.lang.String,java.io.Serializable>	loadEffectPrefabData(PrefabPlugin.GetPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
protected java.util.Map<java.lang.String,java.io.Serializable>	loadItemIconPrefabData(PrefabPlugin.GetIconPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
protected java.util.Map<java.lang.String,java.io.Serializable>	loadItemPrefabData(PrefabPlugin.GetPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
protected java.util.Map<java.lang.String,java.io.Serializable>	loadItemSetPrefabData(PrefabPlugin.GetPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
protected java.util.Map<java.lang.String,java.io.Serializable>	loadSkillIconPrefabData(PrefabPlugin.GetIconPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
protected java.util.Map<java.lang.String,java.io.Serializable>	loadSkillPrefabData(PrefabPlugin.GetPrefabMessage message, PrefabPlugin.SocketHandler clientSocket)
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)
protected boolean	setProxyProperties(java.util.Map<java.lang.String,java.io.Serializable> props, PluginStatus proxy) Use the information in the plugin status's info field to tell the client what the external address is for the proxy plugin.
void	setTCPPort(int port) Set the port the prefab plugin will listen to for incoming tcp connection.

Methods inherited from class atavism.server.engine.EnginePlugin

activate, createMBeanInstance, createSubscription, getHookManager, getMessageHandler, 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, sendSubObjectResponse, sendSubObjectResponse, sendSubObjectResponse, setMessageHandler, 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_PREFAB_REQEST

public static final int MSGCODE_PREFAB_REQEST

See Also:

Constant Field Values

MSGCODE_PREFAB_RESPONSE

public static final int MSGCODE_PREFAB_RESPONSE

See Also:

Constant Field Values

MSGCODE_ICON_PREFAB_REQEST

public static final int MSGCODE_ICON_PREFAB_REQEST

See Also:

Constant Field Values

MSGCODE_ICON_PREFAB_RESPONSE

public static final int MSGCODE_ICON_PREFAB_RESPONSE

See Also:

Constant Field Values

LOGIN_IDLE_TIMEOUT

public static final int LOGIN_IDLE_TIMEOUT

See Also:

Constant Field Values

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 PrefabPlugin only accepts master tokens that specify the correct world id.

Constructor Detail

PrefabPlugin

public PrefabPlugin()

Method Detail

dbConnect

public void dbConnect()

This method connects to the database. It assumes the host, user, and port have already been set.

setTCPPort

public void setTCPPort(int port)

Set the port the prefab 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

handleGetPrefabMessage

protected PrefabPlugin.GetPrefabResponseMessage handleGetPrefabMessage(PrefabPlugin.GetPrefabMessage message,
                                                                       PrefabPlugin.SocketHandler clientSocket)

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

Implementations must not read or write data to the clientSocket.

loadItemPrefabData

protected java.util.Map<java.lang.String,java.io.Serializable> loadItemPrefabData(PrefabPlugin.GetPrefabMessage message,
                                                                                  PrefabPlugin.SocketHandler clientSocket)

loadCraftingRecipePrefabData

protected java.util.Map<java.lang.String,java.io.Serializable> loadCraftingRecipePrefabData(PrefabPlugin.GetPrefabMessage message,
                                                                                            PrefabPlugin.SocketHandler clientSocket)

loadCurrencyPrefabData

protected java.util.Map<java.lang.String,java.io.Serializable> loadCurrencyPrefabData(PrefabPlugin.GetPrefabMessage message,
                                                                                      PrefabPlugin.SocketHandler clientSocket)

loadItemSetPrefabData

protected java.util.Map<java.lang.String,java.io.Serializable> loadItemSetPrefabData(PrefabPlugin.GetPrefabMessage message,
                                                                                     PrefabPlugin.SocketHandler clientSocket)

loadSkillPrefabData

protected java.util.Map<java.lang.String,java.io.Serializable> loadSkillPrefabData(PrefabPlugin.GetPrefabMessage message,
                                                                                   PrefabPlugin.SocketHandler clientSocket)

loadAbilityPrefabData

protected java.util.Map<java.lang.String,java.io.Serializable> loadAbilityPrefabData(PrefabPlugin.GetPrefabMessage message,
                                                                                     PrefabPlugin.SocketHandler clientSocket)

loadEffectPrefabData

protected java.util.Map<java.lang.String,java.io.Serializable> loadEffectPrefabData(PrefabPlugin.GetPrefabMessage message,
                                                                                    PrefabPlugin.SocketHandler clientSocket)

loadBuildingObjectPrefabData

protected java.util.Map<java.lang.String,java.io.Serializable> loadBuildingObjectPrefabData(PrefabPlugin.GetPrefabMessage message,
                                                                                            PrefabPlugin.SocketHandler clientSocket)

handleGetIconPrefabMessage

protected PrefabPlugin.GetIconPrefabResponseMessage handleGetIconPrefabMessage(PrefabPlugin.GetIconPrefabMessage message,
                                                                               PrefabPlugin.SocketHandler clientSocket)

loadItemIconPrefabData

protected java.util.Map<java.lang.String,java.io.Serializable> loadItemIconPrefabData(PrefabPlugin.GetIconPrefabMessage message,
                                                                                      PrefabPlugin.SocketHandler clientSocket)

loadCraftingRecipeIconPrefabData

protected java.util.Map<java.lang.String,java.io.Serializable> loadCraftingRecipeIconPrefabData(PrefabPlugin.GetIconPrefabMessage message,
                                                                                                PrefabPlugin.SocketHandler clientSocket)

loadCurrencyIconPrefabData

protected java.util.Map<java.lang.String,java.io.Serializable> loadCurrencyIconPrefabData(PrefabPlugin.GetIconPrefabMessage message,
                                                                                          PrefabPlugin.SocketHandler clientSocket)

loadSkillIconPrefabData

protected java.util.Map<java.lang.String,java.io.Serializable> loadSkillIconPrefabData(PrefabPlugin.GetIconPrefabMessage message,
                                                                                       PrefabPlugin.SocketHandler clientSocket)

loadAbilityIconPrefabData

protected java.util.Map<java.lang.String,java.io.Serializable> loadAbilityIconPrefabData(PrefabPlugin.GetIconPrefabMessage message,
                                                                                         PrefabPlugin.SocketHandler clientSocket)

loadEffectIconPrefabData

protected java.util.Map<java.lang.String,java.io.Serializable> loadEffectIconPrefabData(PrefabPlugin.GetIconPrefabMessage message,
                                                                                        PrefabPlugin.SocketHandler clientSocket)

loadBuildingObjectIconPrefabData

protected java.util.Map<java.lang.String,java.io.Serializable> loadBuildingObjectIconPrefabData(PrefabPlugin.GetIconPrefabMessage message,
                                                                                                PrefabPlugin.SocketHandler clientSocket)

setProxyProperties

protected boolean setProxyProperties(java.util.Map<java.lang.String,java.io.Serializable> props,
                                     PluginStatus proxy)

Use the information in the plugin status's info field to tell the client what the external address is for the proxy plugin.

Parameters:

props -

proxy -

Returns: