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

Quick Search    Search Deep

Uses of Class
com.opencms.file.CmsObject

Uses of CmsObject in com.opencms.file
 

Fields in com.opencms.file declared as CmsObject
private  CmsObject CmsSynchronize.m_cms
          the CmsObject
private  CmsObject CmsStaticExport.m_cms
          The cms-object to do the operations.
private  CmsObject CmsRegistry.m_cms
          The cms-object to get access to the system with the context of the current user.
private  CmsObject CmsImportFolder.m_cms
          The cms-object to do the operations.
protected  CmsObject CmsImport.m_cms
          The cms contect to do the operations on the VFS/COS with
protected  CmsObject CmsExport.m_cms
          The CmsObject to do the operations
 

Methods in com.opencms.file that return CmsObject
 CmsObject CmsObject.getCmsObjectForStaticExport(com.opencms.core.CmsExportRequest dReq, com.opencms.core.CmsExportResponse dRes)
          Creates a special CmsObject for the static export.
 

Methods in com.opencms.file with parameters of type CmsObject
 void I_CmsResourceType.chgrp(CmsObject cms, java.lang.String filename, java.lang.String newGroup, boolean chRekursive)
          Changes the group of a resource.
 void I_CmsResourceType.chmod(CmsObject cms, java.lang.String filename, int flags, boolean chRekursive)
          Changes the flags of a resource.
 void I_CmsResourceType.chown(CmsObject cms, java.lang.String filename, java.lang.String newOwner, boolean chRekursive)
          Changes the owner of a resource.
 void I_CmsResourceType.touch(CmsObject cms, java.lang.String resourceName, long timestamp, boolean touchRecursive)
          Change the timestamp of a resource.
 void I_CmsResourceType.chtype(CmsObject cms, java.lang.String filename, java.lang.String newType)
          Changes the resourcetype of a resource.
 void I_CmsResourceType.copyResource(CmsObject cms, java.lang.String source, java.lang.String destination, boolean keepFlags)
          Copies a Resource.
 void I_CmsResourceType.copyResourceToProject(CmsObject cms, java.lang.String resourceName)
          Copies the resourcename to the current offline project
 CmsResource I_CmsResourceType.createResource(CmsObject cms, java.lang.String newResourceName, java.util.Map properties, byte[] contents, java.lang.Object parameter)
          Creates a new resource.
 void I_CmsResourceType.deleteResource(CmsObject cms, java.lang.String filename)
          Deletes a resource.
 void I_CmsResourceType.undeleteResource(CmsObject cms, java.lang.String filename)
          Deletes a resource.
 CmsFile I_CmsResourceType.exportResource(CmsObject cms, CmsFile file)
          Does the Linkmanagement when a resource will be exported.
 CmsResource I_CmsResourceType.importResource(CmsObject cms, java.lang.String source, java.lang.String destination, java.lang.String type, java.lang.String user, java.lang.String group, java.lang.String access, long lastmodified, java.util.Map properties, java.lang.String launcherStartClass, byte[] content, java.lang.String importPath)
          Does the Linkmanagement when a resource is imported.
 void I_CmsResourceType.lockResource(CmsObject cms, java.lang.String resource, boolean force)
          Locks a given resource.
 void I_CmsResourceType.moveResource(CmsObject cms, java.lang.String source, java.lang.String destination)
          Moves a file to the given destination.
 void I_CmsResourceType.renameResource(CmsObject cms, java.lang.String oldname, java.lang.String newname)
          Renames the file to the new name.
 void I_CmsResourceType.restoreResource(CmsObject cms, int versionId, java.lang.String filename)
          Restores a file in the current project with a version in the backup
 void I_CmsResourceType.undoChanges(CmsObject cms, java.lang.String filename)
          Undo all changes in the resource, restore the online file.
 void I_CmsResourceType.unlockResource(CmsObject cms, java.lang.String resource)
          Unlocks a resource.
 void I_CmsResourceType.changeLockedInProject(CmsObject cms, int newProjectId, java.lang.String resourcename)
          Changes the project-id of the resource to the new project for publishing the resource directly
 CmsUser I_CmsResourceBroker.addUser(CmsObject cms, CmsUser currentUser, CmsProject currentProject, 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.
 CmsUser I_CmsResourceBroker.addWebUser(CmsObject cms, CmsUser currentUser, CmsProject currentProject, 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 I_CmsResourceBroker.addWebUser(CmsObject cms, CmsUser currentUser, CmsProject currentProject, 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.
 CmsProject I_CmsResourceBroker.createTempfileProject(CmsObject cms, CmsUser currentUser, CmsProject currentProject)
          Creates a project for the temporary files.
 void I_CmsResourceBroker.exportResources(CmsUser currentUser, CmsProject currentProject, java.lang.String exportFile, java.lang.String[] exportPaths, CmsObject cms)
          Exports cms-resources to zip.
 void I_CmsResourceBroker.exportResources(CmsUser currentUser, CmsProject currentProject, java.lang.String exportFile, java.lang.String[] exportPaths, CmsObject cms, boolean includeSystem, boolean excludeUnchanged)
          Exports cms-resources to zip.
 void I_CmsResourceBroker.exportResources(CmsUser currentUser, CmsProject currentProject, java.lang.String exportFile, java.lang.String[] exportPaths, CmsObject cms, boolean includeSystem, boolean excludeUnchanged, boolean exportUserdata, long contentAge, com.opencms.report.I_CmsReport report)
          Exports cms-resources to zip.
 void I_CmsResourceBroker.exportModuledata(CmsUser currentUser, CmsProject currentProject, java.lang.String exportFile, java.lang.String[] exportChannels, java.lang.String[] exportModules, CmsObject cms, com.opencms.report.I_CmsReport report)
          Exports channels and moduledata to zip.
 void I_CmsResourceBroker.exportStaticResources(CmsUser currentUser, CmsProject currentProject, CmsObject cms, java.util.Vector startpoints, java.util.Vector projectResources, java.util.Vector allExportedLinks, CmsPublishedResources changedResources, com.opencms.report.I_CmsReport report)
          Creates a static export of a Cmsresource in the filesystem
 void I_CmsResourceBroker.exportStaticResources(CmsUser currentUser, CmsProject currentProject, CmsObject cms, java.util.Vector linksToExport)
          Creates a static export in the filesystem.
 I_CmsRegistry I_CmsResourceBroker.getRegistry(CmsUser currentUser, CmsProject currentProject, CmsObject cms)
          Gets the Registry.
 void I_CmsResourceBroker.importFolder(CmsUser currentUser, CmsProject currentProject, java.lang.String importFile, java.lang.String importPath, CmsObject cms)
          Imports a import-resource (folder or zipfile) to the cms.
 void I_CmsResourceBroker.importResources(CmsUser currentUser, CmsProject currentProject, java.lang.String importFile, java.lang.String importPath, CmsObject cms, com.opencms.report.I_CmsReport report)
          Imports a import-resource (folder or zipfile) to the cms.
 CmsPublishedResources I_CmsResourceBroker.publishProject(CmsObject cms, CmsUser currentUser, CmsProject currentProject, int id, com.opencms.report.I_CmsReport report)
          Publishes a project.
 void I_CmsResourceBroker.recoverPassword(CmsObject cms, CmsUser currentUser, CmsProject currentProject, java.lang.String username, java.lang.String recoveryPassword, java.lang.String newPassword)
          Sets a new password only if the user knows his recovery-password.
 void I_CmsResourceBroker.setPassword(CmsObject cms, CmsUser currentUser, CmsProject currentProject, java.lang.String username, java.lang.String newPassword)
          Sets the password for a user.
 void I_CmsResourceBroker.setPassword(CmsObject cms, CmsUser currentUser, CmsProject currentProject, java.lang.String username, java.lang.String oldPassword, java.lang.String newPassword)
          Sets the password for a user.
 void I_CmsResourceBroker.setRecoveryPassword(CmsObject cms, CmsUser currentUser, CmsProject currentProject, java.lang.String username, java.lang.String password, java.lang.String newPassword)
          Sets the recovery password for a user.
 boolean I_CmsResourceBroker.isHistoryEnabled(CmsObject cms)
          Check if the history is enabled
 int I_CmsResourceBroker.deleteBackups(CmsObject cms, CmsUser currentUser, CmsProject currentProject, int weeks)
          Deletes the versions from the backup tables that are older then the given weeks
 java.util.ArrayList I_CmsResourceBroker.joinLinksToTargets(CmsObject cms, CmsUser theUser, CmsProject theProject, com.opencms.report.I_CmsReport theReport)
          Rebuilds the internal datastructure to join links with their targets.
 I_CmsRegistry I_CmsRegistry.clone(CmsObject cms)
          This method clones the registry.
static java.lang.String CmsStaticExport.handleDynamicRules(CmsObject cms, java.lang.String link, int modus, java.util.Vector paramterOnly)
          this method handles the dynamic rules created by opencms in using the properties of resources.
private static java.lang.String CmsStaticExport.substituteLinkParameter(CmsObject cms, java.lang.String link)
          If a link has htmlparameter this methode removes them and adds an index to the link.
 CmsResource CmsResourceTypeXMLTemplate.createResource(CmsObject cms, java.lang.String newResourceName, java.util.Hashtable properties, byte[] contents)
           
 void CmsResourceTypePlain.chgrp(CmsObject cms, java.lang.String filename, java.lang.String newGroup, boolean chRekursive)
          Changes the group of a resource.
 void CmsResourceTypePlain.chmod(CmsObject cms, java.lang.String filename, int flags, boolean chRekursive)
          Changes the flags of a resource.
 void CmsResourceTypePlain.chown(CmsObject cms, java.lang.String filename, java.lang.String newOwner, boolean chRekursive)
          Changes the owner of a resource.
 void CmsResourceTypePlain.touch(CmsObject cms, java.lang.String resourceName, long timestamp, boolean touchRecursive)
          Change the timestamp of a resource.
 void CmsResourceTypePlain.chtype(CmsObject cms, java.lang.String filename, java.lang.String newType)
          Changes the resourcetype of a resource.
 void CmsResourceTypePlain.copyResource(CmsObject cms, java.lang.String source, java.lang.String destination, boolean keepFlags)
          Copies a Resource.
 void CmsResourceTypePlain.copyResourceToProject(CmsObject cms, java.lang.String resourceName)
          Copies the resourcename to the current offline project
 CmsResource CmsResourceTypePlain.createResource(CmsObject cms, java.lang.String newFileName, java.util.Map properties, byte[] contents, java.lang.Object parameter)
          Creates a new resource
 void CmsResourceTypePlain.deleteResource(CmsObject cms, java.lang.String filename)
          Deletes a resource.
 void CmsResourceTypePlain.undeleteResource(CmsObject cms, java.lang.String filename)
          Deletes a resource.
 CmsFile CmsResourceTypePlain.exportResource(CmsObject cms, CmsFile file)
          Does the Linkmanagement when a resource will be exported.
 CmsResource CmsResourceTypePlain.importResource(CmsObject cms, java.lang.String source, java.lang.String destination, java.lang.String type, java.lang.String user, java.lang.String group, java.lang.String access, long lastmodified, java.util.Map properties, java.lang.String launcherStartClass, byte[] content, java.lang.String importPath)
          Imports a resource.
 void CmsResourceTypePlain.lockResource(CmsObject cms, java.lang.String resource, boolean force)
          Locks a given resource.
 void CmsResourceTypePlain.moveResource(CmsObject cms, java.lang.String source, java.lang.String destination)
          Moves a resource to the given destination.
 void CmsResourceTypePlain.renameResource(CmsObject cms, java.lang.String oldname, java.lang.String newname)
          Renames the file to the new name.
 void CmsResourceTypePlain.restoreResource(CmsObject cms, int versionId, java.lang.String filename)
          Restores a file in the current project with a version in the backup
 void CmsResourceTypePlain.undoChanges(CmsObject cms, java.lang.String resource)
          Undo changes in a resource.
 void CmsResourceTypePlain.unlockResource(CmsObject cms, java.lang.String resource)
          Unlocks a resource.
protected  void CmsResourceTypePlain.setDefaultFlags(CmsObject cms, java.lang.String filename)
          Set the access flags of the copied resource to the default values.
 void CmsResourceTypePlain.changeLockedInProject(CmsObject cms, int newProjectId, java.lang.String resourcename)
          Changes the project-id of the resource to the new project for publishing the resource directly
 void CmsResourceTypePage.chgrp(CmsObject cms, java.lang.String filename, java.lang.String newGroup, boolean chRekursive)
          Changes the group of a resource.
 void CmsResourceTypePage.chmod(CmsObject cms, java.lang.String filename, int flags, boolean chRekursive)
          Changes the flags of a resource.
 void CmsResourceTypePage.chown(CmsObject cms, java.lang.String filename, java.lang.String newOwner, boolean chRekursive)
          Changes the owner of a resource.
 void CmsResourceTypePage.touch(CmsObject cms, java.lang.String resourceName, long timestamp, boolean touchRecursive)
          Change the timestamp of a page.
 void CmsResourceTypePage.chtype(CmsObject cms, java.lang.String filename, java.lang.String newType)
          Changes the resourcetype of a resource.
 void CmsResourceTypePage.copyResource(CmsObject cms, java.lang.String source, java.lang.String destination, boolean keepFlags)
          Copies a Resource.
 void CmsResourceTypePage.copyResourceToProject(CmsObject cms, java.lang.String resourceName)
          Copies a resource from the online project to a new, specified project.
 CmsResource CmsResourceTypePage.createResource(CmsObject cms, java.lang.String newPageName, java.util.Map properties, byte[] contents, java.lang.Object parameter)
          Creates a new resource
 CmsResource CmsResourceTypePage.createResourceForTemplate(CmsObject cms, java.lang.String newPageName, java.util.Hashtable properties, byte[] contents, java.lang.String masterTemplate)
           
 void CmsResourceTypePage.deleteResource(CmsObject cms, java.lang.String filename)
          Deletes a resource.
 void CmsResourceTypePage.undeleteResource(CmsObject cms, java.lang.String filename)
          Undeletes a resource.
 CmsFile CmsResourceTypePage.exportResource(CmsObject cms, CmsFile file)
          When a resource has to be exported, the IDīs inside the Linkmanagement-Tags have to be changed to the corresponding URLīs
 CmsResource CmsResourceTypePage.importResource(CmsObject cms, java.lang.String source, java.lang.String destination, java.lang.String type, java.lang.String user, java.lang.String group, java.lang.String access, long lastmodified, java.util.Map properties, java.lang.String launcherStartClass, byte[] content, java.lang.String importPath)
          Imports a resource.
 void CmsResourceTypePage.lockResource(CmsObject cms, java.lang.String resource, boolean force)
          Locks a given resource.
 void CmsResourceTypePage.moveResource(CmsObject cms, java.lang.String source, java.lang.String destination)
          Moves a resource to the given destination.
 void CmsResourceTypePage.renameResource(CmsObject cms, java.lang.String oldname, java.lang.String newname)
          Renames the file to the new name.
 void CmsResourceTypePage.restoreResource(CmsObject cms, int versionId, java.lang.String filename)
          Restores a file in the current project with a version in the backup
 void CmsResourceTypePage.undoChanges(CmsObject cms, java.lang.String resource)
          Undo changes in a resource.
 void CmsResourceTypePage.unlockResource(CmsObject cms, java.lang.String resource)
          Unlocks a resource.
private  java.lang.String CmsResourceTypePage.readBodyPath(CmsObject cms, CmsFile file)
          method to check get the real body path from the content file
private  java.lang.String CmsResourceTypePage.checkBodyPath(CmsObject cms, CmsFile file)
          method to check get the real body path from the content file
private  void CmsResourceTypePage.changeContent(CmsObject cms, java.lang.String filename, java.lang.String bodypath)
          This method changes the path of the body file in the xml conten file if file type name is page
private  void CmsResourceTypePage.checkFolders(CmsObject cms, java.lang.String path)
          This method checks if all nescessary folders are exisitng in the content body folder and creates the missing ones.
private  void CmsResourceTypePage.setDefaultFlags(CmsObject cms, java.lang.String filename)
          Set the access flags of the copied resource to the default values.
 void CmsResourceTypePage.changeLockedInProject(CmsObject cms, int newProjectId, java.lang.String resourcename)
          Changes the project-id of the resource to the new project for publishing the resource directly
 CmsResource CmsResourceTypeLink.createResource(CmsObject cms, java.lang.String newResourceName, java.util.Map properties, byte[] contents, java.lang.Object parameter)
          Create a new VFS link.
 void CmsResourceTypeLink.deleteResource(CmsObject cms, java.lang.String theResourceName)
          Delete a VFS link.
 void CmsResourceTypeLink.undeleteResource(CmsObject cms, java.lang.String theResourceName)
          Undelete a VFS link.
 void CmsResourceTypeLink.copyResource(CmsObject cms, java.lang.String theSourceResourceName, java.lang.String theDestinationResourceName, boolean keepFlags)
          Copy a VFS link.
 void CmsResourceTypeLink.moveResource(CmsObject cms, java.lang.String theSourceResourceName, java.lang.String theDestinationResourceName)
          Move a VFS link.
 void CmsResourceTypeLink.renameResource(CmsObject cms, java.lang.String theOldResourceName, java.lang.String theNewResourceName)
          Rename a VFS link.
 void CmsResourceTypeLink.undoChanges(CmsObject cms, java.lang.String theResourceName)
          Undo the changes on a VFS link.
 CmsResource CmsResourceTypeJsp.createResource(CmsObject cms, java.lang.String newResourceName, java.util.Map properties, byte[] contents, java.lang.Object parameter)
          Creates a new JSP resource.
 CmsResource CmsResourceTypeImage.createResource(CmsObject cms, java.lang.String newResourceName, java.util.Map properties, byte[] contents, java.lang.Object parameter)
           
 void CmsResourceTypeFolder.chgrp(CmsObject cms, java.lang.String filename, java.lang.String newGroup, boolean chRekursive)
          Changes the group of a resource.
 void CmsResourceTypeFolder.chmod(CmsObject cms, java.lang.String filename, int flags, boolean chRekursive)
          Changes the flags of a resource.
 void CmsResourceTypeFolder.chown(CmsObject cms, java.lang.String filename, java.lang.String newOwner, boolean chRekursive)
          Changes the owner of a resource.
 void CmsResourceTypeFolder.touch(CmsObject cms, java.lang.String resourceName, long timestamp, boolean touchRecursive)
          Change the timestamp of a folder.
 void CmsResourceTypeFolder.chtype(CmsObject cms, java.lang.String filename, java.lang.String newType)
          Changes the resourcetype of a resource.
 void CmsResourceTypeFolder.copyResource(CmsObject cms, java.lang.String source, java.lang.String destination, boolean keepFlags)
          Copies a Resource.
 void CmsResourceTypeFolder.copyResourceToProject(CmsObject cms, java.lang.String resourceName)
          Copies a resource from the online project to a new, specified project.
 CmsResource CmsResourceTypeFolder.createResource(CmsObject cms, java.lang.String newFolderName, java.util.Map properties, byte[] contents, java.lang.Object parameter)
          Creates a new resource.
 void CmsResourceTypeFolder.deleteResource(CmsObject cms, java.lang.String folder)
          Deletes a resource.
 void CmsResourceTypeFolder.undeleteResource(CmsObject cms, java.lang.String folder)
          Undeletes a resource.
 CmsFile CmsResourceTypeFolder.exportResource(CmsObject cms, CmsFile file)
          Does the Linkmanagement when a resource will be exported.
 CmsResource CmsResourceTypeFolder.importResource(CmsObject cms, java.lang.String source, java.lang.String destination, java.lang.String type, java.lang.String user, java.lang.String group, java.lang.String access, long lastmodified, java.util.Map properties, java.lang.String launcherStartClass, byte[] content, java.lang.String importPath)
          Imports a resource.
 void CmsResourceTypeFolder.lockResource(CmsObject cms, java.lang.String resource, boolean force)
          Locks a given resource.
 void CmsResourceTypeFolder.moveResource(CmsObject cms, java.lang.String source, java.lang.String destination)
          Moves a file to the given destination.
 void CmsResourceTypeFolder.renameResource(CmsObject cms, java.lang.String oldname, java.lang.String newname)
          Renames the file to the new name.
 void CmsResourceTypeFolder.restoreResource(CmsObject cms, int versionId, java.lang.String filename)
          Restores a file in the current project with a version in the backup
 void CmsResourceTypeFolder.undoChanges(CmsObject cms, java.lang.String resource)
          Undo changes in a resource.
 void CmsResourceTypeFolder.unlockResource(CmsObject cms, java.lang.String resource)
          Unlocks a resource.
private  void CmsResourceTypeFolder.setDefaultFlags(CmsObject cms, java.lang.String foldername)
          Set the access flags of the copied Folder to the default values.
private  void CmsResourceTypeFolder.getAllResources(CmsObject cms, java.lang.String rootFolder, java.util.Vector allFiles, java.util.Vector allFolders)
          Gets all resources - files and subfolders - of a given folder.
 void CmsResourceTypeFolder.changeLockedInProject(CmsObject cms, int newProjectId, java.lang.String resourcename)
          Changes the project-id of the resource to the new project for publishing the resource directly
 void CmsResourceTypeCompatiblePlain.copyResource(CmsObject cms, java.lang.String source, java.lang.String destination, boolean keepFlags)
          Copies a Resource.
 CmsResource CmsResourceTypeBinary.createResource(CmsObject cms, java.lang.String folder, java.lang.String name, java.util.Hashtable properties, byte[] contents, java.lang.Object parameter)
           
 I_CmsRegistry CmsRegistry.clone(CmsObject cms)
          Clones the registry.
 java.lang.String CmsLinkCheck.launch(CmsObject cms, java.lang.String parameter)
          this method is called by the scheduler
 void CmsLinkCheck.linksUrlCheck(CmsObject cms, java.lang.String parameter)
          Check all external links
 

Constructors in com.opencms.file with parameters of type CmsObject
CmsSynchronize(CmsObject cms, java.lang.String resourceName)
          This constructs a new CmsImport-object which imports the resources.
CmsStaticExport(CmsObject cms, java.util.Vector linksToExport)
          This constructor is used to export the files on a slave server in clustering mode.
CmsStaticExport(CmsObject cms, java.util.Vector startpoints, boolean doTheExport, java.util.Vector changedLinks, java.util.Vector allExportedLinks, CmsPublishedResources changedResources, com.opencms.report.I_CmsReport report)
          This constructs a new CmsStaticExport-object which generates static html pages in the filesystem.
CmsRegistry(CmsRegistry reg, CmsObject cms)
          Creates a new CmsRegistry for a user.
CmsImportModuledata(CmsObject cms, java.lang.String importFile, java.lang.String importPath, com.opencms.report.I_CmsReport report)
          Constructs a new import object which imports the module date from an OpenCms export zip file or a folder in the "real" file system.
CmsImportFolder(java.lang.String importFile, java.lang.String importPath, CmsObject cms)
          This constructs a new CmsImport-object which imports the resources.
CmsImportFolder(byte[] content, java.lang.String importPath, CmsObject cms, boolean noSubFolder)
          This constructs a new CmsImport-object which imports the resources.
CmsImport(CmsObject cms, java.lang.String importFile, java.lang.String importPath, com.opencms.report.I_CmsReport report)
          Constructs a new import object which imports the resources from an OpenCms export zip file or a folder in the "real" file system.
CmsExportModuledata(CmsObject cms, java.lang.String exportFile, java.lang.String[] resourcesToExport, java.lang.String[] modulesToExport, com.opencms.report.I_CmsReport report)
          This constructs a new CmsExportModuledata-object which exports the channels and modulemasters.
CmsExport(CmsObject cms, java.lang.String exportFile, java.lang.String[] resourcesToExport, boolean excludeSystem, boolean excludeUnchanged)
          Constructs a new export.
CmsExport(CmsObject cms, java.lang.String exportFile, java.lang.String[] resourcesToExport, boolean excludeSystem, boolean excludeUnchanged, org.w3c.dom.Node moduleNode, boolean exportUserdata, long contentAge, com.opencms.report.I_CmsReport report)
          Constructs a new export.