com.opencms.file
Interface I_CmsRegistry

All Superinterfaces:

Cloneable

All Known Implementing Classes:

CmsRegistry

public interface I_CmsRegistry

extends Cloneable

This interface describes the registry for OpenCms.

Version:

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

Author:

Andreas Schouten, Thomas Weckert (t.weckert@alkacon.com)

Field Summary

static int	C_ANY_VERSION
static String	C_MODULE_PATH The name of the folder to extend the exportpath
static String	C_MODULE_TYPE_SIMPLE Type identificator for "simple" (5.0 style) modules
static String	C_MODULE_TYPE_TRADITIONAL Type identificator for "traditional" modules

Method Summary

I_CmsRegistry	clone(CmsObject cms) This method clones the registry.
void	createModule(String modulename, String niceModulename, String description, String author, String type, Map exportPoints, long createDate, float version) This method creates a new module in the repository.
void	createModule(String modulename, String niceModulename, String description, String author, String type, Map exportPoints, String createDate, float version) This method creates a new module in the repository.
Vector	deleteCheckDependencies(String modulename, boolean replaceMode) Checks which modules depend on this module.
void	deleteGetConflictingFileNames(String modulename, Vector filesWithProperty, Vector missingFiles, Vector wrongChecksum, Vector filesInUse, Vector resourcesForProject) This method checks for conflicting files before the deletion of a module.
void	deleteModule(String module, Vector exclusion, boolean replaceMode, I_CmsReport report) Deletes a module.
void	deleteModuleView(String modulename) Deletes the view for a module.
void	exportModule(String moduleName, String[] resources, String fileName, I_CmsReport report) This method exports a module to the filesystem.
Hashtable	getExportpoints() Returns all exportpoints and paths.
String	getModuleAuthor(String modulename) This method returns the author of the module.
String	getModuleAuthorEmail(String modulename) This method returns the email of author of the module.
long	getModuleCreateDate(String modulname) Gets the create date of the module.
int	getModuleDependencies(String modulename, Vector modules, Vector minVersions, Vector maxVersions) Returns the module dependencies for the module.
String	getModuleDescription(String module) Returns the description of the module.
String	getModuleDocumentPath(String modulename) Gets the url to the documentation of the module.
int	getModuleExportables(Hashtable classes) Returns all exportable classes for all modules.
int	getModuleFiles(String modulename, Vector retNames, Vector retCodes) Returns all filenames and hashcodes belonging to the module.
int	getModuleLifeCycle(Vector classes) Returns all lifecycle classes for all modules.
Class	getModuleMaintenanceEventClass(String modulname) Returns the class, that receives all maintenance-events for the module.
String	getModuleMaintenanceEventName(String modulname) Returns the name of the class, that receives all maintenance-events for the module.
Enumeration	getModuleNames() Returns the names of all available modules.
String	getModuleNiceName(String module) Gets the nice name of the module.
String	getModuleParameter(String modulename, String parameter) Gets a parameter for a module.
boolean	getModuleParameterBoolean(String modulname, String parameter) Returns a parameter for a module.
boolean	getModuleParameterBoolean(String modulname, String parameter, boolean defaultValue) Returns a parameter for a module.
Boolean	getModuleParameterBoolean(String modulname, String parameter, Boolean defaultValue) Returns a parameter for a module.
byte	getModuleParameterByte(String modulname, String parameter) Returns a parameter for a module.
byte	getModuleParameterByte(String modulname, String parameter, byte defaultValue) Returns a parameter for a module.
Byte	getModuleParameterByte(String modulname, String parameter, Byte defaultValue) Returns a parameter for a module.
String	getModuleParameterDescription(String modulname, String parameter) Returns a description for parameter in a module.
double	getModuleParameterDouble(String modulname, String parameter) Returns a parameter for a module.
double	getModuleParameterDouble(String modulname, String parameter, double defaultValue) Returns a parameter for a module.
Double	getModuleParameterDouble(String modulname, String parameter, Double defaultValue) Returns a parameter for a module.
float	getModuleParameterFloat(String modulname, String parameter) Returns a parameter for a module.
float	getModuleParameterFloat(String modulname, String parameter, float defaultValue) Returns a parameter for a module.
Float	getModuleParameterFloat(String modulname, String parameter, Float defaultValue) Returns a parameter for a module.
int	getModuleParameterInteger(String modulname, String parameter) Returns a parameter for a module.
int	getModuleParameterInteger(String modulname, String parameter, int defaultValue) Returns a parameter for a module.
Integer	getModuleParameterInteger(String modulname, String parameter, Integer defaultValue) Returns a parameter for a module.
long	getModuleParameterLong(String modulname, String parameter) Returns a parameter for a module.
long	getModuleParameterLong(String modulname, String parameter, long defaultValue) Returns a parameter for a module.
Long	getModuleParameterLong(String modulname, String parameter, Long defaultValue) Returns a parameter for a module.
String[]	getModuleParameterNames(String modulename) Gets all parameter-names for a module.
String	getModuleParameterString(String modulname, String parameter) Returns a parameter for a module.
String	getModuleParameterString(String modulname, String parameter, String defaultValue) Returns a parameter for a module.
String	getModuleParameterType(String modulename, String parameter) This method returns the type of a parameter in a module.
int	getModulePublishables(Vector classes, String requiredMethod) Returns all publishable classes for all modules.
String	getModulePublishClass(String modulname) Returns the name of the class, that contains the publish method of the module.
String[]	getModuleRepositories(String modulename) Returns all repositories for a module.
String	getModuleType(String theModulename) Returns the value of the "type" node of a module subtree in the registry.
long	getModuleUploadDate(String modulename) Returns the upload-date for the module.
String	getModuleUploadedBy(String module) Returns the user-name of the user who had uploaded the module.
float	getModuleVersion(String modulename) This method returns the version of the module.
String	getModuleViewName(String modulename) Returns the name of the view, that is implemented by the module.
String	getModuleViewUrl(String modulename) Returns the url to the view-url for the module within the system.
String[]	getRepositories() Returns all repositories for all modules.
int	getResourceTypes(Vector names, Vector launcherTypes, Vector launcherClass, Vector resourceClass) Returns all Resourcetypes and korresponding parameter for System and all modules.
Element	getSystemElement() Return the XML "system" node Element from the registry for further processing in another class.
String	getSystemValue(String key) Returns a value for a system-key.
Hashtable	getSystemValues(String key) Returns a vector of value for a system-key.
int	getViews(Vector views, Vector urls) Returns all views and korresponding urls for all modules.
Vector	importCheckDependencies(String moduleZip, boolean replaceMode) Checks the dependencies for a new or replaced module.
Vector	importGetConflictingFileNames(String moduleZip) Checks for files that already exist in the system but should be replaced by the module.
Map	importGetModuleInfo(String moduleZip) Returns the name of the module to be imported.
Vector	importGetResourcesForProject(String moduleZip) Returns all files that are needed to create a project for the module-import.
void	importModule(String moduleZip, Vector exclusion, I_CmsReport report) Imports a module.
boolean	moduleExists(String modulename) Checks if the module exists already in the repository.
void	setModuleAuthor(String modulename, String author) This method sets the author of the module.
void	setModuleAuthorEmail(String modulename, String email) This method sets the email of author of the module.
void	setModuleCreateDate(String modulname, long createdate) Sets the create date of the module.
void	setModuleCreateDate(String modulname, String createdate) Sets the create date of the module.
void	setModuleDependencies(String modulename, Vector modules, Vector minVersions, Vector maxVersions) Sets the module dependencies for the module.
void	setModuleDescription(String module, String description) Sets the description of the module.
void	setModuleDocumentPath(String modulename, String url) Sets the url to the documentation of the module.
void	setModuleMaintenanceEventClass(String modulname, String classname) Sets the classname, that receives all maintenance-events for the module.
void	setModuleNiceName(String module, String nicename) Sets the description of the module.
void	setModuleParameter(String modulename, String parameter, boolean value) Sets a parameter for a module.
void	setModuleParameter(String modulename, String parameter, Boolean value) Sets a parameter for a module.
void	setModuleParameter(String modulename, String parameter, byte value) Sets a parameter for a module.
void	setModuleParameter(String modulename, String parameter, Byte value) Sets a parameter for a module.
void	setModuleParameter(String modulename, String parameter, double value) Sets a parameter for a module.
void	setModuleParameter(String modulename, String parameter, Double value) Sets a parameter for a module.
void	setModuleParameter(String modulename, String parameter, float value) Sets a parameter for a module.
void	setModuleParameter(String modulename, String parameter, Float value) Sets a parameter for a module.
void	setModuleParameter(String modulename, String parameter, int value) Sets a parameter for a module.
void	setModuleParameter(String modulename, String parameter, Integer value) Sets a parameter for a module.
void	setModuleParameter(String modulename, String parameter, long value) Sets a parameter for a module.
void	setModuleParameter(String modulename, String parameter, Long value) Sets a parameter for a module.
void	setModuleParameter(String modulename, String parameter, String value) Sets a parameter for a module.
void	setModuleParameterdef(String modulename, Vector names, Vector descriptions, Vector types, Vector values) Sets the module dependencies for the module.
void	setModulePublishClass(String modulname, String classname) Sets the classname, that contains the publish method of the module.
void	setModuleRepositories(String modulename, String[] repositories) Sets all repositories for a module.
void	setModuleType(String theModulename, String theModuleType) Sets the type for a given module.
void	setModuleVersion(String modulename, String version) This method sets the version of the module.
void	setModuleView(String modulename, String viewname, String viewurl) Sets a view for a module
void	setSystemValue(String dataName, String value) Public method to set system values.
void	setSystemValues(String dataName, 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 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 String C_MODULE_TYPE_TRADITIONAL

Type identificator for "traditional" modules

See Also:

Constant Field Values

C_MODULE_TYPE_SIMPLE

public static final 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.

Returns:

the cloned registry.

createModule

public void createModule(String modulename,
                         String niceModulename,
                         String description,
                         String author,
                         String type,
                         Map exportPoints,
                         long createDate,
                         float version)
                  throws CmsException

This method creates a new module in the repository.

Parameters:

modulename - the name of the module

niceModulename - another name of the module

description - the description of the module

author - the name of the author

type - the type of the module

exportPoints - a map of all export points of the module

createDate - the creation date of the module

version - the version number of the module

Throws:

CmsException - if the user has no right to create a new module

createModule

public void createModule(String modulename,
                         String niceModulename,
                         String description,
                         String author,
                         String type,
                         Map exportPoints,
                         String createDate,
                         float version)
                  throws CmsException

This method creates a new module in the repository.

Parameters:

modulename - the name of the module

niceModulename - another name of the module

description - the description of the module

author - the name of the author

type - the type of the module

exportPoints - a map of all export points of the module

createDate - the creation date of the module in the format: mm.dd.yyyy

version - the version number of the module

Throws:

CmsException - if the user has no right to create a new module

deleteCheckDependencies

public Vector deleteCheckDependencies(String modulename,
                                      boolean replaceMode)
                               throws CmsException

Checks which modules depend on this module.

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

Parameters:

replaceMode - if true this is for module replacement, if false it is form module deletion

Returns:

a Vector with modulenames that depends on the overgiven module.

CmsException

deleteGetConflictingFileNames

public void deleteGetConflictingFileNames(String modulename,
                                          Vector filesWithProperty,
                                          Vector missingFiles,
                                          Vector wrongChecksum,
                                          Vector filesInUse,
                                          Vector resourcesForProject)
                                   throws CmsException

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

Parameters:

modulename - the name of the module that should be deleted.

filesWithProperty - a return value. The files that are marked with the module-property for this module.

missingFiles - a return value. The files that are missing.

wrongChecksum - a return value. The files that should be deleted but have another checksum as at import-time.

filesInUse - a return value. The files that should be deleted but are in use by other modules.

resourcesForProject - a return value. The files that should be copied to a project to delete.

CmsException

deleteModule

public void deleteModule(String module,
                         Vector exclusion,
                         boolean replaceMode,
                         I_CmsReport report)
                  throws CmsException

Deletes a module.

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

Parameters:

module - the name of the module to be deleted

exclusion - a Vector with resource names that should be excluded from this deletion

replaceMode - if true this is for module replacement, so no dependencies will be checked

report - a report for the output

Throws:

CmsException - in case of an error during deletion

deleteModuleView

public void deleteModuleView(String modulename)
                      throws CmsException

Deletes the view for a module.

CmsException

exportModule

public void exportModule(String moduleName,
                         String[] resources,
                         String fileName,
                         I_CmsReport report)
                  throws CmsException

This method exports a module to the filesystem.

Parameters:

moduleName - the name of the module to be exported.

fileName - the name of the file to write the export to.

CmsException

getModuleAuthor

public String getModuleAuthor(String modulename)

This method returns the author of the module.

Returns:

java.lang.String the author of the module.

getModuleAuthorEmail

public String getModuleAuthorEmail(String modulename)

This method returns the email of author of the module.

Returns:

java.lang.String the email of author of the module.

getModuleCreateDate

public long getModuleCreateDate(String modulname)

Gets the create date of the module.

Returns:

long the create date of the module.

getModuleDependencies

public int getModuleDependencies(String modulename,
                                 Vector modules,
                                 Vector minVersions,
                                 Vector maxVersions)

Returns the module dependencies for the module.

Parameters:

modules - Vector in this parameter the names of the dependend modules will be returned.

minVersions - Vector in this parameter the minimum versions of the dependend modules will be returned.

maxVersions - Vector in this parameter the maximum versions of the dependend modules will be returned.

Returns:

int the amount of dependencies for the module will be returned.

getModuleDescription

public String getModuleDescription(String module)

Returns the description of the module.

Returns:

java.lang.String the description of the module.

getModuleDocumentPath

public String getModuleDocumentPath(String modulename)

Gets the url to the documentation of the module.

Returns:

java.lang.String the url to the documentation of the module.

getModuleFiles

public int getModuleFiles(String modulename,
                          Vector retNames,
                          Vector retCodes)

Returns all filenames and hashcodes belonging to the module.

Parameters:

retNames - the names of the resources belonging to the module.

retCodes - the hashcodes of the resources belonging to the module.

Returns:

the amount of entrys.

getModuleMaintenanceEventClass

public Class getModuleMaintenanceEventClass(String modulname)

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

Returns:

java.lang.Class that receives all maintenance-events for the module.

getModuleMaintenanceEventName

public String getModuleMaintenanceEventName(String modulname)

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

Returns:

java.lang.Class that receives all maintenance-events for the module.

getModuleNames

public Enumeration getModuleNames()

Returns the names of all available modules.

Returns:

String[] the names of all available modules.

getModuleNiceName

public String getModuleNiceName(String module)

Gets the nice name of the module.

Returns:

String the nice name of the module.

getModuleParameter

public String getModuleParameter(String modulename,
                                 String parameter)

Gets a parameter for a module.

Parameters:

modulename - java.lang.String the name of the module.

parameter - java.lang.String the name of the parameter to set.

Returns:

value java.lang.String the value to set for the parameter.

getModuleParameterBoolean

public boolean getModuleParameterBoolean(String modulname,
                                         String parameter)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterBoolean

public Boolean getModuleParameterBoolean(String modulname,
                                         String parameter,
                                         Boolean defaultValue)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterBoolean

public boolean getModuleParameterBoolean(String modulname,
                                         String parameter,
                                         boolean defaultValue)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterByte

public byte getModuleParameterByte(String modulname,
                                   String parameter)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterByte

public byte getModuleParameterByte(String modulname,
                                   String parameter,
                                   byte defaultValue)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterByte

public Byte getModuleParameterByte(String modulname,
                                   String parameter,
                                   Byte defaultValue)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterDescription

public String getModuleParameterDescription(String modulname,
                                            String parameter)

Returns a description for parameter in a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

String the description for the parameter in the module.

getModuleParameterDouble

public double getModuleParameterDouble(String modulname,
                                       String parameter)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterDouble

public double getModuleParameterDouble(String modulname,
                                       String parameter,
                                       double defaultValue)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterDouble

public Double getModuleParameterDouble(String modulname,
                                       String parameter,
                                       Double defaultValue)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterFloat

public float getModuleParameterFloat(String modulname,
                                     String parameter)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterFloat

public float getModuleParameterFloat(String modulname,
                                     String parameter,
                                     float defaultValue)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterFloat

public Float getModuleParameterFloat(String modulname,
                                     String parameter,
                                     Float defaultValue)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterInteger

public int getModuleParameterInteger(String modulname,
                                     String parameter)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterInteger

public int getModuleParameterInteger(String modulname,
                                     String parameter,
                                     int defaultValue)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterInteger

public Integer getModuleParameterInteger(String modulname,
                                         String parameter,
                                         Integer defaultValue)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterLong

public long getModuleParameterLong(String modulname,
                                   String parameter)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterLong

public long getModuleParameterLong(String modulname,
                                   String parameter,
                                   long defaultValue)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterLong

public Long getModuleParameterLong(String modulname,
                                   String parameter,
                                   Long defaultValue)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterNames

public String[] getModuleParameterNames(String modulename)

Gets all parameter-names for a module.

Parameters:

modulename - String the name of the module.

Returns:

value String[] the names of the parameters for a module.

getModuleParameterString

public String getModuleParameterString(String modulname,
                                       String parameter)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterString

public String getModuleParameterString(String modulname,
                                       String parameter,
                                       String defaultValue)

Returns a parameter for a module.

Parameters:

modulname - String the name of the module.

parameter - String the name of the parameter.

Returns:

boolean the value for the parameter in the module.

getModuleParameterType

public String getModuleParameterType(String modulename,
                                     String parameter)

This method returns the type of a parameter in a module.

Parameters:

modulename - the name of the module.

parameter - the name of the parameter.

Returns:

the type of the parameter.

getModuleRepositories

public String[] getModuleRepositories(String modulename)

Returns all repositories for a module.

Returns:

java.lang.String[] the reprositories of a module.

getModuleUploadDate

public long getModuleUploadDate(String modulename)

Returns the upload-date for the module.

Returns:

java.lang.String the upload-date for the module.

getModuleUploadedBy

public String getModuleUploadedBy(String module)

Returns the user-name of the user who had uploaded the module.

Returns:

java.lang.String the user-name of the user who had uploaded the module.

getModuleVersion

public float getModuleVersion(String modulename)

This method returns the version of the module.

Returns:

java.lang.String the version of the module.

getModuleViewName

public String getModuleViewName(String modulename)

Returns the name of the view, that is implemented by the module.

Returns:

java.lang.String the name of the view, that is implemented by the module.

getModuleViewUrl

public String getModuleViewUrl(String modulename)

Returns the url to the view-url for the module within the system.

Returns:

java.lang.String the view-url to the module.

getModuleLifeCycle

public int getModuleLifeCycle(Vector classes)

Returns all lifecycle classes for all modules.

Returns:

int the amount of classes.

getModulePublishClass

public String getModulePublishClass(String modulname)

Returns the name of the class, that contains the publish method of the module.

Returns:

java.lang.Class that contains the publish method of the module.

getModulePublishables

public int getModulePublishables(Vector classes,
                                 String requiredMethod)

Returns all publishable classes for all modules.

Returns:

int the amount of classess.

getModuleExportables

public int getModuleExportables(Hashtable classes)

Returns all exportable classes for all modules.

Returns:

int the amount of classes.

getRepositories

public String[] getRepositories()

Returns all repositories for all modules.

Returns:

java.lang.String[] the reprositories of all modules.

getResourceTypes

public int getResourceTypes(Vector names,
                            Vector launcherTypes,
                            Vector launcherClass,
                            Vector resourceClass)

Returns all Resourcetypes and korresponding parameter for System and all modules.

Returns:

int the amount of resourcetypes.

getSystemValue

public String getSystemValue(String key)

Returns a value for a system-key. E.g. <system><mailserver>mail.server.com</mailserver></system> can be requested via getSystemValue("mailserver"); and returns "mail.server.com.

Returns:

the value for that system-key.

getSystemValues

public Hashtable getSystemValues(String key)

Returns a vector of value for a system-key.

Returns:

the values for that system-key.

getSystemElement

public Element getSystemElement()

Return the XML "system" node Element from the registry for further processing in another class.

Returns:

the system node.

getViews

public int getViews(Vector views,
                    Vector urls)

Returns all views and korresponding urls for all modules.

Returns:

int the amount of views.

importCheckDependencies

public Vector importCheckDependencies(String moduleZip,
                                      boolean replaceMode)
                               throws CmsException

Checks the dependencies for a new or replaced module.

Parameters:

moduleZip - the name of the zipfile for the new module.

replaceMode - if true this is for module replacement, if false it is form module deletion

Returns:

a Vector with dependencies that are not fullfilled.

CmsException

importGetConflictingFileNames

public Vector importGetConflictingFileNames(String moduleZip)
                                     throws CmsException

Checks for files that already exist in the system but should be replaced by the module.

Parameters:

moduleZip - The name of the zip-file to import.

Returns:

The complete paths to the resources that have conflicts.

CmsException

importGetModuleInfo

public Map importGetModuleInfo(String moduleZip)

Returns the name of the module to be imported.

Parameters:

moduleZip - the name of the zip-file to import from.

Returns:

The name of the module to be imported.

importGetResourcesForProject

public Vector importGetResourcesForProject(String moduleZip)
                                    throws CmsException

Returns all files that are needed to create a project for the module-import.

Parameters:

moduleZip - The name of the zip-file to import.

Returns:

The complete paths for resources that should be in the import-project.

CmsException

importModule

public void importModule(String moduleZip,
                         Vector exclusion,
                         I_CmsReport report)
                  throws CmsException

Imports a module. This method is synchronized, so only one module can be imported at on time.

Parameters:

moduleZip - the name of the zip-file to import from.

exclusion - a Vector with resource-names that should be excluded from this import.

CmsException

moduleExists

public boolean moduleExists(String modulename)

Checks if the module exists already in the repository.

Returns:

true if the module exists, else false.

setModuleAuthor

public void setModuleAuthor(String modulename,
                            String author)
                     throws CmsException

This method sets the author of the module.

CmsException

setModuleAuthorEmail

public void setModuleAuthorEmail(String modulename,
                                 String email)
                          throws CmsException

This method sets the email of author of the module.

CmsException

setModuleCreateDate

public void setModuleCreateDate(String modulname,
                                long createdate)
                         throws CmsException

Sets the create date of the module.

CmsException

setModuleCreateDate

public void setModuleCreateDate(String modulname,
                                String createdate)
                         throws CmsException

Sets the create date of the module.

CmsException

setModuleDependencies

public void setModuleDependencies(String modulename,
                                  Vector modules,
                                  Vector minVersions,
                                  Vector maxVersions)
                           throws CmsException

Sets the module dependencies for the module.

Parameters:

modules - Vector in this parameter the names of the dependend modules will be returned.

minVersions - Vector in this parameter the minimum versions of the dependend modules will be returned.

maxVersions - Vector in this parameter the maximum versions of the dependend modules will be returned.

CmsException

setModuleDescription

public void setModuleDescription(String module,
                                 String description)
                          throws CmsException

Sets the description of the module.

CmsException

setModuleDocumentPath

public void setModuleDocumentPath(String modulename,
                                  String url)
                           throws CmsException

Sets the url to the documentation of the module.

CmsException

setModuleMaintenanceEventClass

public void setModuleMaintenanceEventClass(String modulname,
                                           String classname)
                                    throws CmsException

Sets the classname, that receives all maintenance-events for the module.

CmsException

setModulePublishClass

public void setModulePublishClass(String modulname,
                                  String classname)
                           throws CmsException

Sets the classname, that contains the publish method of the module.

CmsException

setModuleNiceName

public void setModuleNiceName(String module,
                              String nicename)
                       throws CmsException

Sets the description of the module.

CmsException

setModuleParameter

public void setModuleParameter(String modulename,
                               String parameter,
                               byte value)
                        throws CmsException

Sets a parameter for a module.

Parameters:

modulename - java.lang.String the name of the module.

parameter - java.lang.String the name of the parameter to set.

CmsException

setModuleParameter

public void setModuleParameter(String modulename,
                               String parameter,
                               double value)
                        throws CmsException

Sets a parameter for a module.

Parameters:

modulename - java.lang.String the name of the module.

parameter - java.lang.String the name of the parameter to set.

CmsException

setModuleParameter

public void setModuleParameter(String modulename,
                               String parameter,
                               float value)
                        throws CmsException

Sets a parameter for a module.

Parameters:

modulename - java.lang.String the name of the module.

parameter - java.lang.String the name of the parameter to set.

CmsException

setModuleParameter

public void setModuleParameter(String modulename,
                               String parameter,
                               int value)
                        throws CmsException

Sets a parameter for a module.

Parameters:

modulename - java.lang.String the name of the module.

parameter - java.lang.String the name of the parameter to set.

CmsException

setModuleParameter

public void setModuleParameter(String modulename,
                               String parameter,
                               long value)
                        throws CmsException

Sets a parameter for a module.

Parameters:

modulename - java.lang.String the name of the module.

parameter - java.lang.String the name of the parameter to set.

CmsException

setModuleParameter

public void setModuleParameter(String modulename,
                               String parameter,
                               Boolean value)
                        throws CmsException

Sets a parameter for a module.

Parameters:

modulename - java.lang.String the name of the module.

parameter - java.lang.String the name of the parameter to set.

CmsException

setModuleParameter

public void setModuleParameter(String modulename,
                               String parameter,
                               Byte value)
                        throws CmsException

Sets a parameter for a module.

Parameters:

modulename - java.lang.String the name of the module.

parameter - java.lang.String the name of the parameter to set.

CmsException

setModuleParameter

public void setModuleParameter(String modulename,
                               String parameter,
                               Double value)
                        throws CmsException

Sets a parameter for a module.

Parameters:

modulename - java.lang.String the name of the module.

parameter - java.lang.String the name of the parameter to set.

CmsException

setModuleParameter

public void setModuleParameter(String modulename,
                               String parameter,
                               Float value)
                        throws CmsException

Sets a parameter for a module.

Parameters:

modulename - java.lang.String the name of the module.

parameter - java.lang.String the name of the parameter to set.

CmsException

setModuleParameter

public void setModuleParameter(String modulename,
                               String parameter,
                               Integer value)
                        throws CmsException

Sets a parameter for a module.

Parameters:

modulename - java.lang.String the name of the module.

parameter - java.lang.String the name of the parameter to set.

CmsException

setModuleParameter

public void setModuleParameter(String modulename,
                               String parameter,
                               Long value)
                        throws CmsException

Sets a parameter for a module.

Parameters:

modulename - java.lang.String the name of the module.

parameter - java.lang.String the name of the parameter to set.

CmsException

setModuleParameter

public void setModuleParameter(String modulename,
                               String parameter,
                               String value)
                        throws CmsException

Sets a parameter for a module.

Parameters:

modulename - java.lang.String the name of the module.

parameter - java.lang.String the name of the parameter to set.

value - java.lang.String the value to set for the parameter.

CmsException

setModuleParameter

public void setModuleParameter(String modulename,
                               String parameter,
                               boolean value)
                        throws CmsException

Sets a parameter for a module.

Parameters:

modulename - java.lang.String the name of the module.

parameter - java.lang.String the name of the parameter to set.

CmsException

setModuleParameterdef

public void setModuleParameterdef(String modulename,
                                  Vector names,
                                  Vector descriptions,
                                  Vector types,
                                  Vector values)
                           throws CmsException

Sets the module dependencies for the module.

Parameters:

names - Vector with parameternames

descriptions - Vector with parameterdescriptions

types - Vector with parametertypes (string, float,...)

values - Vector with defaultvalues for parameters

CmsException

setModuleRepositories

public void setModuleRepositories(String modulename,
                                  String[] repositories)
                           throws CmsException

Sets all repositories for a module.

CmsException

setModuleVersion

public void setModuleVersion(String modulename,
                             String version)
                      throws CmsException

This method sets the version of the module.

Parameters:

modulename - the name of the module.

version - the version of the module.

CmsException

setModuleView

public void setModuleView(String modulename,
                          String viewname,
                          String viewurl)
                   throws CmsException

Sets a view for a module

CmsException

setSystemValue

public void setSystemValue(String dataName,
                           String value)
                    throws CmsException

Public method to set system values.

CmsException

setSystemValues

public void setSystemValues(String dataName,
                            Hashtable values)
                     throws CmsException

Public method to set system values with hashtable.

CmsException

getExportpoints

public Hashtable getExportpoints()

Returns all exportpoints and paths.

Returns:

Hashtable The exportpoints and the paths.

getModuleType

public String getModuleType(String theModulename)

Returns the value of the "type" node of a module subtree in the registry.

Returns:

the value of the "type" node of a module

setModuleType

public void setModuleType(String theModulename,
                          String theModuleType)

Sets the type for a given module.

Parameters:

theModuleType - the new type of the module