atavism.agis.plugins

Class GuildPlugin

java.lang.Object

atavism.server.engine.EnginePlugin

atavism.agis.plugins.GuildPlugin

All Implemented Interfaces:

MessageCallback, StatusMapCallback

public class GuildPlugin
extends EnginePlugin

Nested Class Summary

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
static java.util.ArrayList<java.util.ArrayList<java.lang.String>>	defaultPermissions
static java.lang.String	GUILD_NAME_PROP
static java.lang.String	GUILD_PLUGIN_NAME
static java.lang.String	GUILD_PROP
protected static Logger	log
static int	maxRanks
static java.lang.String	PERMISSION_ACTION_CLAIM
static java.lang.String	PERMISSION_ADD_CLAIM
static java.lang.String	PERMISSION_ADD_RANK
static java.lang.String	PERMISSION_CHAT
static java.lang.String	PERMISSION_DEL_RANK
static java.lang.String	PERMISSION_DEMOTE
static java.lang.String	PERMISSION_DISBAND
static java.lang.String	PERMISSION_EDIT_CLAIM
static java.lang.String	PERMISSION_EDIT_RANK
static java.lang.String	PERMISSION_INVITE
static java.lang.String	PERMISSION_KICK
static java.lang.String	PERMISSION_PROMOTE
static java.lang.String	PERMISSION_SET_MOTD
static java.util.ArrayList<java.lang.String>	rankNames

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
GuildPlugin()

Method Summary

Modifier and Type	Method and Description
static void	AddGuildRank(java.lang.String rankName, java.lang.String[] permissions)
java.lang.String	getName() Returns the name of the plugin.
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()
protected boolean	UpdateGuildMemberProps(PropertyMessage propMsg) Sends update to group members about the group and its members

Methods inherited from class atavism.server.engine.EnginePlugin

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

GUILD_PLUGIN_NAME

public static java.lang.String GUILD_PLUGIN_NAME

log

protected static final Logger log

GUILD_PROP

public static final java.lang.String GUILD_PROP

See Also:

Constant Field Values

GUILD_NAME_PROP

public static final java.lang.String GUILD_NAME_PROP

See Also:

Constant Field Values

PERMISSION_INVITE

public static final java.lang.String PERMISSION_INVITE

See Also:

Constant Field Values

PERMISSION_KICK

public static final java.lang.String PERMISSION_KICK

See Also:

Constant Field Values

PERMISSION_PROMOTE

public static final java.lang.String PERMISSION_PROMOTE

See Also:

Constant Field Values

PERMISSION_DEMOTE

public static final java.lang.String PERMISSION_DEMOTE

See Also:

Constant Field Values

PERMISSION_SET_MOTD

public static final java.lang.String PERMISSION_SET_MOTD

See Also:

Constant Field Values

PERMISSION_CHAT

public static final java.lang.String PERMISSION_CHAT

See Also:

Constant Field Values

PERMISSION_DISBAND

public static final java.lang.String PERMISSION_DISBAND

See Also:

Constant Field Values

PERMISSION_ADD_RANK

public static final java.lang.String PERMISSION_ADD_RANK

See Also:

Constant Field Values

PERMISSION_EDIT_RANK

public static final java.lang.String PERMISSION_EDIT_RANK

See Also:

Constant Field Values

PERMISSION_DEL_RANK

public static final java.lang.String PERMISSION_DEL_RANK

See Also:

Constant Field Values

PERMISSION_ADD_CLAIM

public static final java.lang.String PERMISSION_ADD_CLAIM

See Also:

Constant Field Values

PERMISSION_EDIT_CLAIM

public static final java.lang.String PERMISSION_EDIT_CLAIM

See Also:

Constant Field Values

PERMISSION_ACTION_CLAIM

public static final java.lang.String PERMISSION_ACTION_CLAIM

See Also:

Constant Field Values

maxRanks

public static int maxRanks

rankNames

public static java.util.ArrayList<java.lang.String> rankNames

defaultPermissions

public static java.util.ArrayList<java.util.ArrayList<java.lang.String>> defaultPermissions

Constructor Detail

GuildPlugin

public GuildPlugin()

Method Detail

getName

public java.lang.String getName()

Description copied from class: EnginePlugin

Returns the name of the plugin. Engine.registerPlugin() will call this method and associate the name with the plugin, which can be retrieved by calling Engine.getPlugin()

Overrides:

getName in class EnginePlugin

Returns:

the name of this plugin

See Also:

EnginePlugin.setName(String)

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()

UpdateGuildMemberProps

protected boolean UpdateGuildMemberProps(PropertyMessage propMsg)

Sends update to group members about the group and its members

AddGuildRank

public static void AddGuildRank(java.lang.String rankName,
                                java.lang.String[] permissions)