org.mmbase.module.tools

Class MMAdmin

java.lang.Object

org.mmbase.util.functions.FunctionProvider

org.mmbase.util.functions.DescribedFunctionProvider

org.mmbase.module.Module

org.mmbase.module.ProcessorModule

org.mmbase.module.tools.MMAdmin

All Implemented Interfaces:

Descriptor, EventListener, SystemEventListener, WeightEventListener

public class MMAdmin
extends ProcessorModule
implements SystemEventListener

Version:

$Id$

Author:

Daniel Ockeloen, Pierre van Rooden

Application:

Admin, Application

Javadoc:

Nested Class Summary

Nested classes/interfaces inherited from class org.mmbase.module.ProcessorModule

ProcessorModule.GetNodeListFunction, ProcessorModule.ProcessFunction, ProcessorModule.ReplaceFunction

Field Summary

Fields inherited from class org.mmbase.module.ProcessorModule

PARAM_PAGEINFO, PARAMS_PAGEINFO

Fields inherited from class org.mmbase.module.Module

configurationPath, getMaintainerFunction, getVersionFunction, properties, STATE_START_TIME

Fields inherited from class org.mmbase.util.functions.DescribedFunctionProvider

description, guiName, name

Fields inherited from class org.mmbase.util.functions.FunctionProvider

functions, getFunctions

Constructor Summary

Constructors

Constructor and Description
MMAdmin(String name)

Method Summary

Modifier and Type	Method and Description
void	addBuilderField(Map<String,Object> vars)
void	doBuilderPosts(String command, Hashtable<String,Object> cmds, Hashtable<String,Object> vars)
void	doModulePosts(String command, Hashtable<String,Object> cmds, Hashtable<String,Object> vars)
(package private) Vector<String>	getApplicationsList()
MMObjectBuilder	getBuilder(String path) Retrieves a specified builder.
(package private) String	getBuilderClass(String builderName)
(package private) String	getBuilderDescription(String builderName)
(package private) List<String>	getBuildersList()
(package private) int	getBuilderVersion(String builderName)
(package private) Vector<String>	getDatabasesList()
(package private) String	getDescription(String appname)
(package private) Vector<String>	getFields(String builderName)
protected Collection<String>	getIgnoredAutodeployApplications()
List<String>	getList(PageInfo sp, StringTagger tagger, String value) Generate a list of values from a command to the processor
MMObjectBuilder	getListBuilder(String command, Map<String,?> params) Returns a virtual builder used to create node lists from the results returned by getList().
(package private) String	getModuleClass(String modname)
(package private) String	getModuleDescription(String modulename)
(package private) Vector<String>	getModuleProperties(String modulename)
(package private) String	getModuleProperty(String modname, String key)
(package private) Vector<String>	getModulesList()
Vector<String>	getMultilevelCacheEntries()
Vector<String>	getNodeCacheEntries()
boolean	getState() Wether MMAdmin module was completely initialized (applications auto-deployed and so on).
(package private) int	getVersion(String appname)
int	getWeight()
void	init() Initializes the module.
void	notify(SystemEvent se)
protected void	probeCall() Called when MMBase is up.
boolean	process(PageInfo sp, Hashtable<String,Object> cmds, Hashtable<String,Object> vars) Execute the commands provided in the form values
void	removeBuilderField(Hashtable<String,Object> vars)
String	replace(PageInfo sp, String cmds) Handle a $MOD command
void	setBuilderDBField(Hashtable<String,Object> vars)
void	setBuilderDBKey(Hashtable<String,Object> vars)
void	setBuilderDBNotNull(Hashtable<String,Object> vars)
void	setBuilderDBSize(Hashtable<String,Object> vars)
void	setBuilderDBState(Hashtable<String,Object> vars)
void	setBuilderDescription(Hashtable<String,Object> vars)
void	setBuilderEditorInput(Hashtable<String,Object> vars)
void	setBuilderEditorList(Hashtable<String,Object> vars)
void	setBuilderEditorSearch(Hashtable<String,Object> vars)
void	setBuilderGuiName(Hashtable<String,Object> vars)
void	setBuilderGuiType(Hashtable<String,Object> vars)
void	setModuleProperty(Hashtable<String,Object> vars)
void	syncBuilderXML(MMObjectBuilder bul, String builder)
void	syncModuleXML(Module mod, String modname)

Methods inherited from class org.mmbase.module.ProcessorModule

getNodeList, onload, reload, replace, unload

Methods inherited from class org.mmbase.module.Module

addInitParameters, getInitParameter, getInitParameter, getInitParameter, getInitParameters, getInitParameters, getMaintainer, getModule, getModule, getModule, getModule, getModuleInfo, getModuleLoader, getModuleReader, getModuleReader, getModules, getState, getStates, getVersion, hasModule, hasStarted, loadInitParameters, loadInitParameters, maintainance, setInitParameter, setMaintainer, setState, setVersion, shutdown, shutdownModules, startModule, startModules

Methods inherited from class org.mmbase.util.functions.DescribedFunctionProvider

getDefaultLocale, getDescription, getDescription, getGUIName, getGUIName, getLocalizedDescription, getLocalizedGUIName, getName, setDescription, setDescription, setGUIName, setGUIName, setLocalizedDescription, setLocalizedGUIName, setName

Methods inherited from class org.mmbase.util.functions.FunctionProvider

addFunction, createParameters, getFunction, getFunctions, getFunctionValue, newFunctionInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

MMAdmin

public MMAdmin(String name)

Method Detail

init

public void init()

Description copied from class: ProcessorModule

Initializes the module. Init must be overridden to read the environment variables it needs.
This method is called by Module.startModule(), which makes sure it is not called more than once. You should not call init() directly, call startModule() instead.

Overrides:

init in class ProcessorModule

Javadoc:

notify

public void notify(SystemEvent se)

Specified by:

notify in interface SystemEventListener

getWeight

public int getWeight()

Specified by:

getWeight in interface WeightEventListener

getListBuilder

public MMObjectBuilder getListBuilder(String command,
                                      Map<String,?> params)

Returns a virtual builder used to create node lists from the results returned by getList(). The default method does not associate the builder with a cloud (mmbase module), so processormodules that need this association need to override this method. Note that different lists may return different builders.

Overrides:

getListBuilder in class ProcessorModule

Parameters:

command - the LIST command for which to retrieve the builder

params - contains the attributes for the list

getBuilder

public MMObjectBuilder getBuilder(String path)

Retrieves a specified builder. The builder's name can be extended with the subpath of that builder's configuration file. i.e. 'core/typedef' or 'basic/images'. The subpath part is ignored.

Parameters:

path - The path of the builder to retrieve

Returns:

a MMObjectBuilder is found, null otherwise

getList

public List<String> getList(PageInfo sp,
                            StringTagger tagger,
                            String value)

Generate a list of values from a command to the processor

Overrides:

getList in class ProcessorModule

Javadoc:

process

public boolean process(PageInfo sp,
                       Hashtable<String,Object> cmds,
                       Hashtable<String,Object> vars)

Execute the commands provided in the form values

Overrides:

process in class ProcessorModule

Javadoc:

getIgnoredAutodeployApplications

protected Collection<String> getIgnoredAutodeployApplications()

Since:

MMBase-1.8.5

replace

public String replace(PageInfo sp,
                      String cmds)

Handle a $MOD command

Overrides:

replace in class ProcessorModule

Javadoc:

getVersion

int getVersion(String appname)

Javadoc:

getBuilderVersion

int getBuilderVersion(String builderName)

Javadoc:

getBuilderClass

String getBuilderClass(String builderName)

Javadoc:

getModuleClass

String getModuleClass(String modname)

Javadoc:

setModuleProperty

public void setModuleProperty(Hashtable<String,Object> vars)

Javadoc:

getModuleProperty

String getModuleProperty(String modname,
                         String key)

To Do:

should obtain data from the configuration file

Javadoc:

getDescription

String getDescription(String appname)

Javadoc:

getBuilderDescription

String getBuilderDescription(String builderName)

Javadoc:

getModuleDescription

String getModuleDescription(String modulename)

Javadoc:

probeCall

protected void probeCall()
                  throws SearchQueryException

Called when MMBase is up. It'll install the applications marked as 'autodeploy'. It will do nothing, besides logging a warning, if the 'versions' builder could not be found.

Throws:

SearchQueryException

getState

public boolean getState()

Wether MMAdmin module was completely initialized (applications auto-deployed and so on).

Since:

MMBase-1.7

getApplicationsList

Vector<String> getApplicationsList()
                            throws SearchQueryException

Throws:

SearchQueryException

Javadoc:

getBuildersList

List<String> getBuildersList()

Javadoc:

getModuleProperties

Vector<String> getModuleProperties(String modulename)

Javadoc:

getFields

Vector<String> getFields(String builderName)

Javadoc:

getModulesList

Vector<String> getModulesList()

Javadoc:

getDatabasesList

Vector<String> getDatabasesList()

Javadoc:

doModulePosts

public void doModulePosts(String command,
                          Hashtable<String,Object> cmds,
                          Hashtable<String,Object> vars)

Javadoc:

doBuilderPosts

public void doBuilderPosts(String command,
                           Hashtable<String,Object> cmds,
                           Hashtable<String,Object> vars)

Javadoc:

setBuilderGuiName

public void setBuilderGuiName(Hashtable<String,Object> vars)

Javadoc:

setBuilderDescription

public void setBuilderDescription(Hashtable<String,Object> vars)

Since:

MMBase-1.7

Javadoc:

setBuilderGuiType

public void setBuilderGuiType(Hashtable<String,Object> vars)

Javadoc:

setBuilderEditorInput

public void setBuilderEditorInput(Hashtable<String,Object> vars)

Javadoc:

setBuilderEditorList

public void setBuilderEditorList(Hashtable<String,Object> vars)

Javadoc:

setBuilderEditorSearch

public void setBuilderEditorSearch(Hashtable<String,Object> vars)

Javadoc:

setBuilderDBSize

public void setBuilderDBSize(Hashtable<String,Object> vars)

Javadoc:

setBuilderDBField

public void setBuilderDBField(Hashtable<String,Object> vars)

Javadoc:

setBuilderDBState

public void setBuilderDBState(Hashtable<String,Object> vars)

Javadoc:

setBuilderDBKey

public void setBuilderDBKey(Hashtable<String,Object> vars)

Javadoc:

setBuilderDBNotNull

public void setBuilderDBNotNull(Hashtable<String,Object> vars)

Javadoc:

addBuilderField

public void addBuilderField(Map<String,Object> vars)

Javadoc:

removeBuilderField

public void removeBuilderField(Hashtable<String,Object> vars)

Javadoc:

syncBuilderXML

public void syncBuilderXML(MMObjectBuilder bul,
                           String builder)

Javadoc:

syncModuleXML

public void syncModuleXML(Module mod,
                          String modname)

Javadoc:

getMultilevelCacheEntries

public Vector<String> getMultilevelCacheEntries()

Javadoc:

getNodeCacheEntries

public Vector<String> getNodeCacheEntries()

Javadoc: