ks.client.interfaces
Interface IGameManager

public interface IGameManager

Exposes functionality to manage and inspect available plugins at the client side.

Field Summary

static java.lang.String	backupFile Name of backup index file, used when manipulating the original index.
static java.lang.String	defaultPluginDirectory Default value of configuration variable (localPluginDirectory)
static java.lang.String	indexFile Name of index file within this directory that will contain information about each plugIn, one per line, that is found within the localPlugin directory.
static java.lang.String	localPluginDirectory Configuration variable.

Method Summary

java.lang.String	getEntry(java.lang.String dirName, java.lang.String pluginName) Get the entry for the given plugin name and directory.
java.util.Enumeration	plugins(java.lang.String dirName) Return Enumeration of Strings representing plugin names.
void	registerPlugin(java.lang.String dirName, java.lang.String pluginName) Register plugin in given directory with given name.
void	removePluginList(java.lang.String dirName, java.lang.String pluginName) Remove a plugin
void	setEntry(java.lang.String dirName, java.lang.String pluginName, java.lang.String string) Update entry (within plugin index) for directory and name.

Field Detail

indexFile

public static final java.lang.String indexFile

Name of index file within this directory that will contain information about each plugIn, one per line, that is found within the localPlugin directory. The information within this file must be formatted as follows:

jarname:pluginName:pluginVersion:author:size:date:[optional extra]

Note that [optional extra] refers to additional properties that may be stored within this file.

See Also:

Constant Field Values

backupFile

public static final java.lang.String backupFile

Name of backup index file, used when manipulating the original index.

See Also:

Constant Field Values

localPluginDirectory

public static final java.lang.String localPluginDirectory

Configuration variable.

See Also:

Constant Field Values

defaultPluginDirectory

public static final java.lang.String defaultPluginDirectory

Default value of configuration variable (localPluginDirectory)

See Also:

Constant Field Values

Method Detail

registerPlugin

public void registerPlugin(java.lang.String dirName,
                           java.lang.String pluginName)

Register plugin in given directory with given name.

Parameters:

dirName - Location where entry info is to be found.

pluginName - key to which info is associated.

setEntry

public void setEntry(java.lang.String dirName,
                     java.lang.String pluginName,
                     java.lang.String string)

Update entry (within plugin index) for directory and name.

Parameters:

dirName - Location where entry info is to be found.

pluginName - key to which info is associated.

string - String representing the information associated with the given entry.

getEntry

public java.lang.String getEntry(java.lang.String dirName,
                                 java.lang.String pluginName)

Get the entry for the given plugin name and directory.

Parameters:

dirName - Location where entry info is to be found.

pluginName - key to which info is associated.

Returns:

String representing the information associated with the given entry.

removePluginList

public void removePluginList(java.lang.String dirName,
                             java.lang.String pluginName)

Remove a plugin

Parameters:

dirName - Location where plugin is to be found.

pluginName - key referencing plugin to be deleted.

plugins

public java.util.Enumeration plugins(java.lang.String dirName)

Return Enumeration of Strings representing plugin names.

Parameters:

dirName - Location where plugins are to be found.

Returns:

Enumeration of Strings representing plugin names.