atavism.server.plugins
Class InstancePlugin

java.lang.Object
  atavism.server.engine.EnginePlugin
      atavism.server.plugins.InstancePlugin

All Implemented Interfaces:

MessageCallback, StatusMapCallback

public class InstancePlugin
extends EnginePlugin

Nested Class Summary

static class	InstancePlugin.PopulationChangeCallback This must be a base class rather than an interface because we want to create callbacks in Python.
class	InstancePlugin.RegionSearch

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

protected static Logger

log

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

InstancePlugin()

Method Summary

OID	getPersistentInstanceOid(java.lang.String name) Get persistent instance oid by name.
static java.lang.Class	getWorldLoaderOverrideClass(java.lang.String name) Get a registered spawn generator class.
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.
protected void	registerHooks()
void	registerPopulationChangeCallback(InstancePlugin.PopulationChangeCallback populationChangeCallback) Register the callback that supplies the population of an instance when it changes.
static void	registerWorldLoaderOverrideClass(java.lang.String name, java.lang.Class loaderOverrideClass) Register a world loader override class.
protected PluginStatus	selectBestWorldManager(java.util.List<PluginStatus> plugins)
protected PluginStatus	selectWorldManagerPlugin()
protected void	sendSpawnGenerators(Instance instance)

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

Constructor Detail

InstancePlugin

public InstancePlugin()

Method Detail

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

registerHooks

protected void registerHooks()

sendSpawnGenerators

protected void sendSpawnGenerators(Instance instance)

registerWorldLoaderOverrideClass

public static void registerWorldLoaderOverrideClass(java.lang.String name,
                                                    java.lang.Class loaderOverrideClass)

Register a world loader override class. The registered name is referenced by instance property InstanceClient.TEMPL_LOADER_OVERRIDE_NAME. An instance of the class is created prior to loading the instance world file. If the instance does not specify a world loader override, then DefaultWorldLoaderOverride is used.

Parameters:

name - World loader override class registered name.

loaderOverrideClass - World loader override class, must implement WorldLoaderOverride.

getWorldLoaderOverrideClass

public static java.lang.Class getWorldLoaderOverrideClass(java.lang.String name)

Get a registered spawn generator class.

getPersistentInstanceOid

public OID getPersistentInstanceOid(java.lang.String name)

Get persistent instance oid by name. The lookup is performed on the database, independent of loaded instances.

selectWorldManagerPlugin

protected final PluginStatus selectWorldManagerPlugin()

selectBestWorldManager

protected PluginStatus selectBestWorldManager(java.util.List<PluginStatus> plugins)

registerPopulationChangeCallback

public void registerPopulationChangeCallback(InstancePlugin.PopulationChangeCallback populationChangeCallback)

Register the callback that supplies the population of an instance when it changes.

Parameters:

populationChangeCallback -