Uses of Class
org.opencms.file.CmsFile
Packages that use CmsFile
Package
Description
Contains the container page editor service classes.
Contains classes used for reading and caching inheritance groups.
Contains server side classes for the XML content editor.
Low-level database connection and access functionality.
Generic (ANSI-SQL) implementation of the OpenCms database connector.
This important package provides the methods to access the OpenCms VFS repository with the permissions
of an authenticated user.
This package contains the classes to deal with the OpenCms VFS history archive.
The implementations of the core resource types for the VFS are located here.
This package contains classes and interfaces used to access OpenCms through a wrapped
CmsObject
.Contains functions to import and export resources from the OpenCms VFS.
The implementation of the OpenCms JSP tag library, with some additional utility classes to
help in JSP scriplet code and navigation building.
Utility classes to be used for JSP pages.
Low-level functions to manage the loading of resources from the OpenCms VFS.
The lock state of the resources in the VFS is handled with these classes.
Classes to represent and validate the internal and external links/relations of resources in the OpenCms VFS.
Handles indexing different sorts of document and resource type from the OpenCms VFS for the full text search.
Utilities for comparing different versions of resources, used by both the classic workplace and the new Vaadin-based workplace.
Base classes for the editors (WYSIWYG, plain text, XML content) used in the OpenCms Workplace.
Used to control the generation of the HTML for the "direct edit" buttons.
Basic XML functionality and utilities used by OpenCms to maintain XML documents and content.
Contains functions for the ADE main pages, commonly called "Container Pages" in OpenCms.
Contains functions for structured content storage using XML, commonly called "XML content" in OpenCms.
Contains functions for unstructured content storage using XML, commonly called "XML pages" in OpenCms.
-
Uses of CmsFile in org.opencms.ade.containerpage
Methods in org.opencms.ade.containerpage with parameters of type CmsFileModifier and TypeMethodDescriptionCmsElementUtil.getContentByContainer
(CmsFile elementFile, String elementId, CmsContainer container) Returns the HTML content for the given resource and container. -
Uses of CmsFile in org.opencms.ade.containerpage.inherited
Methods in org.opencms.ade.containerpage.inherited with parameters of type CmsFile -
Uses of CmsFile in org.opencms.ade.contenteditor
Methods in org.opencms.ade.contenteditor with parameters of type CmsFileModifier and TypeMethodDescriptionprotected void
CmsContentService.synchronizeLocaleIndependentFields
(CmsFile file, CmsXmlContent content, Collection<String> skipPaths, Collection<CmsEntity> entities, Locale lastEdited) Synchronizes the locale independent fields.Constructors in org.opencms.ade.contenteditor with parameters of type CmsFileModifierConstructorDescriptionCmsContentTypeVisitor
(CmsObject cms, CmsFile file, Locale locale) Constructor. -
Uses of CmsFile in org.opencms.db
Methods in org.opencms.db that return CmsFileModifier and TypeMethodDescriptionI_CmsVfsDriver.createFile
(ResultSet res, CmsUUID projectId) Creates aCmsFile
instance from a JDBC ResultSet.I_CmsVfsDriver.createFile
(ResultSet res, CmsUUID projectId, boolean hasFileContentInResultSet) Creates aCmsFile
instance from a JDBC ResultSet.I_CmsProjectDriver.publishFileContent
(CmsDbContext dbc, CmsProject offlineProject, CmsProject onlineProject, CmsResource offlineFileHeader, Set<CmsUUID> publishedResourceIds, boolean needToUpdateContent, int publishTag) Publishes the content record of a file.CmsDriverManager.readFile
(CmsDbContext dbc, CmsResource resource) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.CmsSecurityManager.readFile
(CmsRequestContext context, CmsResource resource) Reads a file resource (including it's binary content) from the VFS.CmsDriverManager.writeFile
(CmsDbContext dbc, CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.CmsSecurityManager.writeFile
(CmsRequestContext context, CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.Methods in org.opencms.db with parameters of type CmsFileModifier and TypeMethodDescriptionCmsDriverManager.writeFile
(CmsDbContext dbc, CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.CmsSecurityManager.writeFile
(CmsRequestContext context, CmsFile resource) Writes a resource to the OpenCms VFS, including it's content. -
Uses of CmsFile in org.opencms.db.generic
Methods in org.opencms.db.generic that return CmsFileModifier and TypeMethodDescriptionCmsVfsDriver.createFile
(ResultSet res, CmsUUID projectId) CmsVfsDriver.createFile
(ResultSet res, CmsUUID projectId, boolean hasFileContentInResultSet) CmsProjectDriver.publishFileContent
(CmsDbContext dbc, CmsProject offlineProject, CmsProject onlineProject, CmsResource offlineResource, Set<CmsUUID> publishedResourceIds, boolean needToUpdateContent, int publishTag) -
Uses of CmsFile in org.opencms.file
Methods in org.opencms.file that return CmsFileModifier and TypeMethodDescriptionReads a file resource (including it's binary content) from the VFS, using the
filter.CmsResourceFilter.DEFAULT
CmsObject.readFile
(String resourcename, CmsResourceFilter filter) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.CmsObject.readFile
(CmsResource resource) Reads a file resource (including it's binary content) from the VFS, for the given resource (this may also be an historical version of the resource).Writes a resource to the OpenCms VFS, including it's content.Methods in org.opencms.file with parameters of type CmsFileModifier and TypeMethodDescriptionDecodes a file's contents and return the content string and the encoding to use for writing the file back to the VFS.protected void
CmsLinkRewriter.rewriteContent
(CmsFile file, Collection<CmsRelation> relations) Rewrites the links included in the content itself.Writes a resource to the OpenCms VFS, including it's content. -
Uses of CmsFile in org.opencms.file.history
Subclasses of CmsFile in org.opencms.file.historyModifier and TypeClassDescriptionclass
A historical version of a file in the OpenCms VFS resource history. -
Uses of CmsFile in org.opencms.file.types
Methods in org.opencms.file.types that return CmsFileModifier and TypeMethodDescriptionA_CmsResourceType.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) CmsResourceTypeFunctionConfig.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) CmsResourceTypeImage.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) CmsResourceTypeJsp.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) CmsResourceTypePlain.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) CmsResourceTypeXmlContainerPage.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) CmsResourceTypeXmlContent.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) CmsResourceTypeXmlPage.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) I_CmsResourceType.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) Writes a resource, including it's content.Methods in org.opencms.file.types with parameters of type CmsFileModifier and TypeMethodDescriptionCmsResourceTypeJsp.parseLinks
(CmsObject cms, CmsFile file) CmsResourceTypeXmlContainerPage.parseLinks
(CmsObject cms, CmsFile file) CmsResourceTypeXmlContent.parseLinks
(CmsObject cms, CmsFile file) CmsResourceTypeXmlPage.parseLinks
(CmsObject cms, CmsFile file) A_CmsResourceType.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) CmsResourceTypeFunctionConfig.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) CmsResourceTypeImage.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) CmsResourceTypeJsp.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) CmsResourceTypePlain.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) CmsResourceTypeXmlContainerPage.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) CmsResourceTypeXmlContent.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) CmsResourceTypeXmlPage.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) I_CmsResourceType.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) Writes a resource, including it's content. -
Uses of CmsFile in org.opencms.file.wrapper
Methods in org.opencms.file.wrapper that return CmsFileModifier and TypeMethodDescriptionstatic CmsFile
CmsResourceWrapperUtils.createPropertyFile
(CmsObject cms, CmsResource res, String path) Creates a virtual CmsFile with the individual and shared properties as content.CmsWrappedResource.getFile()
Returns the virtual resource as a file.A_CmsResourceExtensionWrapper.readFile
(CmsObject cms, String resourcename, CmsResourceFilter filter) A_CmsResourceWrapper.readFile
(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsObjectWrapper.readFile
(String resourcename, CmsResourceFilter filter) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.CmsResourceWrapperModules.readFile
(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsResourceWrapperModulesNonLazy.readFile
(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsResourceWrapperPropertyFile.readFile
(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsResourceWrapperXmlPage.readFile
(CmsObject cms, String resourcename, CmsResourceFilter filter) I_CmsResourceWrapper.readFile
(CmsObject cms, String resourcename, CmsResourceFilter filter) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.Writes a resource to the OpenCms VFS, including it's content.Writes a resource, including it's content.Methods in org.opencms.file.wrapper with parameters of type CmsFileModifier and TypeMethodDescriptionWrites a resource to the OpenCms VFS, including it's content.Writes a resource, including it's content. -
Uses of CmsFile in org.opencms.importexport
Methods in org.opencms.importexport with parameters of type CmsFileModifier and TypeMethodDescriptionprotected void
CmsExport.exportFile
(CmsFile file) Exports one single file with all its data and content.void
Writes a single OpenCms VFS file to the export.protected void
CmsExportHelper.writeFile2Rfs
(CmsFile file, String name) Writes a single OpenCms VFS file to the RFS export.protected void
CmsExportHelper.writeFile2Zip
(CmsFile file, String name) Writes a single OpenCms VFS file to the ZIP export. -
Uses of CmsFile in org.opencms.jlan
Methods in org.opencms.jlan that return CmsFile -
Uses of CmsFile in org.opencms.jsp
Methods in org.opencms.jsp that return CmsFile -
Uses of CmsFile in org.opencms.jsp.util
Methods in org.opencms.jsp.util that return CmsFileModifier and TypeMethodDescriptionCmsJspContentAccessBean.getFile()
Returns the raw VFS file object the content accessed by this bean was created from.CmsJspResourceAccessBean.getFile()
Returns the raw VFS file object of the current resource.Methods in org.opencms.jsp.util with parameters of type CmsFileModifier and TypeMethodDescriptionvoid
CmsJspStandardContextBean.CmsContainerElementWrapper.setHistoryFile
(CmsFile file) void
CmsJspStandardContextBean.CmsContainerElementWrapper.setTemporaryFile
(CmsFile elementFile) -
Uses of CmsFile in org.opencms.loader
Methods in org.opencms.loader that return CmsFileModifier and TypeMethodDescriptionprotected CmsFile
CmsImageLoader.getScaledImage
(CmsObject cms, CmsResource resource, CmsImageScaler scaler) Returns a scaled version of the given OpenCms VFS image resource.Methods in org.opencms.loader with parameters of type CmsFileModifier and TypeMethodDescriptionbyte[]
CmsImageScaler.scaleImage
(CmsFile file) Returns a scaled version of the given image file according this image scalers parameters. -
Uses of CmsFile in org.opencms.lock
Methods in org.opencms.lock that return CmsFile -
Uses of CmsFile in org.opencms.relations
Methods in org.opencms.relations with parameters of type CmsFileModifier and TypeMethodDescriptionI_CmsLinkParseable.parseLinks
(CmsObject cms, CmsFile file) Returns a list of all links from the specified file. -
Uses of CmsFile in org.opencms.search.documents
Methods in org.opencms.search.documents that return CmsFileModifier and TypeMethodDescriptionprotected CmsFile
A_CmsVfsDocument.readFile
(CmsObject cms, CmsResource resource) Upgrades the given resource to aCmsFile
with content. -
Uses of CmsFile in org.opencms.ugc
Methods in org.opencms.ugc with parameters of type CmsFileModifier and TypeMethodDescriptionprotected CmsXmlContent
CmsUgcSession.addContentValues
(CmsFile file, Map<String, String> contentValues) Adds the given values to the content document.CmsUgcConfigurationReader.readConfiguration
(CmsFile configFile) Reads the given configuration file. -
Uses of CmsFile in org.opencms.workplace.comparison
Constructors in org.opencms.workplace.comparison with parameters of type CmsFileModifierConstructorDescriptionCmsXmlDocumentComparison
(CmsObject cms, CmsFile res1, CmsFile res2) Creates a new xml document comparison. -
Uses of CmsFile in org.opencms.workplace.editors
Fields in org.opencms.workplace.editors declared as CmsFileModifier and TypeFieldDescriptionprotected CmsFile
CmsDefaultPageEditor.m_file
File object used to read and write contents.Methods in org.opencms.workplace.editors with parameters of type CmsFileModifier and TypeMethodDescriptionprotected String
CmsSimpleEditor.decodeContentParameter
(String encodedContent, String encoding, CmsFile originalFile) Decodes the content from the content request parameter. -
Uses of CmsFile in org.opencms.workplace.editors.directedit
Methods in org.opencms.workplace.editors.directedit with parameters of type CmsFileModifier and TypeMethodDescriptionprotected String
CmsDirectEditDefaultProvider.getContentAsString
(CmsFile file) Helper method to convert the content of a resource to a string. -
Uses of CmsFile in org.opencms.xml
Fields in org.opencms.xml declared as CmsFileModifier and TypeFieldDescriptionprotected CmsFile
A_CmsXmlDocument.m_file
The file that contains the document data (note: is not set when creating an empty or document based document).Methods in org.opencms.xml that return CmsFileModifier and TypeMethodDescriptionA_CmsXmlDocument.correctXmlStructure
(CmsObject cms) Corrects the structure of this XML document.A_CmsXmlDocument.getFile()
I_CmsXmlDocument.getFile()
Returns the file this document was generated from, may benull
if the file not available. -
Uses of CmsFile in org.opencms.xml.containerpage
Methods in org.opencms.xml.containerpage that return CmsFileModifier and TypeMethodDescriptionCmsHtmlRedirectHandler.prepareForWrite
(CmsObject cms, CmsXmlContent content, CmsFile file) CmsListConfigContentHandler.prepareForWrite
(CmsObject cms, CmsXmlContent content, CmsFile file) CmsXmlContainerPageHandler.prepareForWrite
(CmsObject cms, CmsXmlContent content, CmsFile file) Methods in org.opencms.xml.containerpage with parameters of type CmsFileModifier and TypeMethodDescriptionCmsHtmlRedirectHandler.prepareForWrite
(CmsObject cms, CmsXmlContent content, CmsFile file) CmsListConfigContentHandler.prepareForWrite
(CmsObject cms, CmsXmlContent content, CmsFile file) CmsXmlContainerPageHandler.prepareForWrite
(CmsObject cms, CmsXmlContent content, CmsFile file) protected void
protected void
void
CmsContainerElementBean.setHistoryFile
(CmsFile file) Sets a historical file.void
CmsContainerElementBean.setTemporaryFile
(CmsFile elementFile) Sets the element resource as a temporary file.static CmsXmlContainerPage
Factory method to unmarshal (read) a container page instance from a OpenCms VFS file that contains XML data.static CmsXmlContainerPage
Factory method to unmarshal (read) a container page instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.static CmsXmlContainerPage
CmsXmlContainerPageFactory.unmarshal
(CmsObject cms, CmsFile file, boolean keepEncoding, boolean noCache) Factory method to unmarshal (read) a container page instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.static CmsXmlGroupContainer
Factory method to unmarshal (read) a group container instance from a OpenCms VFS file that contains XML data.static CmsXmlGroupContainer
Factory method to unmarshal (read) a group container instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.Constructors in org.opencms.xml.containerpage with parameters of type CmsFile -
Uses of CmsFile in org.opencms.xml.content
Methods in org.opencms.xml.content that return CmsFileModifier and TypeMethodDescriptionCmsDefaultXmlContentHandler.prepareForWrite
(CmsObject cms, CmsXmlContent content, CmsFile file) I_CmsXmlContentHandler.prepareForWrite
(CmsObject cms, CmsXmlContent content, CmsFile file) Prepares the given XML content to be written to the OpenCms VFS.protected CmsFile
CmsDefaultXmlContentHandler.writeCategories
(CmsObject cms, CmsFile file, CmsXmlContent content) Writes the categories if a category widget is present.Methods in org.opencms.xml.content with parameters of type CmsFileModifier and TypeMethodDescriptionCmsDefaultXmlContentHandler.prepareForWrite
(CmsObject cms, CmsXmlContent content, CmsFile file) I_CmsXmlContentHandler.prepareForWrite
(CmsObject cms, CmsXmlContent content, CmsFile file) Prepares the given XML content to be written to the OpenCms VFS.protected void
CmsDefaultXmlContentHandler.removeEmptyMappings
(CmsObject cms, CmsFile file, CmsXmlContent content) Removes property values on resources for non-existing, optional elements.protected void
CmsDefaultXmlContentHandler.resolveDefaultMappings
(CmsObject cms, CmsFile file, CmsXmlContent content) Resolves those mappings for which no content value exists and useDefault is set to true.protected void
Sets the file this XML content is written to.static CmsXmlContent
Factory method to unmarshal (read) a XML content instance from a OpenCms VFS file that contains XML data.static CmsXmlContent
Factory method to unmarshal (read) a XML content instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.protected CmsFile
CmsDefaultXmlContentHandler.writeCategories
(CmsObject cms, CmsFile file, CmsXmlContent content) Writes the categories if a category widget is present. -
Uses of CmsFile in org.opencms.xml.page
Methods in org.opencms.xml.page with parameters of type CmsFileModifier and TypeMethodDescriptionprotected void
Sets the file this XML page content is written to.static CmsXmlPage
Factory method to unmarshal (read) a XML page instance from a OpenCms VFS file that contains XML data.static CmsXmlPage
Factory method to unmarshal (read) a XML page instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property. -
Uses of CmsFile in org.opencms.xml.xml2json.handler
Methods in org.opencms.xml.xml2json.handler that return CmsFile