Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.opencms.file
Class CmsObject  view CmsObject download CmsObject.java

java.lang.Object
  extended bycom.opencms.file.CmsObject
All Implemented Interfaces:
com.opencms.core.I_CmsConstants

public class CmsObject
extends java.lang.Object
implements com.opencms.core.I_CmsConstants

This class provides access to the OpenCms and its resources.
The CmsObject encapsulates user identification and client requests and is the central object to transport information in the Cms Servlet.
All operations on the CmsObject are forwarded to the class which extends A_CmsRessourceBroker to ensure user authentification in all operations.

Version:
$Revision: 1.268.2.2 $

Field Summary
private static int DEBUG
          Internal debug flag, set to 9 for maximum verbosity
private  CmsRequestContext m_context
          The resource broker to access the cms.
private  com.opencms.launcher.CmsLauncherManager m_launcherManager
          The launcher manager used with this object, Is needed to clear the template caches.
private  com.opencms.linkmanagement.LinkChecker m_linkChecker
          The class for linkmanagement.
private  com.opencms.util.LinkSubstitution m_linkSubstitution
          The class for processing links.
private  int m_mode
          the modus the cmsObject runs in (used i.e.
private  I_CmsResourceBroker m_rb
          The resource broker to access the cms.
private  com.opencms.core.CmsCoreSession m_sessionStorage
          Method that can be invoked to find out all currently logged in users.
 
Fields inherited from interface com.opencms.core.I_CmsConstants
C_ACCESS_DEFAULT_FLAGS, C_ACCESS_GROUP, C_ACCESS_GROUP_READ, C_ACCESS_GROUP_VISIBLE, C_ACCESS_GROUP_WRITE, C_ACCESS_INTERNAL_READ, C_ACCESS_OWNER, C_ACCESS_OWNER_READ, C_ACCESS_OWNER_VISIBLE, C_ACCESS_OWNER_WRITE, C_ACCESS_PUBLIC, C_ACCESS_PUBLIC_READ, C_ACCESS_PUBLIC_VISIBLE, C_ACCESS_PUBLIC_WRITE, C_ACCESS_READ, C_ACCESS_VISIBLE, C_ACCESS_WRITE, C_ADDITIONAL_INFO_EXPLORERSETTINGS, C_ADDITIONAL_INFO_PREFERENCES, C_ADDITIONAL_INFO_STARTSETTINGS, C_ADDITIONAL_INFO_TASKSETTINGS, C_ADDITIONAL_INFO_TOWN, C_ADDITIONAL_INFO_ZIPCODE, C_AT_LEAST_ONCE, C_CLUSTERURL, C_CONFIGURATION_CACHE, C_CONFIGURATION_CLASS, C_CONFIGURATION_REGISTRY, C_CONFIGURATION_RESOURCEBROKER, C_COPYRIGHT, C_DEFAULT_SITE, C_DELETE_HISTORY, C_ENABLE_HISTORY, C_ERRPREFIX, C_ERRSPERATOR, C_EXPORT_TAG_ACCESS, C_EXPORT_TAG_ADDRESS, C_EXPORT_TAG_CREATOR, C_EXPORT_TAG_DATE, C_EXPORT_TAG_DEFAULTGROUP, C_EXPORT_TAG_DESCRIPTION, C_EXPORT_TAG_DESTINATION, C_EXPORT_TAG_EMAIL, C_EXPORT_TAG_EXPORT, C_EXPORT_TAG_FILE, C_EXPORT_TAG_FIRSTNAME, C_EXPORT_TAG_FLAGS, C_EXPORT_TAG_GROUP, C_EXPORT_TAG_GROUPDATA, C_EXPORT_TAG_GROUPNAME, C_EXPORT_TAG_INFO, C_EXPORT_TAG_LASTMODIFIED, C_EXPORT_TAG_LASTNAME, C_EXPORT_TAG_LAUNCHER_START_CLASS, C_EXPORT_TAG_MODULEXPORT, C_EXPORT_TAG_NAME, C_EXPORT_TAG_OC_VERSION, C_EXPORT_TAG_PARENTGROUP, C_EXPORT_TAG_PASSWORD, C_EXPORT_TAG_PROJECT, C_EXPORT_TAG_PROPERTIES, C_EXPORT_TAG_PROPERTY, C_EXPORT_TAG_RECOVERYPASSWORD, C_EXPORT_TAG_SECTION, C_EXPORT_TAG_SOURCE, C_EXPORT_TAG_TYPE, C_EXPORT_TAG_USER, C_EXPORT_TAG_USERDATA, C_EXPORT_TAG_USERGROUPDATA, C_EXPORT_TAG_USERGROUPS, C_EXPORT_TAG_USERINFO, C_EXPORT_TAG_VALUE, C_EXPORT_TAG_VERSION, C_EXPORT_VERSION, C_EXPORT_XMLFILENAME, C_EXPORTONLYFILES, C_EXPORTONLYUSERS, C_EXPORTPOINT, C_EXPORTPOINT_PATH, C_EXPORTUSERSFILES, C_FCONTENT, C_FELEMENT, C_FILE, C_FILECONTENT, C_FILES_IMPORTED, C_FLAG_DISABLED, C_FLAG_ENABLED, C_FLAG_GROUP_PROJECTCOWORKER, C_FLAG_GROUP_PROJECTMANAGER, C_FLAG_GROUP_ROLE, C_FOLDER, C_FOLDER_SEPARATOR, C_GROUP, C_GROUP_ADMIN, C_GROUP_GUEST, C_GROUP_PROJECTLEADER, C_GROUP_USERS, C_LINKCHECKTABLE_DATE, C_MAX_LENGTH_RESOURCE_NAME, C_MODULE_PROPERTY_ADDITIONAL_RESOURCES, C_MODULE_PROPERTY_ADDITIONAL_RESOURCES_SEPARATOR, C_MODUS_AUTO, C_MODUS_EXPORT, C_MODUS_EXTERN, C_MODUS_OFFLINE, C_MODUS_ONLINE, C_MOUNTPOINT_FILESYSTEM, C_MOUNTPOINT_MYSQL, C_NEVER, C_NO_FILES_IMPORTED, C_ORDER_AGENTUSER, C_ORDER_ENDTIME, C_ORDER_ID, C_ORDER_INITIATORUSER, C_ORDER_NAME, C_ORDER_ORIGINALUSER, C_ORDER_PERCENTAGE, C_ORDER_PRIORITY, C_ORDER_ROLE, C_ORDER_STARTTIME, C_ORDER_STATE, C_ORDER_TASKTYPE, C_ORDER_TIMEOUT, C_ORDER_WAKEUPTIME, C_PASSWORD_MINIMUMSIZE, C_PROJECT_ONLINE, C_PROJECT_ONLINE_ID, C_PROJECT_STATE_ARCHIVE, C_PROJECT_STATE_INVISIBLE, C_PROJECT_STATE_LOCKED, C_PROJECT_STATE_UNLOCKED, C_PROJECT_TYPE_INVISIBLE, C_PROJECT_TYPE_NORMAL, C_PROJECT_TYPE_TEMPORARY, C_PROPERTY_ACTIV, C_PROPERTY_CHANNELID, C_PROPERTY_CONTENT_ENCODING, C_PROPERTY_DEFAULT_FILE, C_PROPERTY_DESCRIPTION, C_PROPERTY_EXPORT, C_PROPERTY_EXPORTNAME, C_PROPERTY_KEYWORDS, C_PROPERTY_NAVPOS, C_PROPERTY_NAVTEXT, C_PROPERTY_RELATIVEROOT, C_PROPERTY_TEMPLATETYPE, C_PROPERTY_TITLE, C_PROPERTY_VISIBLE, C_PUBLISH_METHOD_LINK, C_REGISTRY_DESTINATION, C_REGISTRY_HISTORY, C_REGISTRY_KNOWNLAUNCHERS, C_REGISTRY_LAUNCHER, C_REGISTRY_SOURCE, C_REQUEST_CONSOLE, C_REQUEST_HTTP, C_RESPONSE_CONSOLE, C_RESPONSE_HTTP, C_ROOT, C_ROOT_TEMPLATE_NAME, C_ROOTNAME_COS, C_ROOTNAME_VFS, C_SESSION_ADMIN_POS, C_SESSION_BROADCASTMESSAGE, C_SESSION_CONTENT_ENCODING, C_SESSION_CURRENTGROUP, C_SESSION_DATA, C_SESSION_IS_DIRTY, C_SESSION_MESSAGEPENDING, C_SESSION_MODULE_VECTOR, C_SESSION_PROJECT, C_SESSION_THREAD_ERROR, C_SESSION_USERNAME, C_SORT_ASC, C_SORT_DESC, C_START_ACCESSFLAGS, C_START_DEFAULTGROUP, C_START_LANGUAGE, C_START_LOCKDIALOG, C_START_PROJECT, C_START_VIEW, C_STATE_CHANGED, C_STATE_DELETED, C_STATE_NEW, C_STATE_UNCHANGED, C_STATICEXPORT_PATH, C_STATICEXPORT_START, C_SYNCHRONISATION_PATH, C_SYNCHRONISATION_PROJECT, C_SYNCHRONISATION_RESOURCE, C_SYNCHRONISATION_RESOURCETAG, C_SYSTEMPROPERTY_CRONTABLE, C_SYSTEMPROPERTY_EXPORTPATH, C_SYSTEMPROPERTY_EXTENSIONS, C_SYSTEMPROPERTY_LINKCHECKTABLE, C_SYSTEMPROPERTY_MIMETYPES, C_SYSTEMPROPERTY_MOUNTPOINT, C_SYSTEMPROPERTY_RESOURCE_TYPE, C_TABLE_CHANNELID, C_TASK_FILTER, C_TASK_MESSAGES, C_TASK_MESSAGES_ACCEPTED, C_TASK_MESSAGES_COMPLETED, C_TASK_MESSAGES_FORWARDED, C_TASK_MESSAGES_MEMBERS, C_TASK_ORDER_BY_DATE, C_TASK_ORDER_BY_NAME, C_TASK_PRIORITY_HIGH, C_TASK_PRIORITY_LOW, C_TASK_PRIORITY_NORMAL, C_TASK_STATE_ENDED, C_TASK_STATE_HALTED, C_TASK_STATE_NOTENDED, C_TASK_STATE_PREPARE, C_TASK_STATE_START, C_TASK_STATE_STARTED, C_TASK_VIEW_ALL, C_TASKLOG_SYSTEM, C_TASKLOG_USER, C_TASKORDER_NONE, C_TASKORDER_STARTDATE, C_TASKORDER_TIMEOUT, C_TASKS_ACTIVE, C_TASKS_ALL, C_TASKS_DONE, C_TASKS_NEW, C_TASKS_OPEN, C_TASKSORDER_TASKNAME, C_TEMP_PREFIX, C_TFACCESS, C_TFGROUP, C_TFILEOBJ, C_TFILES, C_TFNAME, C_TFPROPERTYINFO, C_TFPROPERTYNAME, C_TFPROPERTYTYPE, C_TFPROPERTYVALUE, C_TFTYPE, C_TFTYPENAME, C_TFUSER, C_TGDESC, C_TGFLAG, C_TGNAME, C_TGPARENTGROUP, C_TGROUPOBJ, C_TGROUPS, C_TGROUPUSERS, C_TGUSER, C_TUADDINFO, C_TUDESC, C_TUDGROUP, C_TUDISABLED, C_TUEMAIL, C_TUFIRSTNAME, C_TUFLAG, C_TUGROUP, C_TUINFOKEY, C_TUINFOVALUE, C_TULOGIN, C_TUNAME, C_TUPASSWD, C_TUSERGROUPS, C_TUSEROBJ, C_TUSERS, C_TYPE_BODY_NAME, C_TYPE_COMPATIBLEPLAIN_NAME, C_TYPE_FOLDER, C_TYPE_FOLDER_NAME, C_TYPE_IMAGE_NAME, C_TYPE_LAST_INDEX, C_TYPE_PAGE_NAME, C_TYPE_PLAIN_NAME, C_UNKNOWN_ID, C_UNKNOWN_INT, C_UNKNOWN_LAUNCHER, C_UNKNOWN_LAUNCHER_ID, C_UNKNOWN_LONG, C_URL_PREFIX_EXPORT, C_URL_PREFIX_HTTP, C_URL_PREFIX_HTTPS, C_URL_PREFIX_SERVERNAME, C_USER, C_USER_ADMIN, C_USER_GUEST, C_USER_TYPE_SYSTEMANDWEBUSER, C_USER_TYPE_SYSTEMUSER, C_USER_TYPE_WEBUSER, C_WEB_APP_REPLACE_KEY, C_WEEKS_HISTORY, C_WHATEVER, C_XML_BODY_ELEMENT
 
Constructor Summary
CmsObject()
          The default constructor.
 
Method Summary
 void acceptTask(int taskId)
          Accept a task from the Cms.
 boolean accessCreate(java.lang.String resource)
          Checks, if the user may create this resource.
 boolean accessLock(java.lang.String resource)
          Checks, if the user may lock this resource.
 boolean accessProject(int projectId)
          Checks if the user can access the project.
 boolean accessRead(java.lang.String resource)
          Checks, if the user may read this resource.
 boolean accessReadVisible(CmsResource resource)
          Checks, if the user may read this resource and if it is visible to him.
 boolean accessWrite(java.lang.String resource)
          Checks, if the user may write this resource.
 void addFileExtension(java.lang.String extension, java.lang.String resTypeName)
          Adds a file extension to the list of known file extensions.
 CmsGroup addGroup(java.lang.String name, java.lang.String description, int flags, java.lang.String parent)
          Adds a new group to the Cms.
 CmsUser addImportUser(java.lang.String name, java.lang.String password, java.lang.String recoveryPassword, java.lang.String description, java.lang.String firstname, java.lang.String lastname, java.lang.String email, int flags, java.util.Hashtable additionalInfos, java.lang.String defaultGroup, java.lang.String address, java.lang.String section, int type)
          Adds a user to the Cms by import.
 CmsUser addUser(java.lang.String name, java.lang.String password, java.lang.String group, java.lang.String description, java.util.Hashtable additionalInfos, int flags)
          Adds a user to the Cms.
 void addUserToGroup(java.lang.String username, java.lang.String groupname)
          Adds a user to a group.
 CmsUser addWebUser(java.lang.String name, java.lang.String password, java.lang.String group, java.lang.String description, java.util.Hashtable additionalInfos, int flags)
          Adds a web user to the Cms.
 CmsUser addWebUser(java.lang.String name, java.lang.String password, java.lang.String group, java.lang.String additionalGroup, java.lang.String description, java.util.Hashtable additionalInfos, int flags)
          Adds a web user to the Cms.
 CmsUser anonymousUser()
          Returns the anonymous user object.
 void backupProject(int projectId, int versionId, long publishDate)
          Creates a backup of the published project
 void changeLockedInProject(int projectId, java.lang.String resourcename)
          Changes the project-id of a resource to the new project for publishing the resource directly
 void changeUserType(int userId, int userType)
          Changes the type of the user
 void changeUserType(java.lang.String username, int userType)
          Changes the type of the user to webusertype
 void chgrp(java.lang.String filename, java.lang.String newGroup)
          Changes the group of a resource.
 void chgrp(java.lang.String filename, java.lang.String newGroup, boolean chRekursive)
          Changes the group of a resource.
 void chmod(java.lang.String filename, int flags)
          Changes the flags of a resource.
 void chmod(java.lang.String filename, int flags, boolean chRekursive)
          Changes the flags of a resource.
 void chown(java.lang.String filename, java.lang.String newOwner)
          Changes the owner of a resource.
 void chown(java.lang.String filename, java.lang.String newOwner, boolean chRekursive)
          Changes the owner of a resource.
 void chtype(java.lang.String filename, java.lang.String newType)
          Changes the resourcetype of a resource.
 void clearcache()
          Clears all internal DB-Caches.
 void clearElementCache()
          Clears the element cache.
 void copyFile(java.lang.String source, java.lang.String destination)
          Deprecated. Use copyResource instead.
 void copyFolder(java.lang.String source, java.lang.String destination)
          Deprecated. Use copyResource instead.
 void copyResource(java.lang.String source, java.lang.String destination)
          Copies a file.
 void copyResource(java.lang.String source, java.lang.String destination, boolean keepFlags)
          Copies a file.
 void copyResourceToProject(java.lang.String resource)
          Copies a resource from the online project to a new, specified project.
 int countLockedResources(int id)
          Counts the locked resources in a project.
 CmsFolder createChannel(java.lang.String parentChannel, java.lang.String newChannelName)
          Creates a new channel.
 CmsFile createFile(java.lang.String folder, java.lang.String filename, byte[] contents, java.lang.String type)
          Deprecated. Use createResource instead.
 CmsFile createFile(java.lang.String folder, java.lang.String filename, byte[] contents, java.lang.String type, java.util.Hashtable properties)
          Deprecated. Use createResource instead.
 CmsFolder createFolder(java.lang.String folder, java.lang.String newFolderName)
          Deprecated. Use createResource instead.
 void createLinkEntrys(int pageId, java.util.Vector linkTargets)
          creates a link entry for each of the link targets in the linktable.
 void createOnlineLinkEntrys(int pageId, java.util.Vector linkTarget)
          creates a link entry for each of the link targets in the online linktable.
 CmsTask createProject(java.lang.String projectname, int projectType, java.lang.String roleName, long timeout, int priority)
          Creates a new project for task handling.
 CmsProject createProject(java.lang.String name, java.lang.String description, java.lang.String groupname, java.lang.String managergroupname)
          Creates a new project.
 CmsProject createProject(java.lang.String name, java.lang.String description, java.lang.String groupname, java.lang.String managergroupname, int projecttype)
          Creates a new project.
 CmsPropertydefinition createPropertydefinition(java.lang.String name, java.lang.String resourcetype)
          Creates the property-definition for a resource type.
 CmsResource createResource(java.lang.String newResourceName, java.lang.String type, java.util.Map properties, byte[] contents, java.lang.Object parameter)
           
 CmsResource createResource(java.lang.String folder, java.lang.String name, java.lang.String type)
           
 CmsResource createResource(java.lang.String folder, java.lang.String name, java.lang.String type, java.util.Map properties)
           
 CmsResource createResource(java.lang.String folder, java.lang.String name, java.lang.String type, java.util.Map properties, byte[] contents)
           
 CmsTask createTask(int projectid, java.lang.String agentName, java.lang.String roleName, java.lang.String taskname, java.lang.String taskcomment, int tasktype, long timeout, int priority)
          Creates a new task.
 CmsTask createTask(java.lang.String agentName, java.lang.String roleName, java.lang.String taskname, java.lang.String taskcomment, long timeout, int priority)
          Creates a new task.
 CmsProject createTempfileProject()
          Creates a new project for the temporary files.
 void deleteAllProperties(java.lang.String resourcename)
          Deletes all properties for a file or folder.
 int deleteBackups(int weeks)
          Deletes the versions from the backup tables that are older then the given weeks
 void deleteEmptyFolder(java.lang.String foldername)
          Deletes a folder.
 void deleteExportLink(CmsExportLink link)
          Deletes an exportlink in the database.
 void deleteExportLink(java.lang.String link)
          Deletes an exportlink in the database.
 void deleteFile(java.lang.String filename)
          Deprecated. Use deleteResource instead.
 void deleteFolder(java.lang.String foldername)
          Deprecated. Use deleteResource instead.
 void deleteGroup(java.lang.String delgroup)
          Deletes a group.
 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(int id)
          Deletes a project.
 void deleteProperty(java.lang.String resourcename, java.lang.String property)
          Deletes a property for a file or folder.
 void deletePropertydefinition(java.lang.String name, java.lang.String resourcetype)
          Deletes the property-definition for a resource type.
 void deleteResource(java.lang.String filename)
          Deletes a resource.
 void deleteUser(int userId)
          Deletes a user from the Cms.
 void deleteUser(java.lang.String username)
          Deletes a user from the Cms.
 void deleteWebUser(int userId)
          Deletes a web user from the Cms.
 void destroy()
          Destroys the resource borker and required modules and connections.
 java.lang.String digest(java.lang.String value)
          Method to encrypt the passwords.
protected  void doChangeLockedInProject(int projectId, java.lang.String resourcename)
          Changes the project-id of a resource to the new project for publishing the resource directly
protected  void doChgrp(java.lang.String filename, java.lang.String newGroup)
          Changes the group of a resource.
protected  void doChmod(java.lang.String filename, int flags)
          Changes the flags of a resource.
protected  void doChown(java.lang.String filename, java.lang.String newOwner)
          Changes the owner of a resource.
protected  void doChtype(java.lang.String filename, java.lang.String newType)
          Changes the resourcetype of a resource.
protected  void doCopyFile(java.lang.String source, java.lang.String destination)
          Copies a file.
protected  void doCopyFolder(java.lang.String source, java.lang.String destination)
          Copies a folder.
protected  void doCopyResourceToProject(java.lang.String resource)
          Copies a resource from the online project to a new, specified project.
protected  CmsFile doCreateFile(java.lang.String newFileName, byte[] contents, java.lang.String type)
          Creates a new file with the given content and resourcetype.
protected  CmsFile doCreateFile(java.lang.String newFileName, byte[] contents, java.lang.String type, java.util.Map properties)
          Creates a new file with the given content and resourcetype.
protected  CmsFolder doCreateFolder(java.lang.String newFolderName, java.util.Map properties)
          Creates a new folder.
protected  CmsFolder doCreateFolder(java.lang.String folder, java.lang.String newFolderName)
          Creates a new folder.
 int doDecrementLinkCountForResource(java.lang.String theResourceName)
          Decrement the VFS link counter for a resource.
protected  void doDeleteFile(java.lang.String filename)
          Deletes a file.
protected  void doDeleteFolder(java.lang.String foldername)
          Deletes a folder.
protected  CmsResource doImportResource(java.lang.String newResourceName, int resourceType, java.util.Map properties, int launcherType, java.lang.String launcherClassname, java.lang.String ownername, java.lang.String groupname, int accessFlags, long lastmodified, byte[] filecontent)
          Creates a new resource.
 int doIncrementLinkCountForResource(java.lang.String theResourceName)
          Increment the VFS link counter for a resource.
protected  void doLockResource(java.lang.String resource, boolean force)
          Locks a given resource.
protected  void doMoveFile(java.lang.String source, java.lang.String destination)
          Moves a file to the given destination.
protected  void doRenameFile(java.lang.String oldname, java.lang.String newname)
          Renames the resource to the new name.
protected  void doRestoreResource(int versionId, java.lang.String filename)
          Restores a file in the current project with a version in the backup
protected  void doTouch(java.lang.String resourceName, long timestamp)
          Access the resource broker underneath to change the timestamp of a resource.
protected  void doUndeleteFile(java.lang.String filename)
          Undeletes a file.
protected  void doUndeleteFolder(java.lang.String foldername)
          Undeletes a folder.
protected  void doUndoChanges(java.lang.String resource)
          Undo changes in a file.
protected  void doUnlockResource(java.lang.String resource)
          Unlocks a resource.
protected  void doWriteResource(java.lang.String resourcename, java.util.Map properties, java.lang.String username, java.lang.String groupname, int accessFlags, int resourceType, byte[] filecontent)
          Writes a resource and its properties to the Cms.
 void endTask(int taskid)
          Ends a task of the Cms.
 void exportModuledata(java.lang.String exportFile, java.lang.String[] exportChannels, java.lang.String[] exportModules, com.opencms.report.I_CmsReport report)
          Exports channels and moduledata to zip.
 CmsFile exportResource(CmsFile file)
          Exports a resource.
 void exportResources(java.lang.String exportFile, java.lang.String[] exportPaths)
          Exports cms-resources to a zip-file.
 void exportResources(java.lang.String exportFile, java.lang.String[] exportPaths, boolean includeSystem, boolean excludeUnchanged)
          Exports cms-resources to a zip-file.
 void exportResources(java.lang.String exportFile, java.lang.String[] exportPaths, boolean includeSystem, boolean excludeUnchanged, boolean exportUserdata)
          Exports cms-resources to a zip-file.
 void exportResources(java.lang.String exportFile, java.lang.String[] exportPaths, boolean includeSystem, boolean excludeUnchanged, boolean exportUserdata, long contentAge, com.opencms.report.I_CmsReport report)
          Exports cms-resources to a zip-file.
 void exportStaticResources(java.util.Vector linksToExport)
          Creates a static export in the filesystem.
 void exportStaticResources(java.util.Vector startpoints, java.util.Vector projectResources, java.util.Vector allExportedLinks, CmsPublishedResources changedResources, com.opencms.report.I_CmsReport report)
          Creates a static export in the filesystem
 java.util.ArrayList fetchVfsLinksForResource(java.lang.String theResourceName)
          Fetches the resource names of all VFS links pointing to a given resource as an ArrayList.
private  void fireEvent(int type, java.lang.Object data)
          Fires a CmsEvent
 void forwardTask(int taskid, java.lang.String newRoleName, java.lang.String newUserName)
          Forwards a task to a new user.
 java.util.Vector getAllAccessibleProjects()
          Returns all projects, which the current user can access.
 java.util.Vector getAllBackupProjects()
          Returns a Vector with all projects from history
 java.util.Vector getAllExportLinks()
          Returns a Vector with all export links
 java.util.Vector getAllManageableProjects()
          Returns all projects which are owned by the current user or which are manageable for the group of the user.
 java.util.Hashtable getAllResourceTypes()
          Returns a Hashtable with all I_CmsResourceTypes.
 int getBackupVersionId()
          Get the next version id for the published backup resources
 void getBrokenLinks(int projectId, com.opencms.report.I_CmsReport report, java.util.Vector changed, java.util.Vector deleted, java.util.Vector newRes)
          checks a project for broken links that would appear if the project is published.
 java.util.Hashtable getCacheInfo()
          Gets information about the cache size.
 java.util.Vector getChild(java.lang.String groupname)
          Returns all child groups of a group.
 java.util.Vector getChilds(java.lang.String groupname)
          Returns all child groups of a group.
 CmsObject getCmsObjectForStaticExport(com.opencms.core.CmsExportRequest dReq, com.opencms.core.CmsExportResponse dRes)
          Creates a special CmsObject for the static export.
 source.org.apache.java.util.Configurations getConfigurations()
          Gets the configurations of the properties-file.
 java.util.Vector getDependingExportLinks(java.util.Vector res)
          Reads all export links that depend on the resource.
 java.util.Vector getDirectGroupsOfUser(java.lang.String username)
          Gets all groups to which a given user directly belongs.
 java.util.Vector getFilesInFolder(java.lang.String foldername)
          Returns a Vector with all files of a given folder.
 java.util.Vector getFilesInFolder(java.lang.String foldername, boolean includeDeleted)
          Returns a Vector with all files of a given folder.
 java.util.Vector getFilesWithProperty(java.lang.String propertyDefinition, java.lang.String propertyValue)
          Returns a Vector with all resource-names of the resources that have set the given property to the given value.
 long getFileSystemChanges()
          This method can be called, to determine if the file-system was changed in the past.
 long getFileSystemFolderChanges()
          This method can be called, to determine if the file-system was changed in the past.
 java.util.Vector getFolderTree()
          Returns a Vector with the complete folder-tree for this project.
Subfolders can be read from an offline project and the online project.
 java.util.Vector getGroups()
          Returns all groups in the Cms.
 java.util.Vector getGroupsOfUser(java.lang.String username)
          Gets all groups of a user.
 com.opencms.launcher.CmsLauncherManager getLauncherManager()
          Get the launcher manager used with this instance of CmsObject.
 int getLimitedWorkplacePort()
          This is the port the workplace access is limited to.
 java.lang.String getLinkSubstitution(java.lang.String link)
          Replaces the link according to the rules and registers it to the requestcontex if we are in export modus.
 java.util.Vector getLoggedInUsers()
          Returns a list of all currently logged in users.
 int getMode()
          Returns the mode this cmsObject is runnig in.
 java.util.Vector getOnlineBrokenLinks()
          serches for broken links in the online project.
 com.opencms.template.cache.CmsElementCache getOnlineElementCache()
          Gets the ElementCache used for the online project.
 com.opencms.linkmanagement.CmsPageLinks getPageLinks(java.lang.String page)
          extracts the links of the page and returns them in a CmsPageLinks object.
 CmsGroup getParent(java.lang.String groupname)
          Returns the parent group of a group.
 java.lang.String getReadingpermittedGroup(int projectId, java.lang.String resource)
          Checks which Group can read the resource and all the parent folders.
 I_CmsRegistry getRegistry()
          Gets the Registry.
 CmsRequestContext getRequestContext()
          Returns the current request-context.
 java.util.Vector getResourcesInFolder(java.lang.String folder)
          Returns a Vector with the subresources for a folder.
 java.util.Vector getResourcesWithProperty(java.lang.String propertyDefinition)
          Returns a Vector with all resources of the given type that have set the given property.
 java.util.Vector getResourcesWithProperty(java.lang.String propertyDefinition, java.lang.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(int resourceType)
          Returns a I_CmsResourceType.
 I_CmsResourceType getResourceType(java.lang.String resourceType)
          Returns a I_CmsResourceType.
 java.lang.String getSiteName()
          Returns the name of the current site, e.g.
 java.lang.String getSiteRoot(java.lang.String resourcename)
          Returns the name of the current site root, e.g.
static com.opencms.core.CmsStaticExportProperties getStaticExportProperties()
          Returns the properties for the static export.
 java.util.Vector getSubFolders(java.lang.String foldername)
          Returns a Vector with all subfolders of a given folder.
 java.util.Vector getSubFolders(java.lang.String foldername, boolean includeDeleted)
          Returns a Vector with all subfolders of a given folder.
 java.lang.String getTaskPar(int taskid, java.lang.String parname)
          Get a parameter value for a task.
 int getTaskType(java.lang.String taskname)
          Get the template task id fo a given taskname.
 java.util.Vector getUsers()
          Returns all users in the Cms.
 java.util.Vector getUsers(int type)
          Returns all users of the given type in the Cms.
 java.util.Vector getUsers(int type, java.lang.String namefilter)
          Returns all users from a given type that start with a specified string

 java.util.Vector getUsersByLastname(java.lang.String Lastname, int UserType, int UserStatus, int wasLoggedIn, int nMax)
          Gets all users with a certain Lastname.
 java.util.Vector<