I_CmsResourceBroker (Release 5.0.0)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.opencms.file
Interface I_CmsResourceBroker

All Known Implementing Classes:: CmsResourceBroker

public interface I_CmsResourceBroker

This interface describes THE resource broker. All DB-specific access modules must implement this interface. The interface is local to package. All methods get additional parameters (callingUser and currentproject) to check the security- police.

Version:: $Revision: 1.201 $ $Date: 2003/04/01 15:20:18 $
Author:: Michael Emmerich

Method Summary

void acceptTask(CmsUser currentUser, CmsProject currentProject, int taskId)
          Accept a task from the Cms.

boolean accessCreate(CmsUser currentUser, CmsProject currentProject, String resourceName)
          Checks, if the user may create this resource.

boolean accessLock(CmsUser currentUser, CmsProject currentProject, String resourceName)
          Checks, if the user may lock this resource.

boolean accessProject(CmsUser currentUser, CmsProject currentProject, int projectId)
          Tests if the user can access the project.

boolean accessRead(CmsUser currentUser, CmsProject currentProject, String resourceName)
          Checks, if the user may read this resource.

boolean accessReadVisible(CmsUser currentUser, CmsProject currentProject, CmsResource resource)
          Checks, if the user may read this resource and if it is visible to him.

boolean accessWrite(CmsUser currentUser, CmsProject currentProject, String resourceName)
          Checks, if the user may write this resource.

void addFileExtension(CmsUser currentUser, CmsProject currentProject, String extension, String resTypeName)
          adds a file extension to the list of known file extensions Security: Users, which are in the group "administrators" are granted.

CmsGroup addGroup(CmsUser currentUser, CmsProject currentProject, String name, String description, int flags, String parent)
          Add a new group to the Cms.

CmsUser addImportUser(CmsUser currentUser, CmsProject currentProject, String name, String password, String recoveryPassword, String description, String firstname, String lastname, String email, int flags, Hashtable additionalInfos, String defaultGroup, String address, String section, int type)
          Adds a user to the Cms by import.

CmsUser addUser(CmsObject cms, CmsUser currentUser, CmsProject currentProject, String name, String password, String group, String description, Hashtable additionalInfos, int flags)
          Adds a user to the Cms.

void addUserToGroup(CmsUser currentUser, CmsProject currentProject, String username, String groupname)
          Adds a user to a group.

CmsUser addWebUser(CmsObject cms, CmsUser currentUser, CmsProject currentProject, String name, String password, String group, String description, Hashtable additionalInfos, int flags)
          Adds a web user to the Cms.

CmsUser addWebUser(CmsObject cms, CmsUser currentUser, CmsProject currentProject, String name, String password, String group, String additionalGroup, String description, Hashtable additionalInfos, int flags)
          Adds a web user to the Cms.

CmsUser anonymousUser(CmsUser currentUser, CmsProject currentProject)
          Returns the anonymous user object.

void backupProject(int projectId, int versionId, long publishDate, CmsUser currentUser)
          Creates a backup of the published project

void changeLockedInProject(int projectId, String resourcename, CmsUser currentUser)
          Changes the project-id of a resource to the new project for publishing the resource directly

void changeUserType(CmsUser currentUser, CmsProject currentProject, CmsUser user, int userType)
          Changes the user type of the user Only the administrator can change the type

void changeUserType(CmsUser currentUser, CmsProject currentProject, int userId, int userType)
          Changes the user type of the user Only the administrator can change the type

void changeUserType(CmsUser currentUser, CmsProject currentProject, String username, int userType)
          Changes the user type of the user Only the administrator can change the type

void chgrp(CmsUser currentUser, CmsProject currentProject, String filename, String newGroup)
          Changes the group for this resource
Only the group of a resource in an offline project can be changed.

void chmod(CmsUser currentUser, CmsProject currentProject, String filename, int flags)
          Changes the flags for this resource.

void chown(CmsUser currentUser, CmsProject currentProject, String filename, String newOwner)
          Changes the owner for this resource.

void chstate(CmsUser currentUser, CmsProject currentProject, String filename, int state)
          Changes the state for this resource
The user may change this, if he is admin of the resource.

void chtype(CmsUser currentUser, CmsProject currentProject, String filename, String newType)
          Changes the resourcetype for this resource
Only the resourcetype of a resource in an offline project can be changed.

void clearcache()
          Clears all internal DB-Caches.

void copyFile(CmsUser currentUser, CmsProject currentProject, String source, String destination)
          Copies a file in the Cms.

void copyFolder(CmsUser currentUser, CmsProject currentProject, String source, String destination)
          Copies a folder in the Cms.

void copyResourceToProject(CmsUser currentUser, CmsProject currentProject, String resource)
          Copies a resource from the online project to a new, specified project.

int countLockedResources(CmsUser currentUser, CmsProject currentProject, int id)
          Counts the locked resources in this project.

CmsProject createDirectPublishProject(CmsUser currentUser, CmsProject currentProject, String name, String description, String groupname, String managergroupname, int projecttype)
          Creates a project for the direct publish.

CmsFile createFile(CmsUser currentUser, CmsGroup currentGroup, CmsProject currentProject, String newFileName, byte[] contents, String type, Map propertyinfos)
          Creates a new file with the given content and resourcetype.

CmsFolder createFolder(CmsUser currentUser, CmsGroup currentGroup, CmsProject currentProject, String folderName, Map propertyinfos)
          Creates a new folder.

void createLinkEntrys(int pageId, Vector linkTargets)
          creates a link entry for each of the link targets in the linktable.

void createOnlineLinkEntrys(int pageId, Vector linkTarget)
          creates a link entry for each of the link targets in the online linktable.

CmsProject createProject(CmsUser currentUser, CmsProject currentProject, String name, String description, String groupname, String managergroupname)
          Creates a project.

CmsProject createProject(CmsUser currentUser, CmsProject currentProject, String name, String description, String groupname, String managergroupname, int projecttype)
          Creates a project.

CmsTask createProject(CmsUser currentUser, String projectname, int projectType, String roleName, long timeout, int priority)
          Creates a new project for task handling.

CmsPropertydefinition createPropertydefinition(CmsUser currentUser, CmsProject currentProject, String name, String resourcetype)
          Creates the propertydefinition for the resource type.

CmsTask createTask(CmsUser currentUser, CmsProject currentProject, String agentName, String roleName, String taskname, String taskcomment, long timeout, int priority)
          Creates a new task.

CmsTask createTask(CmsUser currentUser, int projectid, String agentName, String roleName, String taskname, String taskcomment, int tasktype, long timeout, int priority)
          Creates a new task.

CmsProject createTempfileProject(CmsObject cms, CmsUser currentUser, CmsProject currentProject)
          Creates a project for the temporary files.

int decrementLinkCountForResource(CmsProject theProject, String theResourceName)
          Decrement the VFS link counter for a resource.

void deleteAllProperties(CmsUser currentUser, CmsProject currentProject, String resource)
          Deletes all propertyinformation for a file or folder.

int deleteBackups(CmsObject cms, CmsUser currentUser, CmsProject currentProject, int weeks)
          Deletes the versions from the backup tables that are older then the given weeks

void deleteExportLink(CmsExportLink link)
          Deletes an exportlink in the database.

void deleteExportLink(String link)
          Deletes an exportlink in the database.

void deleteFile(CmsUser currentUser, CmsProject currentProject, String filename)
          Deletes a file in the Cms.

void deleteFolder(CmsUser currentUser, CmsProject currentProject, String foldername)
          Deletes a folder in the Cms.

void deleteGroup(CmsUser currentUser, CmsProject currentProject, String delgroup)
          Delete a group from the Cms.

void deleteLinkEntrys(int pageId)
          deletes all entrys in the link table that belong to the pageId

void deleteOnlineLinkEntrys(int pageId)
          deletes all entrys in the online link table that belong to the pageId

void deleteProject(CmsUser currentUser, CmsProject currentProject, int id)
          Deletes a project.

void deleteProperty(CmsUser currentUser, CmsProject currentProject, String resource, String property)
          Deletes a propertyinformation for a file or folder.

void deletePropertydefinition(CmsUser currentUser, CmsProject currentProject, String name, String resourcetype)
          Delete the propertydefinition for the resource type.

void deleteUser(CmsUser currentUser, CmsProject currentProject, int userId)
          Deletes a user from the Cms.

void deleteUser(CmsUser currentUser, CmsProject currentProject, String username)
          Deletes a user from the Cms.

void deleteWebUser(CmsUser currentUser, CmsProject currentProject, int userId)
          Deletes a web user from the Cms.

void destroy()
          Destroys the resource borker and required modules and connections.

String digest(String value)
          Method to encrypt the passwords.

void endTask(CmsUser currentUser, CmsProject currentProject, int taskid)
          Ends a task from the Cms.

void exportModuledata(CmsUser currentUser, CmsProject currentProject, String exportFile, String[] exportChannels, String[] exportModules, CmsObject cms, I_CmsReport report)
          Exports channels and moduledata to zip.

void exportResources(CmsUser currentUser, CmsProject currentProject, String exportFile, String[] exportPaths, CmsObject cms)
          Exports cms-resources to zip.

void exportResources(CmsUser currentUser, CmsProject currentProject, String exportFile, String[] exportPaths, CmsObject cms, boolean includeSystem, boolean excludeUnchanged)
          Exports cms-resources to zip.

void exportResources(CmsUser currentUser, CmsProject currentProject, String exportFile, String[] exportPaths, CmsObject cms, boolean includeSystem, boolean excludeUnchanged, boolean exportUserdata, long contentAge, I_CmsReport report)
          Exports cms-resources to zip.

void exportStaticResources(CmsUser currentUser, CmsProject currentProject, CmsObject cms, Vector linksToExport)
          Creates a static export in the filesystem.

void exportStaticResources(CmsUser currentUser, CmsProject currentProject, CmsObject cms, Vector startpoints, Vector projectResources, Vector allExportedLinks, CmsPublishedResources changedResources, I_CmsReport report)
          Creates a static export of a Cmsresource in the filesystem

ArrayList fetchVfsLinksForResource(CmsUser theUser, CmsProject theProject, String theResourceName)
          Fetches all VFS links pointing to a given resource name.

void forwardTask(CmsUser currentUser, CmsProject currentProject, int taskid, String newRoleName, String newUserName)
          Forwards a task to a new user.

Vector getAllAccessibleProjects(CmsUser currentUser, CmsProject currentProject)
          Returns all projects, which are owned by the user or which are accessible for the group of the user.

Vector getAllBackupProjects()
          Returns a Vector with all projects from history

Vector getAllExportLinks()
          Returns a Vector with all export links

Vector getAllManageableProjects(CmsUser currentUser, CmsProject currentProject)
          Returns all projects, which are owned by the user or which are manageable for the group of the user.

Hashtable getAllResourceTypes(CmsUser currentUser, CmsProject currentProject)
          Returns a Vector with all I_CmsResourceTypes.

int getBackupVersionId()
          Get the next version id for the published backup resources

void getBrokenLinks(int projectId, I_CmsReport report, Vector changed, Vector deleted, Vector newRes)
          checks a project for broken links that would appear if the project is published.

Hashtable getCacheInfo()
          Returns informations about the cache.

Vector getChild(CmsUser currentUser, CmsProject currentProject, String groupname)
          Returns all child groups of a group
Security: All users are granted, except the anonymous user.

Vector getChilds(CmsUser currentUser, CmsProject currentProject, String groupname)
          Returns all child groups of a group
This method also returns all sub-child groups of the current group.

source.org.apache.java.util.Configurations getConfigurations(CmsUser currentUser, CmsProject currentProject)
          Method to access the configurations of the properties-file.

Vector getDependingExportLinks(Vector res)
          Reads all export links that depend on the resource.

Vector getDirectGroupsOfUser(CmsUser currentUser, CmsProject currentProject, String username)
          Returns the list of groups to which the user directly belongs to
Security: All users are granted.

Vector getFilesInFolder(CmsUser currentUser, CmsProject currentProject, String foldername)
          Returns a Vector with all files of a folder.

Vector getFilesInFolder(CmsUser currentUser, CmsProject currentProject, String foldername, boolean includeDeleted)
          Returns a Vector with all files of a folder.

Vector getFilesWithProperty(CmsUser currentUser, CmsProject currentProject, String propertyDefinition, String propertyValue)
          Returns a Vector with all resource-names that have set the given property to the given value.

long getFileSystemChanges(CmsUser currentUser, CmsProject currentProject)
          This method can be called, to determine if the file-system was changed in the past.

long getFileSystemFolderChanges(CmsUser currentUser, CmsProject currentProject)
          This method can be called, to determine if the file-system was changed(only Folders) in the past.

Vector getFolderTree(CmsUser currentUser, CmsProject currentProject, String rootName)
          Returns a Vector with the complete folder-tree for this project.

Vector getGroups(CmsUser currentUser, CmsProject currentProject)
          Returns all groups
Security: All users are granted, except the anonymous user.

Vector getGroupsOfUser(CmsUser currentUser, CmsProject currentProject, String username)
          Returns a list of groups of a user.

int getLimitedWorkplacePort()
          This is the port the workplace access is limited to.

Vector getOnlineBrokenLinks()
          serches for broken links in the online project.

CmsGroup getParent(CmsUser currentUser, CmsProject currentProject, String groupname)
          Returns the parent group of a group
Security: All users are granted, except the anonymous user.

CmsResource getParentResource(CmsUser currentUser, CmsProject currentProject, String resourcename)
          Returns the parent resource of a resouce.

String getReadingpermittedGroup(int projectId, String resource)
          Checks which Group can read the resource and all the parent folders.

I_CmsRegistry getRegistry(CmsUser currentUser, CmsProject currentProject, CmsObject cms)
          Gets the Registry.

Vector getResourcesInFolder(CmsUser currentUser, CmsProject currentProject, String folder)
          Returns a Vector with the subresources for a folder.

Vector getResourcesWithProperty(CmsUser currentUser, CmsProject currentProject, String propertyDefinition)
          Returns a Vector with all resources of the given type that have set the given property to the given value.

Vector getResourcesWithProperty(CmsUser currentUser, CmsProject currentProject, String propertyDefinition, String propertyValue, int resourceType)
          Returns a Vector with all resources of the given type that have set the given property to the given value.

I_CmsResourceType getResourceType(CmsUser currentUser, CmsProject currentProject, int resourceType)
          Returns a CmsResourceTypes.

I_CmsResourceType getResourceType(CmsUser currentUser, CmsProject currentProject, String resourceType)
          Returns a CmsResourceTypes.

Vector getSubFolders(CmsUser currentUser, CmsProject currentProject, String foldername)
          Returns a Vector with all subfolders.

Vector getSubFolders(CmsUser currentUser, CmsProject currentProject, String foldername, boolean includeDeleted)
          Returns a Vector with all subfolders.

String getTaskPar(CmsUser currentUser, CmsProject currentProject, int taskid, String parname)
          Get a parameter value for a task.

int getTaskType(String taskname)
          Get the template task id fo a given taskname.

Vector getUsers(CmsUser currentUser, CmsProject currentProject)
          Returns all users
Security: All users are granted, except the anonymous user.

Vector getUsers(CmsUser currentUser, CmsProject currentProject, int type)
          Returns all users from a given type
Security: All users are granted, except the anonymous user.

Vector getUsers(CmsUser currentUser, CmsProject currentProject, int type, String namestart)
          Returns all users from a given type that start with a specified string
Security: All users are granted, except the anonymous user.

Vector getUsersByLastname(CmsUser currentUser, CmsProject currentProject, String Lastname, int UserType, int UserStatus, int wasLoggedIn, int nMax)
          Gets all users with a certain Lastname.

Vector getUsersOfGroup(CmsUser currentUser, CmsProject currentProject, String groupname)
          Returns a list of users in a group.

Vector getVisibleResourcesWithProperty(CmsUser currentUser, CmsProject currentProject, String propertyDefinition, String propertyValue, int resourceType)
          Returns a Vector with all resources of the given type that have set the given property to the given value.

void importFolder(CmsUser currentUser, CmsProject currentProject, String importFile, String importPath, CmsObject cms)
          Imports a import-resource (folder or zipfile) to the cms.

CmsResource importResource(CmsUser currentUser, CmsProject currentProject, String newResourceName, int resourceType, Map propertyinfos, int launcherType, String launcherClassname, String ownername, String groupname, int accessFlags, long lastmodified, byte[] filecontent)
          Creates a new resource.

void importResources(CmsUser currentUser, CmsProject currentProject, String importFile, String importPath, CmsObject cms, I_CmsReport report)
          Imports a import-resource (folder or zipfile) to the cms.

int incrementLinkCountForResource(CmsProject theProject, String theResourceName)
          Increment the VFS link counter for a resource.

void init(source.org.apache.java.util.Configurations config)
          Initializes the resource broker and sets up all required modules and connections.

boolean isAdmin(CmsUser currentUser, CmsProject currentProject)
          Determines, if the users current group is the admin-group.

boolean isHistoryEnabled(CmsObject cms)
          Check if the history is enabled

boolean isManagerOfProject(CmsUser currentUser, CmsProject currentProject)
          Determines, if the users may manage a project.

boolean isProjectManager(CmsUser currentUser, CmsProject currentProject)
          Determines, if the users current group is the projectleader-group.

ArrayList joinLinksToTargets(CmsObject cms, CmsUser theUser, CmsProject theProject, I_CmsReport theReport)
          Rebuilds the internal datastructure to join links with their targets.

void linkResourceToTarget(CmsProject theProject, String theLinkResourceName, String theTargetResourceName)
          Save the ID of the target resource for a VFS link.

CmsUser lockedBy(CmsUser currentUser, CmsProject currentProject, CmsResource resource)
          Returns the user, who had locked the resource.

CmsUser lockedBy(CmsUser currentUser, CmsProject currentProject, String resource)
          Returns the user, who had locked the resource.

void lockResource(CmsUser currentUser, CmsProject currentProject, String resourcename, boolean force)
          Locks a resource.

CmsUser loginUser(CmsUser currentUser, CmsProject currentProject, String username, String password)
          Logs a user into the Cms, if the password is correct.

CmsUser loginWebUser(CmsUser currentUser, CmsProject currentProject, String username, String password)
          Logs a web user into the Cms, if the password is correct.

void moveFile(CmsUser currentUser, CmsProject currentProject, String source, String destination)
          Moves the file.

CmsProject onlineProject(CmsUser currentUser, CmsProject currentProject)
          Returns the onlineproject.

CmsPublishedResources publishProject(CmsObject cms, CmsUser currentUser, CmsProject currentProject, int id, I_CmsReport report)
          Publishes a project.

CmsUser readAgent(CmsUser currentUser, CmsProject currentProject, CmsTask task)
          Reads the agent of a task from the OpenCms.

Vector readAllFileHeaders(CmsUser currentUser, CmsProject currentProject, String filename)
          Reads all file headers of a file in the OpenCms.

Vector readAllFileHeadersForHist(CmsUser currentUser, CmsProject currentProject, String filename)
          Reads all file headers of a file in the OpenCms.

Vector readAllProjectResources(int projectId)
          select all projectResources from an given project

Vector readAllPropertydefinitions(CmsUser currentUser, CmsProject currentProject, int resourcetype)
          Reads all propertydefinitions for the given resource type.

Vector readAllPropertydefinitions(CmsUser currentUser, CmsProject currentProject, String resourcetype)
          Reads all propertydefinitions for the given resource type.

CmsBackupProject readBackupProject(CmsUser currentUser, CmsProject currentProject, int versionId)
          Reads the backup of a project from the Cms.

String readCronTable(CmsUser currentUser, CmsProject currentProject)
          Gets the Crontable.

CmsExportLink readExportLink(String filename)
          Reads a exportrequest from the Cms.

CmsExportLink readExportLinkHeader(String request)
          Reads a exportrequest without the dependencies from the Cms.

String readExportPath(CmsUser currentUser, CmsProject currentProject)
          Reads the export-path for the system.

CmsFile readFile(CmsUser currentUser, CmsProject currentProject, String filename)
          Reads a file from the Cms.

CmsFile readFile(CmsUser currentUser, CmsProject currentProject, String filename, boolean includeDeleted)
          Reads a file from the Cms.

Hashtable readFileExtensions(CmsUser currentUser, CmsProject currentProject)
          Gets the known file extensions (=suffixes) Security: All users are granted access

CmsBackupResource readFileForHist(CmsUser currentUser, CmsProject currentProject, int versionId, String filename)
          Reads a file from the history of the Cms.

CmsResource readFileHeader(CmsUser currentUser, CmsProject currentProject, int projectId, String filename)
          Reads a file header a previous project of the Cms.

CmsResource readFileHeader(CmsUser currentUser, CmsProject currentProject, String filename)
          Reads a file header from the Cms.

CmsResource readFileHeader(CmsUser currentUser, CmsProject currentProject, String filename, boolean includeDeleted)
          Reads a file header from the Cms.

CmsBackupResource readFileHeaderForHist(CmsUser currentUser, CmsProject currentProject, int versionId, String filename)
          Reads a file header from the history of the Cms.

Vector readFileHeaders(CmsUser currentUser, CmsProject currentProject, int projectId)
          Reads all file headers for a project from the Cms.

Vector readFilesByType(CmsUser currentUser, CmsProject currentProject, int projectId, int resourcetype)
          Reads all files from the Cms, that are of the given type.

CmsFolder readFolder(CmsUser currentUser, CmsProject currentProject, int folderid, boolean includeDeleted)
          Reads a folder from the Cms.

CmsFolder readFolder(CmsUser currentUser, CmsProject currentProject, String folder)
          Reads a folder from the Cms.

CmsFolder readFolder(CmsUser currentUser, CmsProject currentProject, String folder, boolean includeDeleted)
          Reads a folder from the Cms.

Vector readGivenTasks(CmsUser currentUser, CmsProject currentProject, int projectId, String ownerName, int taskType, String orderBy, String sort)
          Reads all given tasks from a user for a project.

CmsGroup readGroup(CmsUser currentUser, CmsProject currentProject, CmsProject project)
          Reads the group of a project from the OpenCms.

CmsGroup readGroup(CmsUser currentUser, CmsProject currentProject, CmsResource resource)
          Reads the group of a resource from the OpenCms.

CmsGroup readGroup(CmsUser currentUser, CmsProject currentProject, CmsTask task)
          Reads the group (role) of a task from the OpenCms.

CmsGroup readGroup(CmsUser currentUser, CmsProject currentProject, int groupid)
          Returns a group object.

CmsGroup readGroup(CmsUser currentUser, CmsProject currentProject, String groupname)
          Returns a group object.

Hashtable readLinkCheckTable(CmsUser currentUser, CmsProject currentProject)
          Gets the Linkchecktable.

Vector readLinkEntrys(int pageId)
          returns a Vector (Strings) with the link destinations of all links on the page with the pageId.

CmsGroup readManagerGroup(CmsUser currentUser, CmsProject currentProject, CmsProject project)
          Reads the managergroup of a project from the OpenCms.

Hashtable readMimeTypes(CmsUser currentUser, CmsProject currentProject)
          Gets the MimeTypes.

Vector readOnlineLinkEntrys(int pageId)
          returns a Vector (Strings) with the link destinations of all links on the page with the pageId.

CmsUser readOriginalAgent(CmsUser currentUser, CmsProject currentProject, CmsTask task)
          Reads the original agent of a task from the OpenCms.

CmsUser readOwner(CmsUser currentUser, CmsProject currentProject, CmsProject project)
          Reads the owner of a project from the OpenCms.

CmsUser readOwner(CmsUser currentUser, CmsProject currentProject, CmsResource resource)
          Reads the owner of a resource from the OpenCms.

CmsUser readOwner(CmsUser currentUser, CmsProject currentProject, CmsTask task)
          Reads the owner (initiator) of a task from the OpenCms.

CmsUser readOwner(CmsUser currentUser, CmsProject currentProject, CmsTaskLog log)
          Reads the owner of a tasklog from the OpenCms.

CmsProject readProject(CmsUser currentUser, CmsProject currentProject, CmsResource res)
          Reads a project from the Cms.

CmsProject readProject(CmsUser currentUser, CmsProject currentProject, CmsTask task)
          Reads a project from the Cms.

CmsProject readProject(CmsUser currentUser, CmsProject currentProject, int id)
          Reads a project from the Cms.

Vector readProjectLogs(CmsUser currentUser, CmsProject currentProject, int projectId)
          Reads log entries for a project.

Vector readProjectView(CmsUser currentUser, CmsProject currentProject, int projectId, String filter)
          Reads all file headers of a project from the Cms.

Map readProperties(CmsUser currentUser, CmsProject currentProject, String resource, String siteRoot, boolean search)
          Looks up all properties for a resource with optional direcory upward cascading.

String readProperty(CmsUser currentUser, CmsProject currentProject, String resource, String siteRoot, String property, boolean search)
          Looks up a specified property with optional direcory upward cascading.

String readProperty(CmsUser currentUser, CmsProject currentProject, String resource, String siteRoot, String property, boolean search, String propertyDefault)
          Looks up a specified property with optional direcory upward cascading, a default value will be returned if the property is not found on the resource (or it's parent folders in case search is set to true).

CmsPropertydefinition readPropertydefinition(CmsUser currentUser, CmsProject currentProject, String name, String resourcetype)
          Reads a definition for the given resource type.

Vector readResources(CmsProject project)
          Insert the method's description here.

Vector readResourcesLikeName(CmsUser currentUser, CmsProject currentProject, String resourcename)
          Returns a Vector with the resources that contains the given part in the resourcename.

CmsTask readTask(CmsUser currentUser, CmsProject currentProject, int id)
          Read a task by id.

Vector readTaskLogs(CmsUser currentUser, CmsProject currentProject, int taskid)
          Reads log entries for a task.

Vector readTasksForProject(CmsUser currentUser, CmsProject currentProject, int projectId, int tasktype, String orderBy, String sort)
          Reads all tasks for a project.

Vector readTasksForRole(CmsUser currentUser, CmsProject currentProject, int projectId, String roleName, int tasktype, String orderBy, String sort)
          Reads all tasks for a role in a project.

Vector readTasksForUser(CmsUser currentUser, CmsProject currentProject, int projectId, String userName, int tasktype, String orderBy, String sort)
          Reads all tasks for a user in a project.

CmsUser readUser(CmsUser currentUser, CmsProject currentProject, int id)
          Returns a user object.

CmsUser readUser(CmsUser currentUser, CmsProject currentProject, String username)
          Returns a user object.

CmsUser readUser(CmsUser currentUser, CmsProject currentProject, String username, int type)
          Returns a user object.

CmsUser readUser(CmsUser currentUser, CmsProject currentProject, String username, String password)
          Returns a user object if the password for the user is correct.

CmsUser readWebUser(CmsUser currentUser, CmsProject currentProject, String username)
          Returns a user object if the password for the user is correct.

CmsUser readWebUser(CmsUser currentUser, CmsProject currentProject, String username, String password)
          Returns a user object if the password for the user is correct.

void reaktivateTask(CmsUser currentUser, CmsProject currentProject, int taskId)
          Reaktivates a task from the Cms.

void recoverPassword(CmsObject cms, CmsUser currentUser, CmsProject currentProject, String username, String recoveryPassword, String newPassword)
          Sets a new password only if the user knows his recovery-password.

void removeUserFromGroup(CmsUser currentUser, CmsProject currentProject, String username, String groupname)
          Removes a user from a group.

void renameFile(CmsUser currentUser, CmsProject currentProject, String oldname, String newname)
          Renames the file to a new name.

void restoreResource(CmsUser currentUser, CmsProject currentProject, int versionId, String filename)
          Restores a file in the current project with a version in the backup

Hashtable restoreSession(String oldSessionId)
          This method loads old sessiondata from the database.

void setName(CmsUser currentUser, CmsProject currentProject, int taskId, String name)
          Set a new name for a task Security: All users are granted.

void setParentGroup(CmsUser currentUser, CmsProject currentProject, String groupName, String parentGroupName)
          Sets a new parent-group for an already existing group in the Cms.

void setPassword(CmsObject cms, CmsUser currentUser, CmsProject currentProject, String username, String newPassword)
          Sets the password for a user.

void setPassword(CmsObject cms, CmsUser currentUser, CmsProject currentProject, String username, String oldPassword, String newPassword)
          Sets the password for a user.

void setPriority(CmsUser currentUser, CmsProject currentProject, int taskId, int priority)
          Set priority of a task Security: All users are granted.

void setRecoveryPassword(CmsObject cms, CmsUser currentUser, CmsProject currentProject, String username, String password, String newPassword)
          Sets the recovery password for a user.

void setTaskPar(CmsUser currentUser, CmsProject currentProject, int taskid, String parname, String parvalue)
          Set a Parameter for a task.

void setTimeout(CmsUser currentUser, CmsProject currentProject, int taskId, long timeout)
          Set timeout of a task Security: All users are granted.

void storeSession(String sessionId, Hashtable sessionData)
          This method stores sessiondata into the database.

void touch(CmsUser currentUser, CmsProject currentProject, String resourceName, long timestamp)
          Access the resource broker underneath to change the timestamp of a resource.

void undeleteResource(CmsUser currentUser, CmsProject currentProject, String filename)
          Undeletes a resource in the Cms.

void undoChanges(CmsUser currentUser, CmsProject currentProject, String resourceName)
          Undo all changes in the resource, restore the online file.

void unlockProject(CmsUser currentUser, CmsProject currentProject, int id)
          Unlocks all resources in this project.

void unlockResource(CmsUser currentUser, CmsProject currentProject, String resourcename)
          Unlocks a resource.

void updateOnlineProjectLinks(Vector deleted, Vector changed, Vector newRes, int pageType)
          When a project is published this method aktualises the online link table.

boolean userInGroup(CmsUser currentUser, CmsProject currentProject, String username, String groupname)
          Checks if a user is member of a group.

void writeCronTable(CmsUser currentUser, CmsProject currentProject, String crontable)
          Writes the Crontable.

void writeExportLink(CmsExportLink link)
          Writes an exportlink to the Cms.

void writeExportLinkProcessedState(CmsExportLink link)
          Sets one exportLink to procecced.

void writeExportPath(CmsUser currentUser, CmsProject currentProject, String path)
          Writes the export-path for the system.

void writeFile(CmsUser currentUser, CmsProject currentProject, CmsFile file)
          Writes a file to the Cms.

void writeFileExtensions(CmsUser currentUser, CmsProject currentProject, Hashtable extensions)
          Writes the file extensions Security: Users, which are in the group "Administrators" are authorized.

void writeFileHeader(CmsUser currentUser, CmsProject currentProject, CmsFile file)
          Writes a fileheader to the Cms.

void writeGroup(CmsUser currentUser, CmsProject currentProject, CmsGroup group)
          Writes an already existing group in the Cms.

void writeLinkCheckTable(CmsUser currentUser, CmsProject currentProject, Hashtable linkchecktable)
          Writes the Linkchecktable.

void writeProperties(CmsUser currentUser, CmsProject currentProject, String resource, Map propertyinfos)
          Writes a couple of propertyinformation for a file or folder.

void writeProperty(CmsUser currentUser, CmsProject currentProject, String resource, String property, String value)
          Writes a propertyinformation for a file or folder.

CmsPropertydefinition writePropertydefinition(CmsUser currentUser, CmsProject currentProject, CmsPropertydefinition propertydef)
          Updates the propertydefinition for the resource type.

void writeResource(CmsUser currentUser, CmsProject currentProject, String resourcename, Map properties, String username, String groupname, int accessFlags, int resourceType, byte[] filecontent)
          Writes a resource and its properties to the Cms.

void writeTaskLog(CmsUser currentUser, CmsProject currentProject, int taskid, String comment)
          Writes a new user tasklog for a task.

void writeTaskLog(CmsUser currentUser, CmsProject currentProject, int taskid, String comment, int taskType)
          Writes a new user tasklog for a task.

void writeUser(CmsUser currentUser, CmsProject currentProject, CmsUser user)
          Updates the user information.

void writeWebUser(CmsUser currentUser, CmsProject currentProject, CmsUser user)
          Updates the user information of a web user.

Method Detail

acceptTask

public void acceptTask(CmsUser currentUser,
                       CmsProject currentProject,
                       int taskId)
                throws CmsException

Accept a task from the Cms. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Throws:: CmsException - Throws CmsException if something goes wrong.

accessCreate

public boolean accessCreate(CmsUser currentUser,
                            CmsProject currentProject,
                            String resourceName)
                     throws CmsException

Checks, if the user may create this resource.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: wether the user has access, or not.; CmsException

accessLock

public boolean accessLock(CmsUser currentUser,
                          CmsProject currentProject,
                          String resourceName)
                   throws CmsException

Checks, if the user may lock this resource.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: wether the user may lock this resource, or not.; CmsException

accessProject

public boolean accessProject(CmsUser currentUser,
                             CmsProject currentProject,
                             int projectId)
                      throws CmsException

Tests if the user can access the project. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; projectId - the id of the project.
Returns:: true, if the user has access, else returns false.
Throws:: CmsException - Throws CmsException if something goes wrong.

accessRead

public boolean accessRead(CmsUser currentUser,
                          CmsProject currentProject,
                          String resourceName)
                   throws CmsException

Checks, if the user may read this resource.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: wether the user has access, or not.; CmsException

accessWrite

public boolean accessWrite(CmsUser currentUser,
                           CmsProject currentProject,
                           String resourceName)
                    throws CmsException

Checks, if the user may write this resource.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: wether the user has access, or not.; CmsException

addFileExtension

public void addFileExtension(CmsUser currentUser,
                             CmsProject currentProject,
                             String extension,
                             String resTypeName)
                      throws CmsException

adds a file extension to the list of known file extensions Security: Users, which are in the group "administrators" are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; extension - a file extension like 'html'; resTypeName - name of the resource type associated to the extension; CmsException

addGroup

public CmsGroup addGroup(CmsUser currentUser,
                         CmsProject currentProject,
                         String name,
                         String description,
                         int flags,
                         String parent)
                  throws CmsException

Add a new group to the Cms.
Only the admin can do this.

Security: Only users, which are in the group "administrators" are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; name - The name of the new group.; description - The description for the new group.; flags - The flags for the new group.
Returns:: Group
Throws:: CmsException - Throws CmsException if operation was not succesfull.

addUser

public CmsUser addUser(CmsObject cms,
                       CmsUser currentUser,
                       CmsProject currentProject,
                       String name,
                       String password,
                       String group,
                       String description,
                       Hashtable additionalInfos,
                       int flags)
                throws CmsException

Adds a user to the Cms. Only a adminstrator can add users to the cms.

Security: Only users, which are in the group "administrators" are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; name - The new name for the user.; password - The new password for the user.; group - The default groupname for the user.; description - The description for the user.; additionalInfos - A Hashtable with additional infos for the user. These Infos may be stored into the Usertables (depending on the implementation).; flags - The flags for a user (e.g. C_FLAG_ENABLED)
Returns:: user The added user will be returned.
Throws:: CmsException - Throws CmsException if operation was not succesfull.

addImportUser

public CmsUser addImportUser(CmsUser currentUser,
                             CmsProject currentProject,
                             String name,
                             String password,
                             String recoveryPassword,
                             String description,
                             String firstname,
                             String lastname,
                             String email,
                             int flags,
                             Hashtable additionalInfos,
                             String defaultGroup,
                             String address,
                             String section,
                             int type)
                      throws CmsException

Adds a user to the Cms by import. Only a adminstrator can add users to the cms.

Security: Only users, which are in the group "administrators" are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; name - The name for the user.; password - The password for the user.; recoveryPassword - The recoveryPassword for the user.; description - The description for the user.; firstname - The firstname of the user.; lastname - The lastname of the user.; email - The email of the user.; flags - The flags for a user (e.g. C_FLAG_ENABLED); additionalInfos - A Hashtable with additional infos for the user. These Infos may be stored into the Usertables (depending on the implementation).; defaultGroup - The default groupname for the user.; address - The address of the user; section - The section of the user; type - The type of the user
Returns:: user The added user will be returned.
Throws:: CmsException - Throws CmsException if operation was not succesfull.

addUserToGroup

public void addUserToGroup(CmsUser currentUser,
                           CmsProject currentProject,
                           String username,
                           String groupname)
                    throws CmsException

Adds a user to a group.
Only the admin can do this.

Security: Only users, which are in the group "administrators" are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; username - The name of the user that is to be added to the group.; groupname - The name of the group.
Throws:: CmsException - Throws CmsException if operation was not succesfull.

addWebUser

public CmsUser addWebUser(CmsObject cms,
                          CmsUser currentUser,
                          CmsProject currentProject,
                          String name,
                          String password,
                          String group,
                          String description,
                          Hashtable additionalInfos,
                          int flags)
                   throws CmsException

Adds a web user to the Cms.
A web user has no access to the workplace but is able to access personalized functions controlled by the OpenCms.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; name - The new name for the user.; password - The new password for the user.; group - The default groupname for the user.; description - The description for the user.; additionalInfos - A Hashtable with additional infos for the user. These Infos may be stored into the Usertables (depending on the implementation).; flags - The flags for a user (e.g. C_FLAG_ENABLED)
Returns:: user The added user will be returned.
Throws:: CmsException - Throws CmsException if operation was not succesfull.

addWebUser

public CmsUser addWebUser(CmsObject cms,
                          CmsUser currentUser,
                          CmsProject currentProject,
                          String name,
                          String password,
                          String group,
                          String additionalGroup,
                          String description,
                          Hashtable additionalInfos,
                          int flags)
                   throws CmsException

Adds a web user to the Cms.
A web user has no access to the workplace but is able to access personalized functions controlled by the OpenCms.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; name - The new name for the user.; password - The new password for the user.; group - The default groupname for the user.; additionalGroup - An additional group for the user.; description - The description for the user.; additionalInfos - A Hashtable with additional infos for the user. These Infos may be stored into the Usertables (depending on the implementation).; flags - The flags for a user (e.g. C_FLAG_ENABLED)
Returns:: user The added user will be returned.
Throws:: CmsException - Throws CmsException if operation was not succesfull.

anonymousUser

public CmsUser anonymousUser(CmsUser currentUser,
                             CmsProject currentProject)
                      throws CmsException

Returns the anonymous user object.

Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: the anonymous user object.
Throws:: CmsException - Throws CmsException if operation was not succesful

chgrp

public void chgrp(CmsUser currentUser,
                  CmsProject currentProject,
                  String filename,
                  String newGroup)
           throws CmsException

Changes the group for this resource
Only the group of a resource in an offline project can be changed. The state of the resource is set to CHANGED (1). If the content of this resource is not exisiting in the offline project already, it is read from the online project and written into the offline project. The user may change this, if he is admin of the resource.
Security: Access is granted, if:

the user has access to the project
the user is owner of the resource or is admin
the resource is locked by the callingUser

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; filename - The complete path to the resource.; newGroup - The name of the new group for this resource.
Throws:: CmsException - Throws CmsException if operation was not succesful.

chmod

public void chmod(CmsUser currentUser,
                  CmsProject currentProject,
                  String filename,
                  int flags)
           throws CmsException

Changes the flags for this resource.
Only the flags of a resource in an offline project can be changed. The state of the resource is set to CHANGED (1). If the content of this resource is not exisiting in the offline project already, it is read from the online project and written into the offline project. The user may change the flags, if he is admin of the resource
. Security: Access is granted, if:

the user has access to the project
the user can write the resource
the resource is locked by the callingUser

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; filename - The complete path to the resource.; flags - The new accessflags for the resource.
Throws:: CmsException - Throws CmsException if operation was not succesful.

chown

public void chown(CmsUser currentUser,
                  CmsProject currentProject,
                  String filename,
                  String newOwner)
           throws CmsException

Changes the owner for this resource.
Only the owner of a resource in an offline project can be changed. The state of the resource is set to CHANGED (1). If the content of this resource is not exisiting in the offline project already, it is read from the online project and written into the offline project. The user may change this, if he is admin of the resource.
Security: Access is granted, if:

the user has access to the project
the user is owner of the resource or the user is admin
the resource is locked by the callingUser

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; filename - The complete path to the resource.; newOwner - The name of the new owner for this resource.
Throws:: CmsException - Throws CmsException if operation was not succesful.

touch

public void touch(CmsUser currentUser,
                  CmsProject currentProject,
                  String resourceName,
                  long timestamp)
           throws CmsException

Access the resource broker underneath to change the timestamp of a resource.

Parameters:: currentUser - the currentuser who requested this method; currentProject - the current project of the user; resourceName - the name of the resource to change; timestamp - timestamp the new timestamp of the changed resource; CmsException

chstate

public void chstate(CmsUser currentUser,
                    CmsProject currentProject,
                    String filename,
                    int state)
             throws CmsException

Changes the state for this resource
The user may change this, if he is admin of the resource. Security: Access is granted, if:

the user has access to the project
the user is owner of the resource or is admin
the resource is locked by the callingUser

Parameters:: filename - The complete path to the resource.; state - The new state of this resource.
Throws:: CmsException - will be thrown, if the user has not the rights for this resource.

chtype

public void chtype(CmsUser currentUser,
                   CmsProject currentProject,
                   String filename,
                   String newType)
            throws CmsException

Changes the resourcetype for this resource
Only the resourcetype of a resource in an offline project can be changed. The state of the resource is set to CHANGED (1). If the content of this resource is not exisiting in the offline project already, it is read from the online project and written into the offline project. The user may change this, if he is admin of the resource.
Security: Access is granted, if:

the user has access to the project
the user is owner of the resource or is admin
the resource is locked by the callingUser

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; filename - The complete path to the resource.; newType - The name of the new resourcetype for this resource.
Throws:: CmsException - Throws CmsException if operation was not succesful.

clearcache

public void clearcache()

Clears all internal DB-Caches.

copyFile

public void copyFile(CmsUser currentUser,
                     CmsProject currentProject,
                     String source,
                     String destination)
              throws CmsException

Copies a file in the Cms.
Security: Access is granted, if:

the user has access to the project
the user can read the sourceresource
the user can create the destinationresource
the destinationresource doesn't exist

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; source - The complete path of the sourcefile.; destination - The complete path to the destination.
Throws:: CmsException - Throws CmsException if operation was not succesful.

copyFolder

public void copyFolder(CmsUser currentUser,
                       CmsProject currentProject,
                       String source,
                       String destination)
                throws CmsException

Copies a folder in the Cms.
Security: Access is granted, if:

the user has access to the project
the user can read the sourceresource
the user can create the destinationresource
the destinationresource doesn't exist

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; source - The complete path of the sourcefolder.; destination - The complete path to the destination.
Throws:: CmsException - Throws CmsException if operation was not succesful.

copyResourceToProject

public void copyResourceToProject(CmsUser currentUser,
                                  CmsProject currentProject,
                                  String resource)
                           throws CmsException

Copies a resource from the online project to a new, specified project.
Copying a resource will copy the file header or folder into the specified offline project and set its state to UNCHANGED. Security: Access is granted, if:

the user is the owner of the project

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; resource - The name of the resource.
Throws:: CmsException - Throws CmsException if operation was not succesful.

countLockedResources

public int countLockedResources(CmsUser currentUser,
                                CmsProject currentProject,
                                int id)
                         throws CmsException

Counts the locked resources in this project. Security Only the admin or the owner of the project can do this.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; id - The id of the project
Returns:: the amount of locked resources in this project.
Throws:: CmsException - Throws CmsException if something goes wrong.

createFile

public CmsFile createFile(CmsUser currentUser,
                          CmsGroup currentGroup,
                          CmsProject currentProject,
                          String newFileName,
                          byte[] contents,
                          String type,
                          Map propertyinfos)
                   throws CmsException

Creates a new file with the given content and resourcetype.
Files can only be created in an offline project, the state of the new file is set to NEW (2).
Security: Access is granted, if:

the user has access to the project
the user can write the resource
the folder-resource is not locked by another user
the file doesn't exist

Parameters:: currentUser - The user who owns this file.; currentGroup - The group who owns this file.; currentProject - The project in which the resource will be used.; newFileName - The name of the new file with full path information.; contents - The contents of the new file.; type - The name of the resourcetype of the new file.; propertyinfos - A Hashtable of propertyinfos, that should be set for this folder. The keys for this Hashtable are the names for propertydefinitions, the values are the values for the propertyinfos.
Returns:: file The created file.
Throws:: CmsException - Throws CmsException if operation was not succesful.

createFolder

public CmsFolder createFolder(CmsUser currentUser,
                              CmsGroup currentGroup,
                              CmsProject currentProject,
                              String folderName,
                              Map propertyinfos)
                       throws CmsException

Creates a new folder. Security: Access is granted, if:

the user has access to the project
the user can write the resource
the resource is not locked by another user

Parameters:: currentUser - The user who requested this method.; currentGroup - The group who requested this method.; currentProject - The current project of the user.; propertyinfos - A Hashtable of propertyinfos, that should be set for this folder. The keys for this Hashtable are the names for propertydefinitions, the values are the values for the propertyinfos.
Returns:: file The created file.
Throws:: CmsException - will be thrown for missing propertyinfos, for worng propertydefs or if the filename is not valid. The CmsException will also be thrown, if the user has not the rights for this resource.

importResource

public CmsResource importResource(CmsUser currentUser,
                                  CmsProject currentProject,
                                  String newResourceName,
                                  int resourceType,
                                  Map propertyinfos,
                                  int launcherType,
                                  String launcherClassname,
                                  String ownername,
                                  String groupname,
                                  int accessFlags,
                                  long lastmodified,
                                  byte[] filecontent)
                           throws CmsException

Creates a new resource. Security: Access is granted, if:

the user has access to the project
the user can write the resource
the resource is not locked by another user

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; newResourceName - The name of the new resource (No pathinformation allowed).; resourceType - The resourcetype of the new resource; propertyinfos - A Hashtable of propertyinfos, that should be set for this folder. The keys for this Hashtable are the names for propertydefinitions, the values are the values for the propertyinfos.; launcherType - The launcher type of the new resource; launcherClassname - The name of the launcherclass of the new resource; ownername - The name of the owner of the new resource; groupname - The name of the group of the new resource; accessFlags - The accessFlags of the new resource; filecontent - The content of the resource if it is of type file
Returns:: CmsResource The created resource.
Throws:: CmsException - will be thrown for missing propertyinfos, for worng propertydefs or if the filename is not valid. The CmsException will also be thrown, if the user has not the rights for this resource.

createProject

public CmsProject createProject(CmsUser currentUser,
                                CmsProject currentProject,
                                String name,
                                String description,
                                String groupname,
                                String managergroupname)
                         throws CmsException

Creates a project. Security Only the users which are in the admin or projectleader-group are granted. Changed: added the parent id

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; name - The name of the project to read.; description - The description for the new project.
Throws:: CmsException - Throws CmsException if something goes wrong.

createProject

public CmsProject createProject(CmsUser currentUser,
                                CmsProject currentProject,
                                String name,
                                String description,
                                String groupname,
                                String managergroupname,
                                int projecttype)
                         throws CmsException

Creates a project. Security Only the users which are in the admin or projectleader-group are granted. Changed: added the project type

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; name - The name of the project to read.; description - The description for the new project.; projecttype - the project type (normal or temporary)
Throws:: CmsException - Throws CmsException if something goes wrong.

createProject

public CmsTask createProject(CmsUser currentUser,
                             String projectname,
                             int projectType,
                             String roleName,
                             long timeout,
                             int priority)
                      throws CmsException

Creates a new project for task handling.

Parameters:: projectname - Name of the project; projectType - Type of the Project; timeout - Time when the Project must finished; priority - Priority for the Project
Returns:: The new task project
Throws:: CmsException - Throws CmsException if something goes wrong.

createDirectPublishProject

public CmsProject createDirectPublishProject(CmsUser currentUser,
                                             CmsProject currentProject,
                                             String name,
                                             String description,
                                             String groupname,
                                             String managergroupname,
                                             int projecttype)
                                      throws CmsException

Creates a project for the direct publish. Security Only the users which are in the admin or projectleader-group of the current project are granted. Changed: added the project type

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; name - The name of the project to read.; description - The description for the new project.
Throws:: CmsException - Throws CmsException if something goes wrong.

createTempfileProject

public CmsProject createTempfileProject(CmsObject cms,
                                        CmsUser currentUser,
                                        CmsProject currentProject)
                                 throws CmsException

Creates a project for the temporary files. Security Only the users which are in the admin or projectleader-group are granted. Changed: added the project type

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Throws:: CmsException - Throws CmsException if something goes wrong.

createPropertydefinition

public CmsPropertydefinition createPropertydefinition(CmsUser currentUser,
                                                      CmsProject currentProject,
                                                      String name,
                                                      String resourcetype)
                                               throws CmsException

Creates the propertydefinition for the resource type.
Security Only the admin can do this.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; name - The name of the propertydefinition to overwrite.; resourcetype - The name of the resource-type for the propertydefinition.
Throws:: CmsException - Throws CmsException if something goes wrong.

createTask

public CmsTask createTask(CmsUser currentUser,
                          int projectid,
                          String agentName,
                          String roleName,
                          String taskname,
                          String taskcomment,
                          int tasktype,
                          long timeout,
                          int priority)
                   throws CmsException

Creates a new task. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; projectid - The Id of the current project task of the user.; taskname - Name of the task; tasktype - Type of the task; taskcomment - Description of the task; timeout - Time when the task must finished; priority - Id for the priority
Returns:: A new Task Object
Throws:: CmsException - Throws CmsException if something goes wrong.

createTask

public CmsTask createTask(CmsUser currentUser,
                          CmsProject currentProject,
                          String agentName,
                          String roleName,
                          String taskname,
                          String taskcomment,
                          long timeout,
                          int priority)
                   throws CmsException

Creates a new task. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; taskname - Name of the task; taskcomment - Description of the task; timeout - Time when the task must finished; priority - Id for the priority
Returns:: A new Task Object
Throws:: CmsException - Throws CmsException if something goes wrong.

deleteAllProperties

public void deleteAllProperties(CmsUser currentUser,
                                CmsProject currentProject,
                                String resource)
                         throws CmsException

Deletes all propertyinformation for a file or folder. Security Only the user is granted, who has the right to write the resource.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; resource - The name of the resource of which the propertyinformations have to be deleted.
Throws:: CmsException - Throws CmsException if operation was not succesful

deleteFile

public void deleteFile(CmsUser currentUser,
                       CmsProject currentProject,
                       String filename)
                throws CmsException

Deletes a file in the Cms.
A file can only be deleteed in an offline project. A file is deleted by setting its state to DELETED (3).
Security: Access is granted, if:

the user has access to the project
the user can write the resource
the resource is locked by the callinUser

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; filename - The complete path of the file.
Throws:: CmsException - Throws CmsException if operation was not succesful.

deleteFolder

public void deleteFolder(CmsUser currentUser,
                         CmsProject currentProject,
                         String foldername)
                  throws CmsException

Deletes a folder in the Cms.
Only folders in an offline Project can be deleted. A folder is deleted by setting its state to DELETED (3).
In its current implmentation, this method can ONLY delete empty folders. Security: Access is granted, if:

the user has access to the project
the user can read and write this resource and all subresources
the resource is not locked

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; foldername - The complete path of the folder.
Throws:: CmsException - Throws CmsException if operation was not succesful.

undeleteResource

public void undeleteResource(CmsUser currentUser,
                             CmsProject currentProject,
                             String filename)
                      throws CmsException

Undeletes a resource in the Cms.
A resource can only be undeleted in an offline project. A resource is undeleted by setting its state to CHANGED (1).
Security: Access is granted, if:

the user has access to the project
the user can write the resource
the resource is locked by the callinUser

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; filename - The complete path of the resource.
Throws:: CmsException - Throws CmsException if operation was not succesful.

deleteGroup

public void deleteGroup(CmsUser currentUser,
                        CmsProject currentProject,
                        String delgroup)
                 throws CmsException

Delete a group from the Cms.
Only groups that contain no subgroups can be deleted. Only the admin can do this.

Security: Only users, which are in the group "administrators" are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; delgroup - The name of the group that is to be deleted.
Throws:: CmsException - Throws CmsException if operation was not succesfull.

deleteProject

public void deleteProject(CmsUser currentUser,
                          CmsProject currentProject,
                          int id)
                   throws CmsException

Deletes a project. Security Only the admin or the owner of the project can do this.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; id - The id of the project to be published.
Throws:: CmsException - Throws CmsException if something goes wrong.

deleteProperty

public void deleteProperty(CmsUser currentUser,
                           CmsProject currentProject,
                           String resource,
                           String property)
                    throws CmsException

Deletes a propertyinformation for a file or folder. Security Only the user is granted, who has the right to write the resource.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; resource - The name of the resource of which the propertyinformation has to be read.; property - The propertydefinition-name of which the propertyinformation has to be set.
Throws:: CmsException - Throws CmsException if operation was not succesful

deletePropertydefinition

public void deletePropertydefinition(CmsUser currentUser,
                                     CmsProject currentProject,
                                     String name,
                                     String resourcetype)
                              throws CmsException

Delete the propertydefinition for the resource type.
Security Only the admin can do this.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; name - The name of the propertydefinition to read.; resourcetype - The name of the resource type for which the propertydefinition is valid.
Throws:: CmsException - Throws CmsException if something goes wrong.

deleteUser

public void deleteUser(CmsUser currentUser,
                       CmsProject currentProject,
                       int userId)
                throws CmsException

Deletes a user from the Cms. Only a adminstrator can do this.

Security: Only users, which are in the group "administrators" are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; userId - The Id of the user to be deleted.
Throws:: CmsException - Throws CmsException if operation was not succesfull.

deleteUser

public void deleteUser(CmsUser currentUser,
                       CmsProject currentProject,
                       String username)
                throws CmsException

Deletes a user from the Cms. Only a adminstrator can do this.

Security: Only users, which are in the group "administrators" are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Throws:: CmsException - Throws CmsException if operation was not succesfull.

deleteWebUser

public void deleteWebUser(CmsUser currentUser,
                          CmsProject currentProject,
                          int userId)
                   throws CmsException

Deletes a web user from the Cms.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; userId - The Id of the user to be deleted.
Throws:: CmsException - Throws CmsException if operation was not succesfull.

destroy

public void destroy()
             throws CmsException

Destroys the resource borker and required modules and connections.

Throws:: CmsException - Throws CmsException if something goes wrong.

endTask

public void endTask(CmsUser currentUser,
                    CmsProject currentProject,
                    int taskid)
             throws CmsException

Ends a task from the Cms. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; taskid - The ID of the task to end.
Throws:: CmsException - Throws CmsException if something goes wrong.

exportResources

public void exportResources(CmsUser currentUser,
                            CmsProject currentProject,
                            String exportFile,
                            String[] exportPaths,
                            CmsObject cms)
                     throws CmsException

Exports cms-resources to zip. Security: only Administrators can do this;

Parameters:: currentUser - user who requestd themethod; currentProject - current project of the user; exportFile - the name (absolute Path) of the export resource (zip); exportPaths - the name (absolute Path) of folders from which should be exported; cms - the cms-object to use for the export.
Throws:: Throws - CmsException if something goes wrong.; CmsException

exportResources

public void exportResources(CmsUser currentUser,
                            CmsProject currentProject,
                            String exportFile,
                            String[] exportPaths,
                            CmsObject cms,
                            boolean includeSystem,
                            boolean excludeUnchanged)
                     throws CmsException

Exports cms-resources to zip. Security: only Administrators can do this;

Parameters:: currentUser - user who requestd themethod; currentProject - current project of the user; exportFile - the name (absolute Path) of the export resource (zip); exportPaths - the name (absolute Path) of folders from which should be exported; excludeUnchanged - true, if unchanged files should be excluded.; cms - the cms-object to use for the export.
Throws:: Throws - CmsException if something goes wrong.; CmsException

exportResources

public void exportResources(CmsUser currentUser,
                            CmsProject currentProject,
                            String exportFile,
                            String[] exportPaths,
                            CmsObject cms,
                            boolean includeSystem,
                            boolean excludeUnchanged,
                            boolean exportUserdata,
                            long contentAge,
                            I_CmsReport report)
                     throws CmsException

Exports cms-resources to zip. Security: only Administrators can do this;

Parameters:: currentUser - user who requestd themethod; currentProject - current project of the user; exportFile - the name (absolute Path) of the export resource (zip); exportPaths - the name (absolute Path) of folders from which should be exported; cms - the cms-object to use for the export.; excludeUnchanged - true, if unchanged files should be excluded.; contentAge - Max age of content to be exported (timestamp); report - the cmsReport to handle the log messages.
Throws:: Throws - CmsException if something goes wrong.; CmsException

exportModuledata

public void exportModuledata(CmsUser currentUser,
                             CmsProject currentProject,
                             String exportFile,
                             String[] exportChannels,
                             String[] exportModules,
                             CmsObject cms,
                             I_CmsReport report)
                      throws CmsException

Exports channels and moduledata to zip. Security: only Administrators can do this;

Parameters:: currentUser - user who requestd themethod; currentProject - current project of the user; exportFile - the name (absolute Path) of the export resource (zip); exportChannels - the names (absolute Path) of channels from which should be exported; exportModules - the names of modules from which should be exported; cms - the cms-object to use for the export.
Throws:: Throws - CmsException if something goes wrong.; CmsException

exportStaticResources

public void exportStaticResources(CmsUser currentUser,
                                  CmsProject currentProject,
                                  CmsObject cms,
                                  Vector startpoints,
                                  Vector projectResources,
                                  Vector allExportedLinks,
                                  CmsPublishedResources changedResources,
                                  I_CmsReport report)
                           throws CmsException

Creates a static export of a Cmsresource in the filesystem

Parameters:: currentUser - user who requestd themethod; currentProject - current project of the user; cms - the cms-object to use for the export.; startpoints - the startpoints for the export.; report - the cmsReport to handle the log messages.
Throws:: CmsException - if operation was not successful.

exportStaticResources

public void exportStaticResources(CmsUser currentUser,
                                  CmsProject currentProject,
                                  CmsObject cms,
                                  Vector linksToExport)
                           throws CmsException

Creates a static export in the filesystem. This method is used only on a slave system in a cluster. The Vector is generated in the static export on the master system (in the Vector allExportdLinks), so in this method the database must not be updated.

Parameters:: currentUser - user who requestd themethod; currentProject - current project of the user; cms - the cms-object to use for the export.; linksToExport - all links that where exported by the master OpenCms.
Throws:: CmsException - if operation was not successful.

forwardTask

public void forwardTask(CmsUser currentUser,
                        CmsProject currentProject,
                        int taskid,
                        String newRoleName,
                        String newUserName)
                 throws CmsException

Forwards a task to a new user. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; taskid - The Id of the task to forward.
Throws:: CmsException - Throws CmsException if something goes wrong.

getAllAccessibleProjects

public Vector getAllAccessibleProjects(CmsUser currentUser,
                                       CmsProject currentProject)
                                throws CmsException

Returns all projects, which are owned by the user or which are accessible for the group of the user. Security All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: a Vector of projects.; CmsException

getAllManageableProjects

public Vector getAllManageableProjects(CmsUser currentUser,
                                       CmsProject currentProject)
                                throws CmsException

Returns all projects, which are owned by the user or which are manageable for the group of the user. Security All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: a Vector of projects.; CmsException

getAllBackupProjects

public Vector getAllBackupProjects()
                            throws CmsException

Returns a Vector with all projects from history

Returns:: Vector with all projects from history.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getAllExportLinks

public Vector getAllExportLinks()
                         throws CmsException

Returns a Vector with all export links

Returns:: Vector (Strings) with all export links.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getAllResourceTypes

public Hashtable getAllResourceTypes(CmsUser currentUser,
                                     CmsProject currentProject)
                              throws CmsException

Returns a Vector with all I_CmsResourceTypes. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user. Returns a Hashtable with all I_CmsResourceTypes.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getCacheInfo

public Hashtable getCacheInfo()

Returns informations about the cache.

Returns:: a hashtable with informations about the cache.

getChild

public Vector getChild(CmsUser currentUser,
                       CmsProject currentProject,
                       String groupname)
                throws CmsException

Returns all child groups of a group

Security: All users are granted, except the anonymous user.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; groupname - The name of the group.
Returns:: groups A Vector of all child groups or null.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getChilds

public Vector getChilds(CmsUser currentUser,
                        CmsProject currentProject,
                        String groupname)
                 throws CmsException

Returns all child groups of a group

This method also returns all sub-child groups of the current group. Security: All users are granted, except the anonymous user.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; groupname - The name of the group.
Returns:: groups A Vector of all child groups or null.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getConfigurations

public source.org.apache.java.util.Configurations getConfigurations(CmsUser currentUser,
                                                                    CmsProject currentProject)

Method to access the configurations of the properties-file. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: The Configurations of the properties-file.

getDirectGroupsOfUser

public Vector getDirectGroupsOfUser(CmsUser currentUser,
                                    CmsProject currentProject,
                                    String username)
                             throws CmsException

Returns the list of groups to which the user directly belongs to

Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; username - The name of the user.
Returns:: Vector of groups
Throws:: CmsException - Throws CmsException if operation was not succesful

getFilesInFolder

public Vector getFilesInFolder(CmsUser currentUser,
                               CmsProject currentProject,
                               String foldername)
                        throws CmsException

Returns a Vector with all files of a folder.
Files of a folder can be read from an offline Project and the online Project.
Security: Access is granted, if:

the user has access to the project
the user can read this resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; foldername - the complete path to the folder.
Returns:: subfiles A Vector with all subfiles for the overgiven folder.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getFilesInFolder

public Vector getFilesInFolder(CmsUser currentUser,
                               CmsProject currentProject,
                               String foldername,
                               boolean includeDeleted)
                        throws CmsException

Returns a Vector with all files of a folder.
Files of a folder can be read from an offline Project and the online Project.
Security: Access is granted, if:

the user has access to the project
the user can read this resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; foldername - the complete path to the folder.; includeDeleted - Include if the folder is marked as deleted
Returns:: subfiles A Vector with all subfiles for the overgiven folder.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getFilesWithProperty

public Vector getFilesWithProperty(CmsUser currentUser,
                                   CmsProject currentProject,
                                   String propertyDefinition,
                                   String propertyValue)
                            throws CmsException

Returns a Vector with all resource-names that have set the given property to the given value. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: Vector with all names of resources.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getFileSystemChanges

public long getFileSystemChanges(CmsUser currentUser,
                                 CmsProject currentProject)

This method can be called, to determine if the file-system was changed in the past. A module can compare its previosly stored number with this returned number. If they differ, a change was made. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: the number of file-system-changes.

getFileSystemFolderChanges

public long getFileSystemFolderChanges(CmsUser currentUser,
                                       CmsProject currentProject)

This method can be called, to determine if the file-system was changed(only Folders) in the past. A module can compare its previosly stored number with this returned number. If they differ, a change was made. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: the number of file-system-changes.

getFolderTree

public Vector getFolderTree(CmsUser currentUser,
                            CmsProject currentProject,
                            String rootName)
                     throws CmsException

Returns a Vector with the complete folder-tree for this project.
Subfolders can be read from an offline project and the online project.
Security: Access is granted, if:

the user has access to the project
the user can read this resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; rootName - The name of the root, e.g. /default/vfs
Returns:: subfolders A Vector with the complete folder-tree for this project.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getGroups

public Vector getGroups(CmsUser currentUser,
                        CmsProject currentProject)
                 throws CmsException

Returns all groups

Security: All users are granted, except the anonymous user.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: users A Vector of all existing groups.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getGroupsOfUser

public Vector getGroupsOfUser(CmsUser currentUser,
                              CmsProject currentProject,
                              String username)
                       throws CmsException

Returns a list of groups of a user.

Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; username - The name of the user.
Returns:: Vector of groups
Throws:: CmsException - Throws CmsException if operation was not succesful

getParent

public CmsGroup getParent(CmsUser currentUser,
                          CmsProject currentProject,
                          String groupname)
                   throws CmsException

Returns the parent group of a group

Security: All users are granted, except the anonymous user.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; groupname - The name of the group.
Returns:: group The parent group or null.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getParentResource

public CmsResource getParentResource(CmsUser currentUser,
                                     CmsProject currentProject,
                                     String resourcename)
                              throws CmsException

Returns the parent resource of a resouce. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: The file read from the Cms.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getReadingpermittedGroup

public String getReadingpermittedGroup(int projectId,
                                       String resource)
                                throws CmsException

Checks which Group can read the resource and all the parent folders.

Returns:: The Group Id of the Group which can read the resource. null for all Groups and Admingroup for no Group.; CmsException

getRegistry

public I_CmsRegistry getRegistry(CmsUser currentUser,
                                 CmsProject currentProject,
                                 CmsObject cms)
                          throws CmsException

Gets the Registry.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; cms - The actual CmsObject.
Throws:: Throws - CmsException if access is not allowed.; CmsException

getResourcesInFolder

public Vector getResourcesInFolder(CmsUser currentUser,
                                   CmsProject currentProject,
                                   String folder)
                            throws CmsException

Returns a Vector with the subresources for a folder.
Security: Access is granted, if:

the user has access to the project
the user can read this resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; folder - The name of the folder to get the subresources from.
Returns:: subfolders A Vector with resources.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getResourcesWithProperty

public Vector getResourcesWithProperty(CmsUser currentUser,
                                       CmsProject currentProject,
                                       String propertyDefinition,
                                       String propertyValue,
                                       int resourceType)
                                throws CmsException

Returns a Vector with all resources of the given type that have set the given property to the given value. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; resourceType - The resource type of the resource
Returns:: Vector with all resources.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getResourcesWithProperty

public Vector getResourcesWithProperty(CmsUser currentUser,
                                       CmsProject currentProject,
                                       String propertyDefinition)
                                throws CmsException

Returns a Vector with all resources of the given type that have set the given property to the given value. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: Vector with all resources.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getResourceType

public I_CmsResourceType getResourceType(CmsUser currentUser,
                                         CmsProject currentProject,
                                         int resourceType)
                                  throws CmsException

Returns a CmsResourceTypes. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; resourceType - the id of the resourceType to get. Returns a CmsResourceTypes.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getResourceType

public I_CmsResourceType getResourceType(CmsUser currentUser,
                                         CmsProject currentProject,
                                         String resourceType)
                                  throws CmsException

Returns a CmsResourceTypes. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; resourceType - the name of the resource to get. Returns a CmsResourceTypes.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getSubFolders

public Vector getSubFolders(CmsUser currentUser,
                            CmsProject currentProject,
                            String foldername)
                     throws CmsException

Returns a Vector with all subfolders.
Subfolders can be read from an offline project and the online project.
Security: Access is granted, if:

the user has access to the project
the user can read this resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; foldername - the complete path to the folder.
Returns:: subfolders A Vector with all subfolders for the given folder.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getSubFolders

public Vector getSubFolders(CmsUser currentUser,
                            CmsProject currentProject,
                            String foldername,
                            boolean includeDeleted)
                     throws CmsException

Returns a Vector with all subfolders.
Subfolders can be read from an offline project and the online project.
Security: Access is granted, if:

the user has access to the project
the user can read this resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; foldername - the complete path to the folder.; includeDeleted - Include if the folder is marked as deleted
Returns:: subfolders A Vector with all subfolders for the given folder.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getTaskPar

public String getTaskPar(CmsUser currentUser,
                         CmsProject currentProject,
                         int taskid,
                         String parname)
                  throws CmsException

Get a parameter value for a task. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; taskid - The Id of the task.; parname - Name of the parameter.
Throws:: CmsException - Throws CmsException if something goes wrong.

getTaskType

public int getTaskType(String taskname)
                throws CmsException

Get the template task id fo a given taskname.

Parameters:: taskname - Name of the Task
Returns:: id from the task template
Throws:: CmsException - Throws CmsException if something goes wrong.

getUsers

public Vector getUsers(CmsUser currentUser,
                       CmsProject currentProject)
                throws CmsException

Returns all users

Security: All users are granted, except the anonymous user.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: users A Vector of all existing users.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getUsers

public Vector getUsers(CmsUser currentUser,
                       CmsProject currentProject,
                       int type)
                throws CmsException

Returns all users from a given type

Security: All users are granted, except the anonymous user.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; type - The type of the users.
Returns:: users A Vector of all existing users.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getUsers

public Vector getUsers(CmsUser currentUser,
                       CmsProject currentProject,
                       int type,
                       String namestart)
                throws CmsException

Returns all users from a given type that start with a specified string

Security: All users are granted, except the anonymous user.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; type - The type of the users.; namestart - The filter for the username
Returns:: users A Vector of all existing users.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getUsersOfGroup

public Vector getUsersOfGroup(CmsUser currentUser,
                              CmsProject currentProject,
                              String groupname)
                       throws CmsException

Returns a list of users in a group.

Security: All users are granted, except the anonymous user.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; groupname - The name of the group to list users from.
Returns:: Vector of users.
Throws:: CmsException - Throws CmsException if operation was not succesful.

getUsersByLastname

public Vector getUsersByLastname(CmsUser currentUser,
                                 CmsProject currentProject,
                                 String Lastname,
                                 int UserType,
                                 int UserStatus,
                                 int wasLoggedIn,
                                 int nMax)
                          throws CmsException

Gets all users with a certain Lastname.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; Lastname - the start of the users lastname; UserType - webuser or systemuser; UserStatus - enabled, disabled; wasLoggedIn - was the user ever locked in?; nMax - max number of results
Returns:: the users.
Throws:: CmsException - if operation was not successful.

importFolder

public void importFolder(CmsUser currentUser,
                         CmsProject currentProject,
                         String importFile,
                         String importPath,
                         CmsObject cms)
                  throws CmsException

Imports a import-resource (folder or zipfile) to the cms. Security: only Administrators can do this;

Parameters:: currentUser - user who requestd themethod; currentProject - current project of the user; importFile - the name (absolute Path) of the import resource (zip or folder); importPath - the name (absolute Path) of folder in which should be imported; cms - the cms-object to use for the import.
Throws:: Throws - CmsException if something goes wrong.; CmsException

importResources

public void importResources(CmsUser currentUser,
                            CmsProject currentProject,
                            String importFile,
                            String importPath,
                            CmsObject cms,
                            I_CmsReport report)
                     throws CmsException

Imports a import-resource (folder or zipfile) to the cms. Security: only Administrators can do this;

Parameters:: currentUser - user who requestd themethod; currentProject - current project of the user; importFile - the name (absolute Path) of the import resource (zip or folder); importPath - the name (absolute Path) of folder in which should be imported; cms - the cms-object to use for the import.; report - A report object to provide the loggin messages.
Throws:: Throws - CmsException if something goes wrong.; CmsException

init

public void init(source.org.apache.java.util.Configurations config)
          throws CmsException

Initializes the resource broker and sets up all required modules and connections.

Parameters:: config - The OpenCms configuration.
Throws:: CmsException - Throws CmsException if something goes wrong.

isAdmin

public boolean isAdmin(CmsUser currentUser,
                       CmsProject currentProject)
                throws CmsException

Determines, if the users current group is the admin-group. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: true, if the users current group is the admin-group, else it returns false.
Throws:: CmsException - Throws CmsException if operation was not succesful.

isManagerOfProject

public boolean isManagerOfProject(CmsUser currentUser,
                                  CmsProject currentProject)
                           throws CmsException

Determines, if the users may manage a project.
Only the manager of a project may publish it. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: true, if the may manage this project.
Throws:: CmsException - Throws CmsException if operation was not succesful.

isProjectManager

public boolean isProjectManager(CmsUser currentUser,
                                CmsProject currentProject)
                         throws CmsException

Determines, if the users current group is the projectleader-group.
All projectleaders can create new projects, or close their own projects. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: true, if the users current group is the projectleader-group, else it returns false.
Throws:: CmsException - Throws CmsException if operation was not succesful.

lockedBy

public CmsUser lockedBy(CmsUser currentUser,
                        CmsProject currentProject,
                        CmsResource resource)
                 throws CmsException

Returns the user, who had locked the resource.
A user can lock a resource, so he is the only one who can write this resource. This methods checks, if a resource was locked.

Parameters:: resource - The resource.
Returns:: the user, who had locked the resource.
Throws:: CmsException - will be thrown, if the user has not the rights for this resource.

lockedBy

public CmsUser lockedBy(CmsUser currentUser,
                        CmsProject currentProject,
                        String resource)
                 throws CmsException

Returns the user, who had locked the resource.
A user can lock a resource, so he is the only one who can write this resource. This methods checks, if a resource was locked.

Parameters:: resource - The complete path to the resource.
Returns:: the user, who had locked the resource.
Throws:: CmsException - will be thrown, if the user has not the rights for this resource.

lockResource

public void lockResource(CmsUser currentUser,
                         CmsProject currentProject,
                         String resourcename,
                         boolean force)
                  throws CmsException

Locks a resource.
Only a resource in an offline project can be locked. The state of the resource is set to CHANGED (1). If the content of this resource is not exisiting in the offline project already, it is read from the online project and written into the offline project. A user can lock a resource, so he is the only one who can write this resource.
Security: Access is granted, if:

the user has access to the project
the user can write the resource
the resource is not locked by another user

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; force - If force is true, a existing locking will be oberwritten.
Throws:: CmsException - Throws CmsException if operation was not succesful. It will also be thrown, if there is a existing lock and force was set to false.

loginUser

public CmsUser loginUser(CmsUser currentUser,
                         CmsProject currentProject,
                         String username,
                         String password)
                  throws CmsException

Logs a user into the Cms, if the password is correct. Security All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; username - The name of the user to be returned.; password - The password of the user to be returned.
Returns:: the logged in user.
Throws:: CmsException - Throws CmsException if operation was not succesful

loginWebUser

public CmsUser loginWebUser(CmsUser currentUser,
                            CmsProject currentProject,
                            String username,
                            String password)
                     throws CmsException

Logs a web user into the Cms, if the password is correct. Security All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; username - The name of the user to be returned.; password - The password of the user to be returned.
Returns:: the logged in user.
Throws:: CmsException - Throws CmsException if operation was not succesful

moveFile

public void moveFile(CmsUser currentUser,
                     CmsProject currentProject,
                     String source,
                     String destination)
              throws CmsException

Moves the file. This operation includes a copy and a delete operation. These operations are done with their security-checks.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; source - The complete path of the sourcefile.; destination - The complete path of the destinationfile.
Throws:: CmsException - will be thrown, if the file couldn't be moved. The CmsException will also be thrown, if the user has not the rights for this resource.

onlineProject

public CmsProject onlineProject(CmsUser currentUser,
                                CmsProject currentProject)
                         throws CmsException

Returns the onlineproject. This is the default project. All anonymous (CmsUser callingUser, or guest) user will see the rersources of this project. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: the onlineproject object.
Throws:: CmsException - Throws CmsException if something goes wrong.

publishProject

public CmsPublishedResources publishProject(CmsObject cms,
                                            CmsUser currentUser,
                                            CmsProject currentProject,
                                            int id,
                                            I_CmsReport report)
                                     throws CmsException

Publishes a project. Security Only the admin or the owner of the project can do this.

Parameters:: cms - The CmsObject.; currentUser - The user who requested this method.; currentProject - The current project of the user.; id - The id of the project to be published.; report - A report object to provide the loggin messages.
Returns:: CmsPublishedResources The object includes the vectors with changed resources.
Throws:: CmsException - Throws CmsException if something goes wrong.

readAgent

public CmsUser readAgent(CmsUser currentUser,
                         CmsProject currentProject,
                         CmsTask task)
                  throws CmsException

Reads the agent of a task from the OpenCms. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; task - The task to read the agent from.
Returns:: The owner of a task.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readAllFileHeaders

public Vector readAllFileHeaders(CmsUser currentUser,
                                 CmsProject currentProject,
                                 String filename)
                          throws CmsException

Reads all file headers of a file in the OpenCms.
This method returns a vector with all file headers, i.e. the file headers of a file, independent of the project they were attached to.
The reading excludes the filecontent. Security: Access is granted, if:

the user can read the resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; filename - The name of the file to be read.
Returns:: Vector of file headers read from the Cms.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readAllFileHeadersForHist

public Vector readAllFileHeadersForHist(CmsUser currentUser,
                                        CmsProject currentProject,
                                        String filename)
                                 throws CmsException

Reads all file headers of a file in the OpenCms.
This method returns a vector with the histroy of all file headers, i.e. the file headers of a file, independent of the project they were attached to.
The reading excludes the filecontent. Security: Access is granted, if:

the user can read the resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; filename - The name of the file to be read.
Returns:: Vector of file headers read from the Cms.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readAllProjectResources

public Vector readAllProjectResources(int projectId)
                               throws CmsException

select all projectResources from an given project

Throws:: CmsException - Throws CmsException if operation was not succesful

readAllPropertydefinitions

public Vector readAllPropertydefinitions(CmsUser currentUser,
                                         CmsProject currentProject,
                                         int resourcetype)
                                  throws CmsException

Reads all propertydefinitions for the given resource type. Security All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; resourcetype - The resource type to read the propertydefinitions for.
Returns:: propertydefinitions A Vector with propertydefefinitions for the resource type. The Vector is maybe empty.
Throws:: CmsException - Throws CmsException if something goes wrong.

readAllPropertydefinitions

public Vector readAllPropertydefinitions(CmsUser currentUser,
                                         CmsProject currentProject,
                                         String resourcetype)
                                  throws CmsException

Reads all propertydefinitions for the given resource type. Security All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; resourcetype - The name of the resource type to read the propertydefinitions for.
Returns:: propertydefinitions A Vector with propertydefefinitions for the resource type. The Vector is maybe empty.
Throws:: CmsException - Throws CmsException if something goes wrong.

deleteLinkEntrys

public void deleteLinkEntrys(int pageId)
                      throws CmsException

deletes all entrys in the link table that belong to the pageId

Parameters:: pageId - The resourceId (offline) of the page whose links should be deleted; CmsException

createLinkEntrys

public void createLinkEntrys(int pageId,
                             Vector linkTargets)
                      throws CmsException

creates a link entry for each of the link targets in the linktable.

Parameters:: pageId - The resourceId (offline) of the page whose liks should be traced.; CmsException

readLinkEntrys

public Vector readLinkEntrys(int pageId)
                      throws CmsException

returns a Vector (Strings) with the link destinations of all links on the page with the pageId.

Parameters:: pageId - The resourceId (offline) of the page whose liks should be read.; CmsException

deleteOnlineLinkEntrys

public void deleteOnlineLinkEntrys(int pageId)
                            throws CmsException

deletes all entrys in the online link table that belong to the pageId

Parameters:: pageId - The resourceId (online) of the page whose links should be deleted; CmsException

createOnlineLinkEntrys

public void createOnlineLinkEntrys(int pageId,
                                   Vector linkTarget)
                            throws CmsException

creates a link entry for each of the link targets in the online linktable.

Parameters:: pageId - The resourceId (online) of the page whose liks should be traced.; linkTarget - A vector of strings (the linkdestinations).; CmsException

readOnlineLinkEntrys

public Vector readOnlineLinkEntrys(int pageId)
                            throws CmsException

returns a Vector (Strings) with the link destinations of all links on the page with the pageId.

Parameters:: pageId - The resourceId (online) of the page whose liks should be read.; CmsException

getOnlineBrokenLinks

public Vector getOnlineBrokenLinks()
                            throws CmsException

serches for broken links in the online project.

Returns:: A Vector with a CmsPageLinks object for each page containing broken links this CmsPageLinks object contains all links on the page withouth a valid target.; CmsException

getBrokenLinks

public void getBrokenLinks(int projectId,
                           I_CmsReport report,
                           Vector changed,
                           Vector deleted,
                           Vector newRes)
                    throws CmsException

checks a project for broken links that would appear if the project is published.

Parameters:: projectId -; changed - A vecor (of CmsResources) with the changed resources in the project.; deleted - A vecor (of CmsResources) with the deleted resources in the project.; newRes - A vecor (of CmsResources) with the new resources in the project.; CmsException

updateOnlineProjectLinks

public void updateOnlineProjectLinks(Vector deleted,
                                     Vector changed,
                                     Vector newRes,
                                     int pageType)
                              throws CmsException

When a project is published this method aktualises the online link table.

Parameters:: deleted - A Vector (of CmsResources) with the deleted resources of the project.; changed - A Vector (of CmsResources) with the changed resources of the project.; newRes - A Vector (of CmsResources) with the newRes resources of the project.; CmsException

readExportPath

public String readExportPath(CmsUser currentUser,
                             CmsProject currentProject)
                      throws CmsException

Reads the export-path for the system. This path is used for db-export and db-import. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: the exportpath.; CmsException

readExportLink

public CmsExportLink readExportLink(String filename)
                             throws CmsException

Reads a exportrequest from the Cms.

Returns:: The exportrequest read from the Cms.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readExportLinkHeader

public CmsExportLink readExportLinkHeader(String request)
                                   throws CmsException

Reads a exportrequest without the dependencies from the Cms.

Parameters:: request - The request to be read.
Returns:: The exportrequest read from the Cms.
Throws:: CmsException - Throws CmsException if operation was not succesful.

writeExportLink

public void writeExportLink(CmsExportLink link)
                     throws CmsException

Writes an exportlink to the Cms.

Parameters:: link - the cmsexportlink object to write.
Throws:: CmsException - if something goes wrong.

deleteExportLink

public void deleteExportLink(String link)
                      throws CmsException

Deletes an exportlink in the database.

Parameters:: link - the name of the link; CmsException

deleteExportLink

public void deleteExportLink(CmsExportLink link)
                      throws CmsException

Deletes an exportlink in the database.

Parameters:: link - the cmsExportLink object to delete.; CmsException

getDependingExportLinks

public Vector getDependingExportLinks(Vector res)
                               throws CmsException

Reads all export links that depend on the resource.

Returns:: a Vector(of Strings) with the linkrequest names.; CmsException

writeExportLinkProcessedState

public void writeExportLinkProcessedState(CmsExportLink link)
                                   throws CmsException

Sets one exportLink to procecced.

Parameters:: link - the cmsexportlink.
Throws:: CmsException - if something goes wrong.

readFile

public CmsFile readFile(CmsUser currentUser,
                        CmsProject currentProject,
                        String filename)
                 throws CmsException

Reads a file from the Cms.
Security: Access is granted, if:

the user has access to the project
the user can read the resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; filename - The name of the file to be read.
Returns:: The file read from the Cms.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readFile

public CmsFile readFile(CmsUser currentUser,
                        CmsProject currentProject,
                        String filename,
                        boolean includeDeleted)
                 throws CmsException

Reads a file from the Cms.
Security: Access is granted, if:

the user has access to the project
the user can read the resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; filename - The name of the file to be read.; includeDeleted - If true the deleted file will be returned, too
Returns:: The file read from the Cms.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readFileExtensions

public Hashtable readFileExtensions(CmsUser currentUser,
                                    CmsProject currentProject)
                             throws CmsException

Gets the known file extensions (=suffixes) Security: All users are granted access

Parameters:: currentUser - The user who requested this method, not used here; currentProject - The current project of the user, not used here
Returns:: Hashtable with file extensions as Strings; CmsException

readFileHeader

public CmsResource readFileHeader(CmsUser currentUser,
                                  CmsProject currentProject,
                                  int projectId,
                                  String filename)
                           throws CmsException

Reads a file header a previous project of the Cms.
The reading excludes the filecontent.
A file header can be read from an offline project or the online project. Security: Access is granted, if:

the user has access to the project
the user can read the resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; projectId - The id of the project to read the file from.; filename - The name of the file to be read.
Returns:: The file read from the Cms.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readFileHeader

public CmsResource readFileHeader(CmsUser currentUser,
                                  CmsProject currentProject,
                                  String filename)
                           throws CmsException

Reads a file header from the Cms.
The reading excludes the filecontent.
A file header can be read from an offline project or the online project. Security: Access is granted, if:

the user has access to the project
the user can read the resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; filename - The name of the file to be read.
Returns:: The file read from the Cms.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readFileHeader

public CmsResource readFileHeader(CmsUser currentUser,
                                  CmsProject currentProject,
                                  String filename,
                                  boolean includeDeleted)
                           throws CmsException

Reads a file header from the Cms.
The reading excludes the filecontent.
A file header can be read from an offline project or the online project. Security: Access is granted, if:

the user has access to the project
the user can read the resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; filename - The name of the file to be read.; includeDeleted - If false then throw exception if the file is marked as deleted
Returns:: The file read from the Cms.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readFileHeaderForHist

public CmsBackupResource readFileHeaderForHist(CmsUser currentUser,
                                               CmsProject currentProject,
                                               int versionId,
                                               String filename)
                                        throws CmsException

Reads a file header from the history of the Cms.
The reading excludes the filecontent.
The file header is read from the backup resources. Security: Access is granted, if:

the user has access to the project
the user can read the resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; versionId - The versionid of the file.; filename - The name of the file to be read.
Returns:: The file read from the Cms.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readFileForHist

public CmsBackupResource readFileForHist(CmsUser currentUser,
                                         CmsProject currentProject,
                                         int versionId,
                                         String filename)
                                  throws CmsException

Reads a file from the history of the Cms.
The reading includes the filecontent.
The file is read from the backup resources. Security: Access is granted, if:

the user has access to the project
the user can read the resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; versionId - The versionid of the file.; filename - The name of the file to be read.
Returns:: The file read from the Cms.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readFileHeaders

public Vector readFileHeaders(CmsUser currentUser,
                              CmsProject currentProject,
                              int projectId)
                       throws CmsException

Reads all file headers for a project from the Cms.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; projectId - The id of the project to read the resources for.
Returns:: a Vector of resources.
Throws:: CmsException - will be thrown, if the file couldn't be read. The CmsException will also be thrown, if the user has not the rights for this resource.

readFolder

public CmsFolder readFolder(CmsUser currentUser,
                            CmsProject currentProject,
                            String folder)
                     throws CmsException

Reads a folder from the Cms.
Security: Access is granted, if:

the user has access to the project
the user can read the resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; folder - The complete path of the folder to be read.
Returns:: folder The read folder.
Throws:: CmsException - will be thrown, if the folder couldn't be read. The CmsException will also be thrown, if the user has not the rights for this resource.

readFolder

public CmsFolder readFolder(CmsUser currentUser,
                            CmsProject currentProject,
                            String folder,
                            boolean includeDeleted)
                     throws CmsException

Reads a folder from the Cms.
Security: Access is granted, if:

the user has access to the project
the user can read the resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; folder - The complete pathname of the folder to be read.; includeDeleted - Include the folder if it is marked as deleted
Returns:: folder The read folder.
Throws:: CmsException - will be thrown, if the folder couldn't be read. The CmsException will also be thrown, if the user has not the rights for this resource.

readFolder

public CmsFolder readFolder(CmsUser currentUser,
                            CmsProject currentProject,
                            int folderid,
                            boolean includeDeleted)
                     throws CmsException

Reads a folder from the Cms.
Security: Access is granted, if:

the user has access to the project
the user can read the resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; folderid - The id of the folder to be read.; includeDeleted - Include the folder if it is marked as deleted
Returns:: folder The read folder.
Throws:: CmsException - will be thrown, if the folder couldn't be read. The CmsException will also be thrown, if the user has not the rights for this resource.

readGivenTasks

public Vector readGivenTasks(CmsUser currentUser,
                             CmsProject currentProject,
                             int projectId,
                             String ownerName,
                             int taskType,
                             String orderBy,
                             String sort)
                      throws CmsException

Reads all given tasks from a user for a project. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; projectId - The id of the Project in which the tasks are defined.; orderBy - Chooses, how to order the tasks.
Throws:: CmsException - Throws CmsException if something goes wrong.

readGroup

public CmsGroup readGroup(CmsUser currentUser,
                          CmsProject currentProject,
                          CmsProject project)
                   throws CmsException

Reads the group of a project from the OpenCms. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: The group of a resource.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readGroup

public CmsGroup readGroup(CmsUser currentUser,
                          CmsProject currentProject,
                          CmsResource resource)
                   throws CmsException

Reads the group of a resource from the OpenCms. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: The group of a resource.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readGroup

public CmsGroup readGroup(CmsUser currentUser,
                          CmsProject currentProject,
                          CmsTask task)
                   throws CmsException

Reads the group (role) of a task from the OpenCms. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; task - The task to read from.
Returns:: The group of a resource.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readGroup

public CmsGroup readGroup(CmsUser currentUser,
                          CmsProject currentProject,
                          String groupname)
                   throws CmsException

Returns a group object.

Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; groupname - The name of the group that is to be read.
Returns:: Group.
Throws:: CmsException - Throws CmsException if operation was not succesful

readGroup

public CmsGroup readGroup(CmsUser currentUser,
                          CmsProject currentProject,
                          int groupid)
                   throws CmsException

Returns a group object.

Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; groupid - The id of the group that is to be read.
Returns:: Group.
Throws:: CmsException - Throws CmsException if operation was not succesful

readManagerGroup

public CmsGroup readManagerGroup(CmsUser currentUser,
                                 CmsProject currentProject,
                                 CmsProject project)
                          throws CmsException

Reads the managergroup of a project from the OpenCms. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: The group of a resource.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readMimeTypes

public Hashtable readMimeTypes(CmsUser currentUser,
                               CmsProject currentProject)
                        throws CmsException

Gets the MimeTypes. The Mime-Types will be returned. Security: All users are garnted

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: the mime-types.; CmsException

readOriginalAgent

public CmsUser readOriginalAgent(CmsUser currentUser,
                                 CmsProject currentProject,
                                 CmsTask task)
                          throws CmsException

Reads the original agent of a task from the OpenCms. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; task - The task to read the original agent from.
Returns:: The owner of a task.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readOwner

public CmsUser readOwner(CmsUser currentUser,
                         CmsProject currentProject,
                         CmsProject project)
                  throws CmsException

Reads the owner of a project from the OpenCms. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: The owner of a resource.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readOwner

public CmsUser readOwner(CmsUser currentUser,
                         CmsProject currentProject,
                         CmsResource resource)
                  throws CmsException

Reads the owner of a resource from the OpenCms. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: The owner of a resource.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readOwner

public CmsUser readOwner(CmsUser currentUser,
                         CmsProject currentProject,
                         CmsTask task)
                  throws CmsException

Reads the owner (initiator) of a task from the OpenCms. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; task - The task to read the owner from.
Returns:: The owner of a task.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readOwner

public CmsUser readOwner(CmsUser currentUser,
                         CmsProject currentProject,
                         CmsTaskLog log)
                  throws CmsException

Reads the owner of a tasklog from the OpenCms. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: The owner of a resource.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readProject

public CmsProject readProject(CmsUser currentUser,
                              CmsProject currentProject,
                              int id)
                       throws CmsException

Reads a project from the Cms. Security All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; id - The id of the project to read.
Throws:: CmsException - Throws CmsException if something goes wrong.

readProject

public CmsProject readProject(CmsUser currentUser,
                              CmsProject currentProject,
                              CmsResource res)
                       throws CmsException

Reads a project from the Cms. Security All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; res - The resource to read the project of.
Throws:: CmsException - Throws CmsException if something goes wrong.

readProject

public CmsProject readProject(CmsUser currentUser,
                              CmsProject currentProject,
                              CmsTask task)
                       throws CmsException

Reads a project from the Cms. Security All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; task - The task to read the project of.
Throws:: CmsException - Throws CmsException if something goes wrong.

readProjectView

public Vector readProjectView(CmsUser currentUser,
                              CmsProject currentProject,
                              int projectId,
                              String filter)
                       throws CmsException

Reads all file headers of a project from the Cms.

Parameters:: projectId - the id of the project to read the file headers for.; filter - The filter for the resources (all, new, changed, deleted, locked)
Returns:: a Vector of resources.; CmsException

readBackupProject

public CmsBackupProject readBackupProject(CmsUser currentUser,
                                          CmsProject currentProject,
                                          int versionId)
                                   throws CmsException

Reads the backup of a project from the Cms. Security All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; versionId - The versionId of the project.
Throws:: CmsException - Throws CmsException if something goes wrong.

readProjectLogs

public Vector readProjectLogs(CmsUser currentUser,
                              CmsProject currentProject,
                              int projectId)
                       throws CmsException

Reads log entries for a project.

Parameters:: projectId - The id of the projec for tasklog to read.
Returns:: A Vector of new TaskLog objects
Throws:: CmsException - Throws CmsException if something goes wrong.

readProperty

public String readProperty(CmsUser currentUser,
                           CmsProject currentProject,
                           String resource,
                           String siteRoot,
                           String property,
                           boolean search)
                    throws CmsException

Looks up a specified property with optional direcory upward cascading.

Security: Only a user is granted who has the right to read the resource.

Parameters:: currentUser - the current user; currentProject - the current project of the user; resource - the resource to look up the property for; property - the name of the property to look up; search - if true, the property will be looked up on all parent folders if it is not attached to the the resource, if false not (ie. normal property lookup)
Returns:: the value of the property found, null if nothing was found
Throws:: CmsException - in case there where problems reading the property

readProperty

public String readProperty(CmsUser currentUser,
                           CmsProject currentProject,
                           String resource,
                           String siteRoot,
                           String property,
                           boolean search,
                           String propertyDefault)
                    throws CmsException

Looks up a specified property with optional direcory upward cascading, a default value will be returned if the property is not found on the resource (or it's parent folders in case search is set to true).

Security: Only a user is granted who has the right to read the resource.

Parameters:: currentUser - the current user; currentProject - the current project of the user; resource - the resource to look up the property for; property - the name of the property to look up; search - if true, the property will be looked up on all parent folders if it is not attached to the the resource, if false not (ie. normal property lookup); propertyDefault - a default value that will be returned if the property was not found on the selected resource
Returns:: the value of the property found, if nothing was found the value of the propertyDefault parameter is returned
Throws:: CmsException - in case there where problems reading the property

readProperties

public Map readProperties(CmsUser currentUser,
                          CmsProject currentProject,
                          String resource,
                          String siteRoot,
                          boolean search)
                   throws CmsException

Looks up all properties for a resource with optional direcory upward cascading.

Security: Only a user is granted who has the right to read the resource.

Parameters:: currentUser - the current user; currentProject - the current project of the user; resource - the resource to look up the property for; search - if true, the properties will also be looked up on all parent folders and the results will be merged, if false not (ie. normal property lookup)
Returns:: Map of Strings representing all properties of the resource
Throws:: CmsException - in case there where problems reading the properties

readPropertydefinition

public CmsPropertydefinition readPropertydefinition(CmsUser currentUser,
                                                    CmsProject currentProject,
                                                    String name,
                                                    String resourcetype)
                                             throws CmsException

Reads a definition for the given resource type. Security All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; name - The name of the propertydefinition to read.; resourcetype - The name of the resource type for which the propertydefinition is valid.
Returns:: propertydefinition The propertydefinition that corresponds to the overgiven arguments - or null if there is no valid propertydefinition.
Throws:: CmsException - Throws CmsException if something goes wrong.

readResources

public Vector readResources(CmsProject project)
                     throws CmsException

Insert the method's description here. Creation date: (09-10-2000 09:30:47)

Parameters:: project - com.opencms.file.CmsProject
Returns:: java.util.Vector
Throws:: CmsException - The exception description.

readTask

public CmsTask readTask(CmsUser currentUser,
                        CmsProject currentProject,
                        int id)
                 throws CmsException

Read a task by id. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; id - The id for the task to read.
Throws:: CmsException - Throws CmsException if something goes wrong.

readTaskLogs

public Vector readTaskLogs(CmsUser currentUser,
                           CmsProject currentProject,
                           int taskid)
                    throws CmsException

Reads log entries for a task. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; taskid - The task for the tasklog to read .
Returns:: A Vector of new TaskLog objects
Throws:: CmsException - Throws CmsException if something goes wrong.

readTasksForProject

public Vector readTasksForProject(CmsUser currentUser,
                                  CmsProject currentProject,
                                  int projectId,
                                  int tasktype,
                                  String orderBy,
                                  String sort)
                           throws CmsException

Reads all tasks for a project. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; projectId - The id of the Project in which the tasks are defined. Can be null for all tasks; tasktype - Task type you want to read: C_TASKS_ALL, C_TASKS_OPEN, C_TASKS_DONE, C_TASKS_NEW; orderBy - Chooses, how to order the tasks.; sort - Sort order C_SORT_ASC, C_SORT_DESC, or null
Throws:: CmsException - Throws CmsException if something goes wrong.

readTasksForRole

public Vector readTasksForRole(CmsUser currentUser,
                               CmsProject currentProject,
                               int projectId,
                               String roleName,
                               int tasktype,
                               String orderBy,
                               String sort)
                        throws CmsException

Reads all tasks for a role in a project. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; projectId - The id of the Project in which the tasks are defined.; tasktype - Task type you want to read: C_TASKS_ALL, C_TASKS_OPEN, C_TASKS_DONE, C_TASKS_NEW.; orderBy - Chooses, how to order the tasks.; sort - Sort order C_SORT_ASC, C_SORT_DESC, or null
Throws:: CmsException - Throws CmsException if something goes wrong.

readTasksForUser

public Vector readTasksForUser(CmsUser currentUser,
                               CmsProject currentProject,
                               int projectId,
                               String userName,
                               int tasktype,
                               String orderBy,
                               String sort)
                        throws CmsException

Reads all tasks for a user in a project. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; projectId - The id of the Project in which the tasks are defined.; tasktype - Task type you want to read: C_TASKS_ALL, C_TASKS_OPEN, C_TASKS_DONE, C_TASKS_NEW.; orderBy - Chooses, how to order the tasks.; sort - Sort order C_SORT_ASC, C_SORT_DESC, or null
Throws:: CmsException - Throws CmsException if something goes wrong.

readUser

public CmsUser readUser(CmsUser currentUser,
                        CmsProject currentProject,
                        int id)
                 throws CmsException

Returns a user object.

Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; id - The id of the user that is to be read.
Returns:: User
Throws:: CmsException - Throws CmsException if operation was not succesful

readUser

public CmsUser readUser(CmsUser currentUser,
                        CmsProject currentProject,
                        String username)
                 throws CmsException

Returns a user object.

Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; username - The name of the user that is to be read.
Returns:: User
Throws:: CmsException - Throws CmsException if operation was not succesful

readUser

public CmsUser readUser(CmsUser currentUser,
                        CmsProject currentProject,
                        String username,
                        int type)
                 throws CmsException

Returns a user object.

Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; username - The name of the user that is to be read.; type - The type of the user.
Returns:: User
Throws:: CmsException - Throws CmsException if operation was not succesful

readUser

public CmsUser readUser(CmsUser currentUser,
                        CmsProject currentProject,
                        String username,
                        String password)
                 throws CmsException

Returns a user object if the password for the user is correct.

Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; username - The username of the user that is to be read.; password - The password of the user that is to be read.
Returns:: User
Throws:: CmsException - Throws CmsException if operation was not succesful

readWebUser

public CmsUser readWebUser(CmsUser currentUser,
                           CmsProject currentProject,
                           String username)
                    throws CmsException

Returns a user object if the password for the user is correct.

Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; username - The username of the user that is to be read.
Returns:: User
Throws:: CmsException - Throws CmsException if operation was not succesful

readWebUser

public CmsUser readWebUser(CmsUser currentUser,
                           CmsProject currentProject,
                           String username,
                           String password)
                    throws CmsException

Returns a user object if the password for the user is correct.

Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; username - The username of the user that is to be read.; password - The password of the user that is to be read.
Returns:: User
Throws:: CmsException - Throws CmsException if operation was not succesful

reaktivateTask

public void reaktivateTask(CmsUser currentUser,
                           CmsProject currentProject,
                           int taskId)
                    throws CmsException

Reaktivates a task from the Cms. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Throws:: CmsException - Throws CmsException if something goes wrong.

recoverPassword

public void recoverPassword(CmsObject cms,
                            CmsUser currentUser,
                            CmsProject currentProject,
                            String username,
                            String recoveryPassword,
                            String newPassword)
                     throws CmsException

Sets a new password only if the user knows his recovery-password. All users can do this if he knows the recovery-password.

Security: All users can do this if he knows the recovery-password.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; username - The name of the user.; recoveryPassword - The recovery password.; newPassword - The new password.
Throws:: CmsException - Throws CmsException if operation was not succesfull.

removeUserFromGroup

public void removeUserFromGroup(CmsUser currentUser,
                                CmsProject currentProject,
                                String username,
                                String groupname)
                         throws CmsException

Removes a user from a group. Only the admin can do this.

Security: Only users, which are in the group "administrators" are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; username - The name of the user that is to be removed from the group.; groupname - The name of the group.
Throws:: CmsException - Throws CmsException if operation was not succesful.

renameFile

public void renameFile(CmsUser currentUser,
                       CmsProject currentProject,
                       String oldname,
                       String newname)
                throws CmsException

Renames the file to a new name.
Rename can only be done in an offline project. To rename a file, the following steps have to be done:

Copy the file with the oldname to a file with the new name, the state of the new file is set to NEW (2).
- If the state of the original file is UNCHANGED (0), the file content of the file is read from the online project.
- If the state of the original file is CHANGED (1) or NEW (2) the file content of the file is read from the offline project.
Set the state of the old file to DELETED (3).

Security: Access is granted, if:

the user has access to the project
the user can write the resource
the resource is locked by the callingUser

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; oldname - The complete path to the resource which will be renamed.; newname - The new name of the resource (CmsUser callingUser, No path information allowed).
Throws:: CmsException - Throws CmsException if operation was not succesful.

restoreSession

public Hashtable restoreSession(String oldSessionId)
                         throws CmsException

This method loads old sessiondata from the database. It is used for sessionfailover.

Parameters:: oldSessionId - the id of the old session.
Returns:: the old sessiondata.; CmsException

restoreResource

public void restoreResource(CmsUser currentUser,
                            CmsProject currentProject,
                            int versionId,
                            String filename)
                     throws CmsException

Restores a file in the current project with a version in the backup

Parameters:: currentUser - The current user; currentProject - The current project; versionId - The version id of the resource; filename - The name of the file to restore
Throws:: CmsException - Throws CmsException if operation was not succesful.

setName

public void setName(CmsUser currentUser,
                    CmsProject currentProject,
                    int taskId,
                    String name)
             throws CmsException

Set a new name for a task Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; name - The new name value
Throws:: CmsException - Throws CmsException if something goes wrong.

setParentGroup

public void setParentGroup(CmsUser currentUser,
                           CmsProject currentProject,
                           String groupName,
                           String parentGroupName)
                    throws CmsException

Sets a new parent-group for an already existing group in the Cms.
Only the admin can do this.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; groupName - The name of the group that should be written to the Cms.; parentGroupName - The name of the parentGroup to set, or null if the parent group should be deleted.
Throws:: CmsException - Throws CmsException if operation was not succesfull.

setPassword

public void setPassword(CmsObject cms,
                        CmsUser currentUser,
                        CmsProject currentProject,
                        String username,
                        String newPassword)
                 throws CmsException

Sets the password for a user. Only a adminstrator can do this.

Security: Users, which are in the group "administrators" are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; username - The name of the user.; newPassword - The new password.
Throws:: CmsException - Throws CmsException if operation was not succesfull.

setPassword

public void setPassword(CmsObject cms,
                        CmsUser currentUser,
                        CmsProject currentProject,
                        String username,
                        String oldPassword,
                        String newPassword)
                 throws CmsException

Sets the password for a user. Every user who knows the username and the password can do this.

Security: Users, who knows the username and the password are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; username - The name of the user.; oldPassword - The new password.; newPassword - The new password.
Throws:: CmsException - Throws CmsException if operation was not succesfull.

setPriority

public void setPriority(CmsUser currentUser,
                        CmsProject currentProject,
                        int taskId,
                        int priority)
                 throws CmsException

Set priority of a task Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Throws:: CmsException - Throws CmsException if something goes wrong.

setRecoveryPassword

public void setRecoveryPassword(CmsObject cms,
                                CmsUser currentUser,
                                CmsProject currentProject,
                                String username,
                                String password,
                                String newPassword)
                         throws CmsException

Sets the recovery password for a user. Only a adminstrator or the curretuser can do this.

Security: Users, which are in the group "administrators" are granted.
Current users can change their own password.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; username - The name of the user.; newPassword - The recovery password.
Throws:: CmsException - Throws CmsException if operation was not succesfull.

setTaskPar

public void setTaskPar(CmsUser currentUser,
                       CmsProject currentProject,
                       int taskid,
                       String parname,
                       String parvalue)
                throws CmsException

Set a Parameter for a task. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; taskid - The Id of the task.; parname - Name of the parameter.; parvalue - Value if the parameter.
Returns:: The id of the inserted parameter or 0 if the parameter already exists for this task.
Throws:: CmsException - Throws CmsException if something goes wrong.

setTimeout

public void setTimeout(CmsUser currentUser,
                       CmsProject currentProject,
                       int taskId,
                       long timeout)
                throws CmsException

Set timeout of a task Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Throws:: CmsException - Throws CmsException if something goes wrong.

storeSession

public void storeSession(String sessionId,
                         Hashtable sessionData)
                  throws CmsException

This method stores sessiondata into the database. It is used for sessionfailover.

Parameters:: sessionId - the id of the session.
Returns:: data the sessionData.; CmsException

undoChanges

public void undoChanges(CmsUser currentUser,
                        CmsProject currentProject,
                        String resourceName)
                 throws CmsException

Undo all changes in the resource, restore the online file.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; resourceName - The name of the resource to be restored.
Throws:: CmsException - Throws CmsException if something goes wrong.

unlockProject

public void unlockProject(CmsUser currentUser,
                          CmsProject currentProject,
                          int id)
                   throws CmsException

Unlocks all resources in this project. Security Only the admin or the owner of the project can do this.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; id - The id of the project to be published.
Throws:: CmsException - Throws CmsException if something goes wrong.

unlockResource

public void unlockResource(CmsUser currentUser,
                           CmsProject currentProject,
                           String resourcename)
                    throws CmsException

Unlocks a resource.
Only a resource in an offline project can be unlock. The state of the resource is set to CHANGED (1). If the content of this resource is not exisiting in the offline project already, it is read from the online project and written into the offline project. Only the user who locked a resource can unlock it. Security: Access is granted, if:

the user had locked the resource before

Parameters:: resourcename - The complete path to the resource to lock.
Throws:: CmsException - Throws CmsException if operation was not succesful.

userInGroup

public boolean userInGroup(CmsUser currentUser,
                           CmsProject currentProject,
                           String username,
                           String groupname)
                    throws CmsException

Checks if a user is member of a group.

Security: All users are granted, except the anonymous user.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; groupname - The name of the group to check.
Returns:: True or False
Throws:: CmsException - Throws CmsException if operation was not succesful

writeExportPath

public void writeExportPath(CmsUser currentUser,
                            CmsProject currentProject,
                            String path)
                     throws CmsException

Writes the export-path for the system. This path is used for db-export and db-import. Security: Users, which are in the group "administrators" are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; CmsException

writeFile

public void writeFile(CmsUser currentUser,
                      CmsProject currentProject,
                      CmsFile file)
               throws CmsException

Writes a file to the Cms.
A file can only be written to an offline project.
The state of the resource is set to CHANGED (1). The file content of the file is either updated (if it is already existing in the offline project), or created in the offline project (if it is not available there).
Security: Access is granted, if:

the user has access to the project
the user can write the resource
the resource is locked by the callingUser

Parameters:: currentUser - The user who own this file.; currentProject - The project in which the resource will be used.; file - The name of the file to write.
Throws:: CmsException - Throws CmsException if operation was not succesful.

writeResource

public void writeResource(CmsUser currentUser,
                          CmsProject currentProject,
                          String resourcename,
                          Map properties,
                          String username,
                          String groupname,
                          int accessFlags,
                          int resourceType,
                          byte[] filecontent)
                   throws CmsException

Writes a resource and its properties to the Cms.
A resource can only be written to an offline project.
The state of the resource is set to CHANGED (1). The file content of the file is either updated (if it is already existing in the offline project), or created in the offline project (if it is not available there).
Security: Access is granted, if:

the user has access to the project
the user can write the resource
the resource is locked by the callingUser
the user is the owner of the resource or administrator

Parameters:: currentUser - The current user.; currentProject - The project in which the resource will be used.; resourcename - The name of the resource to write.; properties - The properties of the resource.; username - The name of the new owner of the resource; groupname - The name of the new group of the resource; accessFlags - The new accessFlags of the resource; resourceType - The new type of the resource; filecontent - The new filecontent of the resource
Throws:: CmsException - Throws CmsException if operation was not succesful.

writeFileExtensions

public void writeFileExtensions(CmsUser currentUser,
                                CmsProject currentProject,
                                Hashtable extensions)
                         throws CmsException

Writes the file extensions Security: Users, which are in the group "Administrators" are authorized.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; extensions - Holds extensions as keys and resourcetypes (Stings) as values; CmsException

writeFileHeader

public void writeFileHeader(CmsUser currentUser,
                            CmsProject currentProject,
                            CmsFile file)
                     throws CmsException

Writes a fileheader to the Cms.
A file can only be written to an offline project.
The state of the resource is set to CHANGED (1). The file content of the file is either updated (if it is already existing in the offline project), or created in the offline project (if it is not available there).
Security: Access is granted, if:

the user has access to the project
the user can write the resource
the resource is locked by the callingUser

Parameters:: currentUser - The user who own this file.; currentProject - The project in which the resource will be used.; file - The file to write.
Throws:: CmsException - Throws CmsException if operation was not succesful.

writeGroup

public void writeGroup(CmsUser currentUser,
                       CmsProject currentProject,
                       CmsGroup group)
                throws CmsException

Writes an already existing group in the Cms.
Only the admin can do this.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; group - The group that should be written to the Cms.
Throws:: CmsException - Throws CmsException if operation was not succesfull.

writeProperties

public void writeProperties(CmsUser currentUser,
                            CmsProject currentProject,
                            String resource,
                            Map propertyinfos)
                     throws CmsException

Writes a couple of propertyinformation for a file or folder. Security Only the user is granted, who has the right to write the resource.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; resource - The name of the resource of which the propertyinformation has to be read.; propertyinfos - A Hashtable with propertydefinition- propertyinfo-pairs as strings.
Throws:: CmsException - Throws CmsException if operation was not succesful

writeProperty

public void writeProperty(CmsUser currentUser,
                          CmsProject currentProject,
                          String resource,
                          String property,
                          String value)
                   throws CmsException

Writes a propertyinformation for a file or folder. Security Only the user is granted, who has the right to write the resource.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; resource - The name of the resource of which the propertyinformation has to be read.; property - The propertydefinition-name of which the propertyinformation has to be set.; value - The value for the propertyinfo to be set.
Throws:: CmsException - Throws CmsException if operation was not succesful

writePropertydefinition

public CmsPropertydefinition writePropertydefinition(CmsUser currentUser,
                                                     CmsProject currentProject,
                                                     CmsPropertydefinition propertydef)
                                              throws CmsException

Updates the propertydefinition for the resource type.
Security Only the admin can do this.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; propertydef - The propertydef to be deleted.
Returns:: The propertydefinition, that was written.
Throws:: CmsException - Throws CmsException if something goes wrong.

writeTaskLog

public void writeTaskLog(CmsUser currentUser,
                         CmsProject currentProject,
                         int taskid,
                         String comment)
                  throws CmsException

Writes a new user tasklog for a task. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; taskid - The Id of the task .; comment - Description for the log
Throws:: CmsException - Throws CmsException if something goes wrong.

writeTaskLog

public void writeTaskLog(CmsUser currentUser,
                         CmsProject currentProject,
                         int taskid,
                         String comment,
                         int taskType)
                  throws CmsException

Writes a new user tasklog for a task. Security: All users are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; taskid - The Id of the task .; comment - Description for the log
Throws:: CmsException - Throws CmsException if something goes wrong.

writeUser

public void writeUser(CmsUser currentUser,
                      CmsProject currentProject,
                      CmsUser user)
               throws CmsException

Updates the user information.
Only the administrator can do this.

Security: Only users, which are in the group "administrators" are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; user - The user to be updated.
Throws:: CmsException - Throws CmsException if operation was not succesful

writeWebUser

public void writeWebUser(CmsUser currentUser,
                         CmsProject currentProject,
                         CmsUser user)
                  throws CmsException

Updates the user information of a web user.
Only a web user can be updated this way.

Security: Only users of the user type webuser can be updated this way.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; user - The user to be updated.
Throws:: CmsException - Throws CmsException if operation was not succesful

changeLockedInProject

public void changeLockedInProject(int projectId,
                                  String resourcename,
                                  CmsUser currentUser)
                           throws CmsException

Changes the project-id of a resource to the new project for publishing the resource directly

Parameters:: resourcename - The name of the resource to change; CmsException

isHistoryEnabled

public boolean isHistoryEnabled(CmsObject cms)

Check if the history is enabled

Parameters:: cms - The CmsObject
Returns:: boolean Is true if history is enabled

getBackupVersionId

public int getBackupVersionId()

Get the next version id for the published backup resources

Returns:: int The new version id

backupProject

public void backupProject(int projectId,
                          int versionId,
                          long publishDate,
                          CmsUser currentUser)
                   throws CmsException

Creates a backup of the published project

Parameters:: versionId - The version of the backup; publishDate - The date of publishing
Throws:: CmsException - Throws CmsException if operation was not succesful.

readCronTable

public String readCronTable(CmsUser currentUser,
                            CmsProject currentProject)
                     throws CmsException

Gets the Crontable. Security: All users are garnted

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: the crontable.; CmsException

writeCronTable

public void writeCronTable(CmsUser currentUser,
                           CmsProject currentProject,
                           String crontable)
                    throws CmsException

Writes the Crontable. Security: Only a administrator can do this

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: the crontable.; CmsException

digest

public String digest(String value)

Method to encrypt the passwords.

Parameters:: value - The value to encrypt.
Returns:: The encrypted value.

getLimitedWorkplacePort

public int getLimitedWorkplacePort()

This is the port the workplace access is limited to. With the opencms.properties the access to the workplace can be limited to a user defined port. With this feature a firewall can block all outside requests to this port with the result the workplace is only available in the local net segment.

Returns:: the portnumber or -1 if no port is set.

changeUserType

public void changeUserType(CmsUser currentUser,
                           CmsProject currentProject,
                           int userId,
                           int userType)
                    throws CmsException

Changes the user type of the user Only the administrator can change the type

Parameters:: currentUser - The current user; currentProject - The current project; userId - The id of the user to change; userType - The new usertype of the user; CmsException

changeUserType

public void changeUserType(CmsUser currentUser,
                           CmsProject currentProject,
                           String username,
                           int userType)
                    throws CmsException

Changes the user type of the user Only the administrator can change the type

Parameters:: currentUser - The current user; currentProject - The current project; username - The name of the user to change; userType - The new usertype of the user; CmsException

changeUserType

public void changeUserType(CmsUser currentUser,
                           CmsProject currentProject,
                           CmsUser user,
                           int userType)
                    throws CmsException

Changes the user type of the user Only the administrator can change the type

Parameters:: currentUser - The current user; currentProject - The current project; user - The CmsUser object of the user to change; userType - The new usertype of the user; CmsException

readResourcesLikeName

public Vector readResourcesLikeName(CmsUser currentUser,
                                    CmsProject currentProject,
                                    String resourcename)
                             throws CmsException

Returns a Vector with the resources that contains the given part in the resourcename.
Security: Access is granted, if:

the user has access to the project
the user can read and view this resource

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; resourcename - A part of resourcename
Returns:: subfolders A Vector with resources.
Throws:: CmsException - Throws CmsException if operation was not succesful.

readFilesByType

public Vector readFilesByType(CmsUser currentUser,
                              CmsProject currentProject,
                              int projectId,
                              int resourcetype)
                       throws CmsException

Reads all files from the Cms, that are of the given type.

Parameters:: projectId - A project id for reading online or offline resources; resourcetype - The type of the files.
Returns:: A Vector of files.
Throws:: CmsException - Throws CmsException if operation was not succesful

writeLinkCheckTable

public void writeLinkCheckTable(CmsUser currentUser,
                                CmsProject currentProject,
                                Hashtable linkchecktable)
                         throws CmsException

Writes the Linkchecktable. Security: Only a administrator can do this

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; linkchecktable - The hashtable that contains the links that were not reachable
Returns:: the linkchecktable.; CmsException

readLinkCheckTable

public Hashtable readLinkCheckTable(CmsUser currentUser,
                                    CmsProject currentProject)
                             throws CmsException

Gets the Linkchecktable. Security: All users are garnted

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.
Returns:: the linkchecktable.; CmsException

deleteBackups

public int deleteBackups(CmsObject cms,
                         CmsUser currentUser,
                         CmsProject currentProject,
                         int weeks)
                  throws CmsException

Deletes the versions from the backup tables that are older then the given weeks

Parameters:: cms - The CmsObject for reading the registry; currentUser - The current user; currentProject - The currently used project; weeks - The number of weeks: the max age of the remaining versions
Returns:: int The oldest remaining version; CmsException

accessReadVisible

public boolean accessReadVisible(CmsUser currentUser,
                                 CmsProject currentProject,
                                 CmsResource resource)
                          throws CmsException

Checks, if the user may read this resource and if it is visible to him. NOTE: If the ressource is in the project you never have to fallback.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; resource - The resource to check.
Returns:: weather the user has access, or not.; CmsException

getVisibleResourcesWithProperty

public Vector getVisibleResourcesWithProperty(CmsUser currentUser,
                                              CmsProject currentProject,
                                              String propertyDefinition,
                                              String propertyValue,
                                              int resourceType)
                                       throws CmsException

Returns a Vector with all resources of the given type that have set the given property to the given value. Security: All users that have read and view access are granted.

Parameters:: currentUser - The user who requested this method.; currentProject - The current project of the user.; resourceType - The resource type of the resource
Returns:: Vector with all resources.
Throws:: CmsException - Throws CmsException if operation was not succesful.

joinLinksToTargets

public ArrayList joinLinksToTargets(CmsObject cms,
                                    CmsUser theUser,
                                    CmsProject theProject,
                                    I_CmsReport theReport)
                             throws CmsException

Rebuilds the internal datastructure to join links with their targets. Each target saves the total count of links pointing to itself. Each links saves the ID of it's target.

Parameters:: cms - the user's CmsObject instance; theUser - the user; theProject - the project; theReport - the report to print the output
Returns:: an ArrayList with the resources which were identified as broken links; CmsException
See Also:: CmsDbAccess.updateResourceFlags(com.opencms.file.CmsProject, int, int), CmsDbAccess.fetchAllVfsLinks(com.opencms.file.CmsProject, java.util.ArrayList, java.util.ArrayList, java.util.ArrayList, int), CmsDbAccess.fetchResourceID(com.opencms.file.CmsProject, java.lang.String, int), CmsDbAccess.updateAllResourceFlags(com.opencms.file.CmsProject, int)

fetchVfsLinksForResource

public ArrayList fetchVfsLinksForResource(CmsUser theUser,
                                          CmsProject theProject,
                                          String theResourceName)
                                   throws CmsException

Fetches all VFS links pointing to a given resource name.

Parameters:: theProject - the current project; theResourceName - the name of the resource of which the VFS links are fetched
Returns:: an ArrayList with the resource names of the fetched VFS links
Throws:: CmsException

decrementLinkCountForResource

public int decrementLinkCountForResource(CmsProject theProject,
                                         String theResourceName)
                                  throws CmsException

Decrement the VFS link counter for a resource.

Parameters:: theProject - the current project; theResourceName - the name of the resource for which the link count is decremented
Returns:: the current link count of the specified resource
Throws:: CmsException

incrementLinkCountForResource

public int incrementLinkCountForResource(CmsProject theProject,
                                         String theResourceName)
                                  throws CmsException

Increment the VFS link counter for a resource.

Parameters:: theProject - the current project; theResourceName - the name of the resource for which the link count is incremented
Returns:: the current link count of the specified resource
Throws:: CmsException

linkResourceToTarget

public void linkResourceToTarget(CmsProject theProject,
                                 String theLinkResourceName,
                                 String theTargetResourceName)
                          throws CmsException

Save the ID of the target resource for a VFS link. The target ID is saved in the RESOURCE_FLAGS table attribute.

Parameters:: theProject - the current project; theLinkResourceName - the resource name of the VFS link; theTargetResourceName - the name of the link's target resource
Throws:: CmsException

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.opencms.file Interface I_CmsResourceBroker

acceptTask

accessCreate

accessLock

accessProject

accessRead

accessWrite

addFileExtension

addGroup

addUser

addImportUser

addUserToGroup

addWebUser

addWebUser

anonymousUser

chgrp

chmod

chown

touch

chstate

chtype

clearcache

copyFile

copyFolder

copyResourceToProject

countLockedResources

createFile

createFolder

importResource

createProject

createProject

createProject

createDirectPublishProject

createTempfileProject

createPropertydefinition

createTask

createTask

deleteAllProperties

deleteFile

deleteFolder

undeleteResource

deleteGroup

deleteProject

deleteProperty

deletePropertydefinition

deleteUser

deleteUser

deleteWebUser

destroy

endTask

exportResources

exportResources

exportResources

exportModuledata

exportStaticResources

exportStaticResources

forwardTask

getAllAccessibleProjects

getAllManageableProjects

getAllBackupProjects

getAllExportLinks

getAllResourceTypes

getCacheInfo

getChild

getChilds

getConfigurations

getDirectGroupsOfUser

getFilesInFolder

getFilesInFolder

getFilesWithProperty

getFileSystemChanges

getFileSystemFolderChanges

getFolderTree

getGroups

getGroupsOfUser

getParent

getParentResource

getReadingpermittedGroup

getRegistry

getResourcesInFolder

com.opencms.file
Interface I_CmsResourceBroker