I_CmsRegistry

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> opencms >> [ file overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.opencms.file.I_CmsRegistry

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.opencms.file
Interface I_CmsRegistry

All Superinterfaces:: java.lang.Cloneable

All Known Implementing Classes:: CmsRegistry

public interface I_CmsRegistry
extends java.lang.Cloneable

This interface describes the registry for OpenCms.

Version:: $Revision: 1.40 $ $Date: 2003/03/04 18:48:06 $

Field Summary

static int C_ANY_VERSION


static java.lang.String C_MODULE_PATH
          The name of the folder to extend the exportpath

static java.lang.String C_MODULE_TYPE_SIMPLE
          Type identificator for "simple" (5.0 style) modules

static java.lang.String C_MODULE_TYPE_TRADITIONAL
          Type identificator for "traditional" modules

Method Summary

I_CmsRegistry clone(CmsObject cms)
          This method clones the registry.

void createModule(java.lang.String modulename, java.lang.String niceModulename, java.lang.String description, java.lang.String author, java.lang.String type, java.util.Map exportPoints, long createDate, float version)
          This method creates a new module in the repository.

void createModule(java.lang.String modulename, java.lang.String niceModulename, java.lang.String description, java.lang.String author, java.lang.String type, java.util.Map exportPoints, java.lang.String createDate, float version)
          This method creates a new module in the repository.

java.util.Vector deleteCheckDependencies(java.lang.String modulename, boolean replaceMode)
          Checks which modules depend on this module.

void deleteGetConflictingFileNames(java.lang.String modulename, java.util.Vector filesWithProperty, java.util.Vector missingFiles, java.util.Vector wrongChecksum, java.util.Vector filesInUse, java.util.Vector resourcesForProject)
          This method checks for conflicting files before the deletion of a module.

void deleteModule(java.lang.String module, java.util.Vector exclusion, boolean replaceMode, com.opencms.report.I_CmsReport report)
          Deletes a module.

void deleteModuleView(java.lang.String modulename)
          Deletes the view for a module.

void exportModule(java.lang.String moduleName, java.lang.String[] resources, java.lang.String fileName, com.opencms.report.I_CmsReport report)
          This method exports a module to the filesystem.

java.util.Hashtable getExportpoints()
          Returns all exportpoints and paths.

java.lang.String getModuleAuthor(java.lang.String modulename)
          This method returns the author of the module.

java.lang.String getModuleAuthorEmail(java.lang.String modulename)
          This method returns the email of author of the module.

long getModuleCreateDate(java.lang.String modulname)
          Gets the create date of the module.

int getModuleDependencies(java.lang.String modulename, java.util.Vector modules, java.util.Vector minVersions, java.util.Vector maxVersions)
          Returns the module dependencies for the module.

java.lang.String getModuleDescription(java.lang.String module)
          Returns the description of the module.

java.lang.String getModuleDocumentPath(java.lang.String modulename)
          Gets the url to the documentation of the module.

int getModuleExportables(java.util.Hashtable classes)
          Returns all exportable classes for all modules.

int getModuleFiles(java.lang.String modulename, java.util.Vector retNames, java.util.Vector retCodes)
          Returns all filenames and hashcodes belonging to the module.

int getModuleLifeCycle(java.util.Vector classes)
          Returns all lifecycle classes for all modules.

java.lang.Class getModuleMaintenanceEventClass(java.lang.String modulname)
          Returns the class, that receives all maintenance-events for the module.

java.lang.String getModuleMaintenanceEventName(java.lang.String modulname)
          Returns the name of the class, that receives all maintenance-events for the module.

java.util.Enumeration getModuleNames()
          Returns the names of all available modules.

java.lang.String getModuleNiceName(java.lang.String module)
          Gets the nice name of the module.

java.lang.String getModuleParameter(java.lang.String modulename, java.lang.String parameter)
          Gets a parameter for a module.

boolean getModuleParameterBoolean(java.lang.String modulname, java.lang.String parameter)
          Returns a parameter for a module.

boolean getModuleParameterBoolean(java.lang.String modulname, java.lang.String parameter, boolean defaultValue)
          Returns a parameter for a module.

java.lang.Boolean getModuleParameterBoolean(java.lang.String modulname, java.lang.String parameter, java.lang.Boolean defaultValue)
          Returns a parameter for a module.

byte getModuleParameterByte(java.lang.String modulname, java.lang.String parameter)
          Returns a parameter for a module.

byte getModuleParameterByte(java.lang.String modulname, java.lang.String parameter, byte defaultValue)
          Returns a parameter for a module.

java.lang.Byte getModuleParameterByte(java.lang.String modulname, java.lang.String parameter, java.lang.Byte defaultValue)
          Returns a parameter for a module.

java.lang.String getModuleParameterDescription(java.lang.String modulname, java.lang.String parameter)
          Returns a description for parameter in a module.

double getModuleParameterDouble(java.lang.String modulname, java.lang.String parameter)
          Returns a parameter for a module.

double getModuleParameterDouble(java.lang.String modulname, java.lang.String parameter, double defaultValue)
          Returns a parameter for a module.

java.lang.Double getModuleParameterDouble(java.lang.String modulname, java.lang.String parameter, java.lang.Double defaultValue)
          Returns a parameter for a module.

float getModuleParameterFloat(java.lang.String modulname, java.lang.String parameter)
          Returns a parameter for a module.

float getModuleParameterFloat(java.lang.String modulname, java.lang.String parameter, float defaultValue)
          Returns a parameter for a module.

java.lang.Float getModuleParameterFloat(java.lang.String modulname, java.lang.String parameter, java.lang.Float defaultValue)
          Returns a parameter for a module.

int getModuleParameterInteger(java.lang.String modulname, java.lang.String parameter)
          Returns a parameter for a module.

int getModuleParameterInteger(java.lang.String modulname, java.lang.String parameter, int defaultValue)
          Returns a parameter for a module.

java.lang.Integer getModuleParameterInteger(java.lang.String modulname, java.lang.String parameter, java.lang.Integer defaultValue)
          Returns a parameter for a module.

long getModuleParameterLong(java.lang.String modulname, java.lang.String parameter)
          Returns a parameter for a module.

long getModuleParameterLong(java.lang.String modulname, java.lang.String parameter, long defaultValue)
          Returns a parameter for a module.

java.lang.Long getModuleParameterLong(java.lang.String modulname, java.lang.String parameter, java.lang.Long defaultValue)
          Returns a parameter for a module.

java.lang.String[] getModuleParameterNames(java.lang.String modulename)
          Gets all parameter-names for a module.

java.lang.String getModuleParameterString(java.lang.String modulname, java.lang.String parameter)
          Returns a parameter for a module.

java.lang.String getModuleParameterString(java.lang.String modulname, java.lang.String parameter, java.lang.String defaultValue)
          Returns a parameter for a module.

java.lang.String getModuleParameterType(java.lang.String modulename, java.lang.String parameter)
          This method returns the type of a parameter in a module.

int getModulePublishables(java.util.Vector classes, java.lang.String requiredMethod)
          Returns all publishable classes for all modules.

java.lang.String getModulePublishClass(java.lang.String modulname)
          Returns the name of the class, that contains the publish method of the module.

java.lang.String[] getModuleRepositories(java.lang.String modulename)
          Returns all repositories for a module.

java.lang.String getModuleType(java.lang.String theModulename)
          Returns the value of the "type" node of a module subtree in the registry.

long getModuleUploadDate(java.lang.String modulename)
          Returns the upload-date for the module.

java.lang.String getModuleUploadedBy(java.lang.String module)
          Returns the user-name of the user who had uploaded the module.

float getModuleVersion(java.lang.String modulename)
          This method returns the version of the module.

java.lang.String getModuleViewName(java.lang.String modulename)
          Returns the name of the view, that is implemented by the module.

java.lang.String getModuleViewUrl(java.lang.String modulename)
          Returns the url to the view-url for the module within the system.

java.lang.String[] getRepositories()
          Returns all repositories for all modules.

int getResourceTypes(java.util.Vector names, java.util.Vector launcherTypes, java.util.Vector launcherClass, java.util.Vector resourceClass)
          Returns all Resourcetypes and korresponding parameter for System and all modules.

org.w3c.dom.Element getSystemElement()
          Return the XML "system" node Element from the registry for further processing in another class.

java.lang.String getSystemValue(java.lang.String key)
          Returns a value for a system-key.

java.util.Hashtable getSystemValues(java.lang.String key)
          Returns a vector of value for a system-key.

int getViews(java.util.Vector views, java.util.Vector urls)
          Returns all views and korresponding urls for all modules.

java.util.Vector importCheckDependencies(java.lang.String moduleZip, boolean replaceMode)
          Checks the dependencies for a new or replaced module.

java.util.Vector importGetConflictingFileNames(java.lang.String moduleZip)
          Checks for files that already exist in the system but should be replaced by the module.

java.util.Map importGetModuleInfo(java.lang.String moduleZip)
          Returns the name of the module to be imported.

java.util.Vector importGetResourcesForProject(java.lang.String moduleZip)
          Returns all files that are needed to create a project for the module-import.

void importModule(java.lang.String moduleZip, java.util.Vector exclusion, com.opencms.report.I_CmsReport report)
          Imports a module.

boolean moduleExists(java.lang.String modulename)
          Checks if the module exists already in the repository.

void setModuleAuthor(java.lang.String modulename, java.lang.String author)
          This method sets the author of the module.

void setModuleAuthorEmail(java.lang.String modulename, java.lang.String email)
          This method sets the email of author of the module.

void setModuleCreateDate(java.lang.String modulname, long createdate)
          Sets the create date of the module.

void setModuleCreateDate(java.lang.String modulname, java.lang.String createdate)
          Sets the create date of the module.

void setModuleDependencies(java.lang.String modulename, java.util.Vector modules, java.util.Vector minVersions, java.util.Vector maxVersions)
          Sets the module dependencies for the module.

void setModuleDescription(java.lang.String module, java.lang.String description)
          Sets the description of the module.

void setModuleDocumentPath(java.lang.String modulename, java.lang.String url)
          Sets the url to the documentation of the module.

void setModuleMaintenanceEventClass(java.lang.String modulname, java.lang.String classname)
          Sets the classname, that receives all maintenance-events for the module.

void setModuleNiceName(java.lang.String module, java.lang.String nicename)
          Sets the description of the module.

void setModuleParameter(java.lang.String modulename, java.lang.String parameter, boolean value)
          Sets a parameter for a module.

void setModuleParameter(java.lang.String modulename, java.lang.String parameter, java.lang.Boolean value)
          Sets a parameter for a module.

void setModuleParameter(java.lang.String modulename, java.lang.String parameter, byte value)
          Sets a parameter for a module.

void setModuleParameter(java.lang.String modulename, java.lang.String parameter, java.lang.Byte value)
          Sets a parameter for a module.

void setModuleParameter(java.lang.String modulename, java.lang.String parameter, double value)
          Sets a parameter for a module.

void setModuleParameter(java.lang.String modulename, java.lang.String parameter, java.lang.Double value)
          Sets a parameter for a module.

void setModuleParameter(java.lang.String modulename, java.lang.String parameter, float value)
          Sets a parameter for a module.

void setModuleParameter(java.lang.String modulename, java.lang.String parameter, java.lang.Float value)
          Sets a parameter for a module.

void setModuleParameter(java.lang.String modulename, java.lang.String parameter, int value)
          Sets a parameter for a module.

void setModuleParameter(java.lang.String modulename, java.lang.String parameter, java.lang.Integer value)
          Sets a parameter for a module.

void setModuleParameter(java.lang.String modulename, java.lang.String parameter, long value)
          Sets a parameter for a module.

void setModuleParameter(java.lang.String modulename, java.lang.String parameter, java.lang.Long value)
          Sets a parameter for a module.

void setModuleParameter(java.lang.String modulename, java.lang.String parameter, java.lang.String value)
          Sets a parameter for a module.

void setModuleParameterdef(java.lang.String modulename, java.util.Vector names, java.util.Vector descriptions, java.util.Vector types, java.util.Vector values)
          Sets the module dependencies for the module.

void setModulePublishClass(java.lang.String modulname, java.lang.String classname)
          Sets the classname, that contains the publish method of the module.

void setModuleRepositories(java.lang.String modulename, java.lang.String[] repositories)
          Sets all repositories for a module.

void setModuleType(java.lang.String theModulename, java.lang.String theModuleType)
          Sets the type for a given module.

void setModuleVersion(java.lang.String modulename, java.lang.String version)
          This method sets the version of the module.

void setModuleView(java.lang.String modulename, java.lang.String viewname, java.lang.String viewurl)
          Sets a view for a module

void setSystemValue(java.lang.String dataName, java.lang.String value)
          Public method to set system values.

void setSystemValues(java.lang.String dataName, java.util.Hashtable values)
          Public method to set system values with hashtable.

Field Detail

C_ANY_VERSION

public static final int C_ANY_VERSION

See Also:: Constant Field Values

C_MODULE_PATH

public static final java.lang.String C_MODULE_PATH

The name of the folder to extend the exportpath

See Also:: Constant Field Values

C_MODULE_TYPE_TRADITIONAL

public static final java.lang.String C_MODULE_TYPE_TRADITIONAL

Type identificator for "traditional" modules

See Also:: Constant Field Values

C_MODULE_TYPE_SIMPLE

public static final java.lang.String C_MODULE_TYPE_SIMPLE

Type identificator for "simple" (5.0 style) modules

See Also:: Constant Field Values

Method Detail

clone

public I_CmsRegistry clone(CmsObject cms)

This method clones the registry.

createModule

public void createModule(java.lang.String modulename,
                         java.lang.String niceModulename,
                         java.lang.String description,
                         java.lang.String author,
                         java.lang.String type,
                         java.util.Map exportPoints,
                         long createDate,
                         float version)
                  throws com.opencms.core.CmsException

This method creates a new module in the repository.

createModule

public void createModule(java.lang.String modulename,
                         java.lang.String niceModulename,
                         java.lang.String description,
                         java.lang.String author,
                         java.lang.String type,
                         java.util.Map exportPoints,
                         java.lang.String createDate,
                         float version)
                  throws com.opencms.core.CmsException

This method creates a new module in the repository.

deleteCheckDependencies

public java.util.Vector deleteCheckDependencies(java.lang.String modulename,
                                                boolean replaceMode)
                                         throws com.opencms.core.CmsException

Checks which modules depend on this module.

If a module depends on this module, the name will be returned in the vector.

deleteGetConflictingFileNames

public void deleteGetConflictingFileNames(java.lang.String modulename,
                                          java.util.Vector filesWithProperty,
                                          java.util.Vector missingFiles,
                                          java.util.Vector wrongChecksum,
                                          java.util.Vector filesInUse,
                                          java.util.Vector resourcesForProject)
                                   throws com.opencms.core.CmsException

This method checks for conflicting files before the deletion of a module. It uses several Vectors to return the different conflicting files.

deleteModule

public void deleteModule(java.lang.String module,
                         java.util.Vector exclusion,
                         boolean replaceMode,
                         com.opencms.report.I_CmsReport report)
                  throws com.opencms.core.CmsException

Deletes a module.

This method is synchronized, so only one module can be deleted at a time.

deleteModuleView

public void deleteModuleView(java.lang.String modulename)
                      throws com.opencms.core.CmsException

Deletes the view for a module.

exportModule

public void exportModule(java.lang.String moduleName,
                         java.lang.String[] resources,
                         java.lang.String fileName,
                         com.opencms.report.I_CmsReport report)
                  throws com.opencms.core.CmsException

This method exports a module to the filesystem.

getModuleAuthor

public java.lang.String getModuleAuthor(java.lang.String modulename)

This method returns the author of the module.

getModuleAuthorEmail

public java.lang.String getModuleAuthorEmail(java.lang.String modulename)

This method returns the email of author of the module.

getModuleCreateDate

public long getModuleCreateDate(java.lang.String modulname)

Gets the create date of the module.

getModuleDependencies

public int getModuleDependencies(java.lang.String modulename,
                                 java.util.Vector modules,
                                 java.util.Vector minVersions,
                                 java.util.Vector maxVersions)

Returns the module dependencies for the module.

getModuleDescription

public java.lang.String getModuleDescription(java.lang.String module)

Returns the description of the module.

getModuleDocumentPath

public java.lang.String getModuleDocumentPath(java.lang.String modulename)

Gets the url to the documentation of the module.

getModuleFiles

public int getModuleFiles(java.lang.String modulename,
                          java.util.Vector retNames,
                          java.util.Vector retCodes)

Returns all filenames and hashcodes belonging to the module.

getModuleMaintenanceEventClass

public java.lang.Class getModuleMaintenanceEventClass(java.lang.String modulname)

Returns the class, that receives all maintenance-events for the module.

getModuleMaintenanceEventName

public java.lang.String getModuleMaintenanceEventName(java.lang.String modulname)

Returns the name of the class, that receives all maintenance-events for the module.

getModuleNames

public java.util.Enumeration getModuleNames()

Returns the names of all available modules.

getModuleNiceName

public java.lang.String getModuleNiceName(java.lang.String module)

Gets the nice name of the module.

getModuleParameter

public java.lang.String getModuleParameter(java.lang.String modulename,
                                           java.lang.String parameter)

Gets a parameter for a module.