Uses of Class
org.opencms.file.CmsFile

Packages that use CmsFile

Package	Description
org.opencms.ade.containerpage	Contains the container page editor service classes.
org.opencms.ade.containerpage.inherited	Contains classes used for reading and caching inheritance groups.
org.opencms.ade.contenteditor	Contains server side classes for the XML content editor.
org.opencms.db	Low-level database connection and access functionality.
org.opencms.db.generic	Generic (ANSI-SQL) implementation of the OpenCms database connector.
org.opencms.file	This important package provides the methods to access the OpenCms VFS repository with the permissions of an authenticated user.
org.opencms.file.history	This package contains the classes to deal with the OpenCms VFS history archive.
org.opencms.file.types	The implementations of the core resource types for the VFS are located here.
org.opencms.file.wrapper	This package contains classes and interfaces used to access OpenCms through a wrapped CmsObject.
org.opencms.importexport	Contains functions to import and export resources from the OpenCms VFS.
org.opencms.jlan
org.opencms.jsp	The implementation of the OpenCms JSP tag library, with some additional utility classes to help in JSP scriplet code and navigation building.
org.opencms.jsp.util	Utility classes to be used for JSP pages.
org.opencms.loader	Low-level functions to manage the loading of resources from the OpenCms VFS.
org.opencms.lock	The lock state of the resources in the VFS is handled with these classes.
org.opencms.relations	Classes to represent and validate the internal and external links/relations of resources in the OpenCms VFS.
org.opencms.search.documents	Handles indexing different sorts of document and resource type from the OpenCms VFS for the full text search.
org.opencms.ugc
org.opencms.workplace.comparison	Utilities for comparing different versions of resources, used by both the classic workplace and the new Vaadin-based workplace.
org.opencms.workplace.editors	Base classes for the editors (WYSIWYG, plain text, XML content) used in the OpenCms Workplace.
org.opencms.workplace.editors.directedit	Used to control the generation of the HTML for the "direct edit" buttons.
org.opencms.xml	Basic XML functionality and utilities used by OpenCms to maintain XML documents and content.
org.opencms.xml.containerpage	Contains functions for the ADE main pages, commonly called "Container Pages" in OpenCms.
org.opencms.xml.content	Contains functions for structured content storage using XML, commonly called "XML content" in OpenCms.
org.opencms.xml.page	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 CmsFile

Modifier and Type	Method and Description
java.lang.String	CmsElementUtil.getContentByContainer(CmsFile elementFile, java.lang.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

Modifier and Type	Method and Description
void	CmsContainerConfigurationParser.parse(CmsFile file) Parses the contents of a file.

Uses of CmsFile in org.opencms.ade.contenteditor

Methods in org.opencms.ade.contenteditor with parameters of type CmsFile

Modifier and Type	Method and Description
protected void	CmsContentService.synchronizeLocaleIndependentFields(CmsFile file, CmsXmlContent content, java.util.Collection<java.lang.String> skipPaths, java.util.Collection<CmsEntity> entities, java.util.Locale lastEdited) Synchronizes the locale independent fields.

Constructors in org.opencms.ade.contenteditor with parameters of type CmsFile

Constructor and Description
CmsContentTypeVisitor(CmsObject cms, CmsFile file, java.util.Locale locale) Constructor.

Uses of CmsFile in org.opencms.db

Methods in org.opencms.db that return CmsFile

Modifier and Type	Method and Description
CmsFile	I_CmsVfsDriver.createFile(java.sql.ResultSet res, CmsUUID projectId) Creates a CmsFile instance from a JDBC ResultSet.
CmsFile	I_CmsVfsDriver.createFile(java.sql.ResultSet res, CmsUUID projectId, boolean hasFileContentInResultSet) Creates a CmsFile instance from a JDBC ResultSet.
CmsFile	I_CmsProjectDriver.publishFileContent(CmsDbContext dbc, CmsProject offlineProject, CmsProject onlineProject, CmsResource offlineFileHeader, java.util.Set<CmsUUID> publishedResourceIds, boolean needToUpdateContent, int publishTag) Publishes the content record of a file.
CmsFile	CmsDriverManager.readFile(CmsDbContext dbc, CmsResource resource) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.
CmsFile	CmsSecurityManager.readFile(CmsRequestContext context, CmsResource resource) Reads a file resource (including it's binary content) from the VFS.
CmsFile	CmsDriverManager.writeFile(CmsDbContext dbc, CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.
CmsFile	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 CmsFile

Modifier and Type	Method and Description
CmsFile	CmsDriverManager.writeFile(CmsDbContext dbc, CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.
CmsFile	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 CmsFile

Modifier and Type	Method and Description
CmsFile	CmsVfsDriver.createFile(java.sql.ResultSet res, CmsUUID projectId)
CmsFile	CmsVfsDriver.createFile(java.sql.ResultSet res, CmsUUID projectId, boolean hasFileContentInResultSet)
CmsFile	CmsProjectDriver.publishFileContent(CmsDbContext dbc, CmsProject offlineProject, CmsProject onlineProject, CmsResource offlineResource, java.util.Set<CmsUUID> publishedResourceIds, boolean needToUpdateContent, int publishTag)

Uses of CmsFile in org.opencms.file

Methods in org.opencms.file that return CmsFile

Modifier and Type	Method and Description
CmsFile	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).
CmsFile	CmsObject.readFile(java.lang.String resourcename) Reads a file resource (including it's binary content) from the VFS, using the CmsResourceFilter.DEFAULT filter.
CmsFile	CmsObject.readFile(java.lang.String resourcename, CmsResourceFilter filter) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.
CmsFile	CmsObject.writeFile(CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.

Methods in org.opencms.file with parameters of type CmsFile

Modifier and Type	Method and Description
protected CmsPair<java.lang.String,java.lang.String>	CmsLinkRewriter.decode(CmsFile file) Decodes 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, java.util.Collection<CmsRelation> relations) Rewrites the links included in the content itself.
CmsFile	CmsObject.writeFile(CmsFile resource) 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.history

Modifier and Type	Class and Description
class	CmsHistoryFile 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 CmsFile

Modifier and Type	Method and Description
CmsFile	CmsResourceTypeFunctionConfig.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeXmlContainerPage.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeImage.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypePlain.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeXmlPage.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	A_CmsResourceType.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	I_CmsResourceType.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) Writes a resource, including it's content.
CmsFile	CmsResourceTypeJsp.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeXmlContent.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)

Methods in org.opencms.file.types with parameters of type CmsFile

Modifier and Type	Method and Description
java.util.List<CmsLink>	CmsResourceTypeXmlContainerPage.parseLinks(CmsObject cms, CmsFile file)
java.util.List<CmsLink>	CmsResourceTypeXmlPage.parseLinks(CmsObject cms, CmsFile file)
java.util.List<CmsLink>	CmsResourceTypeJsp.parseLinks(CmsObject cms, CmsFile file)
java.util.List<CmsLink>	CmsResourceTypeXmlContent.parseLinks(CmsObject cms, CmsFile file)
CmsFile	CmsResourceTypeFunctionConfig.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeXmlContainerPage.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeImage.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypePlain.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeXmlPage.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	A_CmsResourceType.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	I_CmsResourceType.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) Writes a resource, including it's content.
CmsFile	CmsResourceTypeJsp.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeXmlContent.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)

Uses of CmsFile in org.opencms.file.wrapper

Methods in org.opencms.file.wrapper that return CmsFile

Modifier and Type	Method and Description
static CmsFile	CmsResourceWrapperUtils.createPropertyFile(CmsObject cms, CmsResource res, java.lang.String path) Creates a virtual CmsFile with the individual and shared properties as content.
CmsFile	CmsWrappedResource.getFile() Returns the virtual resource as a file.
CmsFile	CmsResourceWrapperXmlPage.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsFile	A_CmsResourceExtensionWrapper.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsFile	CmsResourceWrapperPropertyFile.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsFile	CmsResourceWrapperModules.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsFile	A_CmsResourceWrapper.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsFile	I_CmsResourceWrapper.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.
CmsFile	CmsObjectWrapper.readFile(java.lang.String resourcename, CmsResourceFilter filter) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.
CmsFile	CmsObjectWrapper.writeFile(CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.
CmsFile	CmsResourceWrapperXmlPage.writeFile(CmsObject cms, CmsFile resource)
CmsFile	A_CmsResourceExtensionWrapper.writeFile(CmsObject cms, CmsFile resource)
CmsFile	CmsResourceWrapperPropertyFile.writeFile(CmsObject cms, CmsFile resource)
CmsFile	CmsResourceWrapperModules.writeFile(CmsObject cms, CmsFile resource)
CmsFile	A_CmsResourceWrapper.writeFile(CmsObject cms, CmsFile resource)
CmsFile	I_CmsResourceWrapper.writeFile(CmsObject cms, CmsFile resource) Writes a resource, including it's content.

Methods in org.opencms.file.wrapper with parameters of type CmsFile

Modifier and Type	Method and Description
CmsFile	CmsObjectWrapper.writeFile(CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.
CmsFile	CmsResourceWrapperXmlPage.writeFile(CmsObject cms, CmsFile resource)
CmsFile	A_CmsResourceExtensionWrapper.writeFile(CmsObject cms, CmsFile resource)
CmsFile	CmsResourceWrapperPropertyFile.writeFile(CmsObject cms, CmsFile resource)
CmsFile	CmsResourceWrapperModules.writeFile(CmsObject cms, CmsFile resource)
CmsFile	A_CmsResourceWrapper.writeFile(CmsObject cms, CmsFile resource)
CmsFile	I_CmsResourceWrapper.writeFile(CmsObject cms, CmsFile resource) Writes a resource, including it's content.

Uses of CmsFile in org.opencms.importexport

Methods in org.opencms.importexport with parameters of type CmsFile

Modifier and Type	Method and Description
protected void	CmsExport.exportFile(CmsFile file) Exports one single file with all its data and content.
void	CmsExportHelper.writeFile(CmsFile file, java.lang.String name) Writes a single OpenCms VFS file to the export.
protected void	CmsExportHelper.writeFile2Rfs(CmsFile file, java.lang.String name) Writes a single OpenCms VFS file to the RFS export.
protected void	CmsExportHelper.writeFile2Zip(CmsFile file, java.lang.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

Modifier and Type	Method and Description
protected CmsFile	CmsJlanNetworkFile.getFile() Gets the CmsFile instance for this file, or null if the file contents haven'T been loaded already.

Uses of CmsFile in org.opencms.jsp

Methods in org.opencms.jsp that return CmsFile

Modifier and Type	Method and Description
CmsFile	CmsJspResourceWrapper.getFile() Returns the full file object for this resource.

Uses of CmsFile in org.opencms.jsp.util

Methods in org.opencms.jsp.util that return CmsFile

Modifier and Type	Method and Description
CmsFile	CmsJspResourceAccessBean.getFile() Returns the raw VFS file object of the current resource.
CmsFile	CmsJspContentAccessBean.getFile() Returns the raw VFS file object the content accessed by this bean was created from.

Methods in org.opencms.jsp.util with parameters of type CmsFile

Modifier and Type	Method and Description
void	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 CmsFile

Modifier and Type	Method and Description
protected 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 CmsFile

Modifier and Type	Method and Description
byte[]	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

Modifier and Type	Method and Description
CmsFile	CmsLockUtil.LockedFile.getFile() Returns the file, or null if reading fails.

Uses of CmsFile in org.opencms.relations

Methods in org.opencms.relations with parameters of type CmsFile

Modifier and Type	Method and Description
java.util.List<CmsLink>	I_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 CmsFile

Modifier and Type	Method and Description
protected CmsFile	A_CmsVfsDocument.readFile(CmsObject cms, CmsResource resource) Upgrades the given resource to a CmsFile with content.

Uses of CmsFile in org.opencms.ugc

Methods in org.opencms.ugc with parameters of type CmsFile

Modifier and Type	Method and Description
protected CmsXmlContent	CmsUgcSession.addContentValues(CmsFile file, java.util.Map<java.lang.String,java.lang.String> contentValues) Adds the given values to the content document.
CmsUgcConfiguration	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 CmsFile

Constructor and Description
CmsXmlDocumentComparison(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 CmsFile

Modifier and Type	Field and Description
protected CmsFile	CmsDefaultPageEditor.m_file File object used to read and write contents.

Methods in org.opencms.workplace.editors with parameters of type CmsFile

Modifier and Type	Method and Description
protected java.lang.String	CmsSimpleEditor.decodeContentParameter(java.lang.String encodedContent, java.lang.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 CmsFile

Modifier and Type	Method and Description
protected java.lang.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 CmsFile

Modifier and Type	Field and Description
protected 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 CmsFile

Modifier and Type	Method and Description
CmsFile	A_CmsXmlDocument.correctXmlStructure(CmsObject cms) Corrects the structure of this XML document.
CmsFile	I_CmsXmlDocument.getFile() Returns the file this document was generated from, may be null if the file not available.
CmsFile	A_CmsXmlDocument.getFile()

Uses of CmsFile in org.opencms.xml.containerpage

Methods in org.opencms.xml.containerpage that return CmsFile

Modifier and Type	Method and Description
CmsFile	CmsHtmlRedirectHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file)

Methods in org.opencms.xml.containerpage with parameters of type CmsFile

Modifier and Type	Method and Description
CmsFile	CmsHtmlRedirectHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file)
protected void	CmsXmlGroupContainer.setFile(CmsFile file)
protected void	CmsXmlContainerPage.setFile(CmsFile file)
void	CmsContainerElementBean.setHistoryFile(CmsFile file) Sets a historical file.
void	CmsContainerElementBean.setTemporaryFile(CmsFile elementFile) Sets the element resource as a temporary file.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, CmsFile file) Factory method to unmarshal (read) a group container instance from a OpenCms VFS file that contains XML data.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsFile file) Factory method to unmarshal (read) a container page instance from a OpenCms VFS file that contains XML data.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding) 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.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding) 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.

Constructors in org.opencms.xml.containerpage with parameters of type CmsFile

Constructor and Description
CmsContainerElementBean(CmsFile file, CmsUUID formatterId, java.util.Map<java.lang.String,java.lang.String> individualSettings, boolean inMemoryOnly, java.lang.String editorHash, boolean createNew) Creates a new container page element bean.

Uses of CmsFile in org.opencms.xml.content

Methods in org.opencms.xml.content that return CmsFile

Modifier and Type	Method and Description
CmsFile	CmsDefaultXmlContentHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file)
CmsFile	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 CmsFile

Modifier and Type	Method and Description
CmsFile	CmsDefaultXmlContentHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file)
CmsFile	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	CmsXmlContent.setFile(CmsFile file) Sets the file this XML content is written to.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, CmsFile file) Factory method to unmarshal (read) a XML content instance from a OpenCms VFS file that contains XML data.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding) 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 CmsFile

Modifier and Type	Method and Description
protected void	CmsXmlPage.setFile(CmsFile file) Sets the file this XML page content is written to.
static CmsXmlPage	CmsXmlPageFactory.unmarshal(CmsObject cms, CmsFile file) Factory method to unmarshal (read) a XML page instance from a OpenCms VFS file that contains XML data.
static CmsXmlPage	CmsXmlPageFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding) 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.