Uses of Class
org.opencms.file.CmsResource

Packages that use CmsResource

Package	Description
org.opencms.ade.configuration	Contains the ade configuration classes.
org.opencms.ade.configuration.formatters	Classes for handling formatter configurations.
org.opencms.ade.configuration.plugins
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.ade.detailpage	Contains functions for the detail pages in OpenCms.
org.opencms.ade.galleries	Contains server side classes for the gallery dialogs.
org.opencms.ade.publish	This package contains the server-side classes for the publish module.
org.opencms.ade.sitemap	Server side of the sitemap view.
org.opencms.cache	Implementations of specialized caches used in OpenCms.
org.opencms.cmis
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.db.mysql	MySQL4+ implementation of the OpenCms database connector.
org.opencms.db.oracle	Oracle9+ 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.collectors	Collectors allow to gather lists of OpenCms resources from the OpenCms VFS using specific rules.
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.flex	Provides low-level JSP integration funtionality for OpenCms, also implements the FlexCache, a declarative parameter-based cache.
org.opencms.gwt	Provides core support for GWT.
org.opencms.i18n	Classes to handle internalization (i18n) and locale selection in OpenCms.
org.opencms.i18n.tools	Tools for i18n.
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.decorator	HTML postprocessor, used to tag single words or phrases in the HTML output.
org.opencms.jsp.search.config.parser.simplesearch	Helpers to convert the list configuration XML content into a suitable bean, used by the CmsSimpleSearchConfigurationParser and the List manager app.
org.opencms.jsp.userdata
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.mail	Provides utility classes to generate email messages using the OpenCms email configuration.
org.opencms.main	Provides the main OpenCms "operating system".
org.opencms.module	OpenCms modules provide a powerful, standardized way to extend the core OpenCms functionality.
org.opencms.monitor	Contains functions to monitor the OpenCms system status.
org.opencms.newsletter	Contains classes to distribute newsletters.
org.opencms.notification	Contains classes for the automatical notification of outdated, expiring or released content.
org.opencms.pdftools
org.opencms.publish	Classes to handle the OpenCms publish process.
org.opencms.relations	Classes to represent and validate the internal and external links/relations of resources in the OpenCms VFS.
org.opencms.repository	Package contains all classes and interfaces needed to create or use a repository to access the resources in the VFS.
org.opencms.search	Implements the main full text search and indexing functions available in OpenCms.
org.opencms.search.documents	Handles indexing different sorts of document and resource type from the OpenCms VFS for the full text search.
org.opencms.search.fields	These classes control the mapping of the OpenCms content to the Lucene search fields.
org.opencms.search.galleries	Implements the search functions for the OpenCms Gallery search index, which is used by the Advanced Direct Edit (ADE) functions.
org.opencms.search.solr	The package contains the Solr search integration.
org.opencms.security	Access control and security classes for the OpenCms ACL permission system.
org.opencms.site	Provides access to the multi-site configuration of OpenCms.
org.opencms.site.xmlsitemap	Contains classes related to XML sitemap generation.
org.opencms.staticexport	Contains the functionality for the static HTML page export.
org.opencms.synchronize	Classes used to synchronize the OpenCms VFS with the real file system.
org.opencms.ugc
org.opencms.ui	General code for the Vaadin UI.
org.opencms.ui.actions	Contains classes for workplace actions.
org.opencms.ui.apps	Contains code for workplace apps.
org.opencms.ui.apps.datesearch
org.opencms.ui.apps.dbmanager	Contains classes of the cache admin app.
org.opencms.ui.apps.linkvalidation	Contains classes of the link validation app.
org.opencms.ui.apps.lists	This package contains the app classes for the list configurations manager.
org.opencms.ui.apps.search	Contains classes of the source search app.
org.opencms.ui.apps.user	Contains classes of the user manager app.
org.opencms.ui.components	Contains some reusable GUI components for Vaadin UI.
org.opencms.ui.components.extensions	Contains Vaadin UI extensions.
org.opencms.ui.components.fileselect	Contains components for selecting resources.
org.opencms.ui.contextmenu	Contains code for workplace context menu.
org.opencms.ui.dialogs	Contains code for workplace dialogs.
org.opencms.ui.dialogs.embedded
org.opencms.ui.dialogs.history.diff	Contains code for the comparison view of the file history dialog.
org.opencms.ui.editors	The available content editors.
org.opencms.ui.editors.messagebundle	The data bindings and logic for the translator editor.
org.opencms.ui.favorites
org.opencms.ui.sitemap	Vaadin GUI components and utilities for use in the sitemap editor.
org.opencms.ui.util	Utilities for Vaadin workplace code.
org.opencms.util	Utility functions for String manipulation and other often used tasks.
org.opencms.widgets	Contains the widget implementations, these are GUI elements used in editors and dialogs of the OpenCms workplace.
org.opencms.workflow	Classes related to publishing and workflow.
org.opencms.workplace	The base classes for the OpenCms Workplace (standard dialog, tab dialog, report based dialog) and the Workplace configuration classes are located here.
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.workplace.explorer	Contains the functions that generate the Workplace "Explorer" view, also contains the "New resource" wizard.
org.opencms.workplace.galleries	Contains the various "Galleries" which are available in the editors and widgets of the OpenCms Workplace.
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.containerpage.mutable
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.
org.opencms.xml.templatemapper
org.opencms.xml.xml2json
org.opencms.xml.xml2json.document
org.opencms.xml.xml2json.handler
org.opencms.xml.xml2json.renderer

Uses of CmsResource in org.opencms.ade.configuration

Methods in org.opencms.ade.configuration that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsResourceTypeConfig.createNewElement(CmsObject userCms, String pageFolderRootPath)	Creates a new element.
CmsResource	CmsResourceTypeConfig.createNewElement(CmsObject userCms, CmsResource modelResource, String pageFolderRootPath)	Creates a new element.
CmsResource	CmsContentFolderDescriptor.getFolder()	Gets the folder.
CmsResource	CmsADEConfigData.getResource()	Returns the resource from which this configuration was read.
CmsResource	CmsADEConfigDataInternal.getResource()	Returns the resource.
CmsResource	CmsElementView.getResource()	Returns the element view resource.
CmsResource	CmsModelPageConfig.getResource()	Gets the model page resource.

Methods in org.opencms.ade.configuration that return types with arguments of type CmsResource

Modifier and Type	Method	Description
Stream<CmsResource>	CmsADEManager.getOfflineElementUses(CmsResource resource)	Creates a stream that produces the pages/groups referencing a given element.

Methods in org.opencms.ade.configuration with parameters of type CmsResource

Modifier and Type	Method	Description
CmsResource	CmsResourceTypeConfig.createNewElement(CmsObject userCms, CmsResource modelResource, String pageFolderRootPath)	Creates a new element.
Map<String,CmsXmlContentProperty>	CmsADEManager.getElementSettings(CmsObject cms, CmsResource resource)	Returns the element settings for a given resource.
CmsFormatterConfiguration	CmsADEConfigData.getFormatters(CmsObject cms, CmsResource res)	Gets the formatter configuration for a resource.
Map<String,CmsXmlContentProperty>	CmsADEManager.getFormatterSettings(CmsObject cms, CmsADEConfigData config, I_CmsFormatterBean mainFormatter, CmsResource res, Locale locale, javax.servlet.ServletRequest req)	Returns the settings configured for the given formatter which should be editable via ADE.
protected CmsFormatterConfiguration	CmsADEConfigData.getFormattersFromSchema(CmsObject cms, CmsResource res)	Gets the formatters from the schema.
CmsInheritedContainerState	CmsADEManager.getInheritedContainerState(CmsObject cms, CmsResource resource, String name)	Returns the inheritance state for the given inheritance name and resource.
List<I_CmsFormatterBean>	CmsADEManager.getNestedFormatters(CmsObject cms, CmsADEConfigData config, CmsResource res, Locale locale, javax.servlet.ServletRequest req)	Returns the nested formatters of the given resource.
Stream<CmsResource>	CmsADEManager.getOfflineElementUses(CmsResource resource)	Creates a stream that produces the pages/groups referencing a given element.
CmsPermissionInfo	CmsADEManager.getPermissionInfo(CmsObject cms, CmsResource resource, String contextPath)	Returns the permission info for the given resource.
boolean	CmsElementView.hasPermission(CmsObject cms, CmsResource folder)	Checks whether the current user has permissions to use the element view.
protected boolean	CmsADEConfigCacheState.isDetailPage(CmsObject cms, CmsResource resource)	Checks whether the given resource is configured as a detail page.
boolean	CmsADEManager.isDetailPage(CmsObject cms, CmsResource resource)	Checks whether the given resource is configured as a detail page.
boolean	CmsADEManager.isEditorRestricted(CmsObject cms, CmsResource res)	Checks if the user should be prevented from editing a file.
boolean	CmsADEManager.isElementReused(CmsResource resource, Predicate<CmsResource> exclude)	Checks if an element is reused in a page or group that is not excluded by a given predicate.
protected void	CmsGlobalConfigurationCacheEventHandler.offlineCacheRemove(CmsResource resource)	Removes a resource from the offline caches.
protected void	CmsGlobalConfigurationCacheEventHandler.offlineCacheUpdate(CmsResource resource)	Updates a resource in the offline caches.
protected void	CmsGlobalConfigurationCacheEventHandler.onlineCacheRemove(CmsResource resource)	Removes a resource from the online caches.
protected void	CmsGlobalConfigurationCacheEventHandler.onlineCacheUpdate(CmsResource resource)	Updates a resource in the online caches.
CmsADEConfigDataInternal	CmsConfigurationReader.parseSitemapConfiguration(String basePath, CmsResource configRes)	Parses the sitemap configuration given the configuration file and base path.
static CmsSitemapAttributeEditorConfiguration	CmsSitemapAttributeEditorConfiguration.read(CmsObject cms, CmsResource res)	Reads the attribute definitions from an XML content.
void	CmsDetailNameCache.remove(CmsResource resource)
void	I_CmsGlobalConfigurationCache.remove(CmsResource resource)	Removes a resource from the cache.
void	CmsADEManager.saveInheritedContainer(CmsObject cms, CmsResource pageResource, String name, boolean newOrder, List<CmsContainerElementBean> elements)	Saves the inheritance container information.
void	CmsDetailNameCache.update(CmsResource resource)
void	I_CmsGlobalConfigurationCache.update(CmsResource resource)	Updates the cache entry for the given resource.

Method parameters in org.opencms.ade.configuration with type arguments of type CmsResource

Modifier and Type	Method	Description
boolean	CmsADEManager.isElementReused(CmsResource resource, Predicate<CmsResource> exclude)	Checks if an element is reused in a page or group that is not excluded by a given predicate.

Constructors in org.opencms.ade.configuration with parameters of type CmsResource

Modifier	Constructor	Description
	CmsADEConfigDataInternal(CmsObject cms, CmsResource resource, boolean isModuleConfig, String basePath, List<CmsADEConfigDataInternal.ConfigReference> masterConfigs, List<CmsResourceTypeConfig> resourceTypeConfig, CmsGalleryDisabledTypesMode galleryDisabledTypesMode, CmsGalleryDisabledTypesMode galleryDisabledFunctionsMode, boolean discardInheritedTypes, List<CmsPropertyConfig> propertyConfig, org.opencms.ade.configuration.CmsConfigurationReader.DiscardPropertiesMode discardPropertiesMode, List<CmsDetailPageInfo> detailPageInfos, List<CmsModelPageConfigWithoutResource> modelPages, List<CmsFunctionReference> functionReferences, boolean discardInheritedModelPages, boolean createContentsLocally, boolean preferDetailPagesForLocalContents, boolean excludeExternalDetailContents, boolean includeInSiteSelector, CmsFormatterChangeSet formatterChangeSet, boolean removeAllFunctions, Set<CmsUUID> functionIds, Set<CmsUUID> functionsToRemove, boolean removeAllPlugins, Set<CmsUUID> addedPlugins, Set<CmsUUID> removedPlugins, Boolean useFormatterKeys, CmsTypeOrderingMode orderingMode, CmsAddContentRestriction restriction, CmsUUID sharedSettingOverride, boolean removeSharedSettingOverrides, CmsUUID attributeEditorConfigId, Map<String,String> attributes)	Creates a new configuration data instance.
protected	CmsADEConfigDataInternal(CmsResource resource, boolean isModuleConfig, String basePath, List<CmsADEConfigDataInternal.ConfigReference> masterConfigs, List<CmsResourceTypeConfig> resourceTypeConfig, boolean discardInheritedTypes, List<CmsPropertyConfig> propertyConfig, org.opencms.ade.configuration.CmsConfigurationReader.DiscardPropertiesMode discardPropertiesMode, List<CmsDetailPageInfo> detailPageInfos, List<CmsModelPageConfig> modelPages, List<CmsFunctionReference> functionReferences, boolean discardInheritedModelPages, boolean createContentsLocally, boolean preferDetailPagesForLocalContents, boolean excludeExternalDetailContents, boolean includeInSiteSelector, CmsFormatterChangeSet formatterChangeSet, boolean removeAllFunctions, Set<CmsUUID> functionIds)	Creates a new configuration data instance.
	CmsContentFolderDescriptor(CmsResource folder)	Creates an instance based on an existing folder.
	CmsElementView(CmsObject cms, CmsResource resource)	Constructor.
	CmsModelPageConfig(CmsResource res, boolean isDefault, boolean isDisabled)	Creates a new model page configuration bean.

Uses of CmsResource in org.opencms.ade.configuration.formatters

Methods in org.opencms.ade.configuration.formatters with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsFormatterConfigurationCache.remove(CmsResource resource)
void	CmsFormatterConfigurationCache.update(CmsResource resource)

Uses of CmsResource in org.opencms.ade.configuration.plugins

Methods in org.opencms.ade.configuration.plugins with parameters of type CmsResource

Modifier and Type	Method	Description
static CmsSitePlugin	CmsSitePlugin.read(CmsObject cms, CmsResource res)	Reads a site plugin from a file.

Uses of CmsResource in org.opencms.ade.containerpage

Methods in org.opencms.ade.containerpage that return CmsResource

Modifier and Type	Method	Description
static CmsResource	CmsModelGroupHelper.createModelGroup(CmsObject cms, CmsADEConfigData configData)	Creates a new model group resource.
CmsResource	CmsElementUtil.getPage()	Gets the container page.
static CmsResource	CmsDetailOnlyContainerUtil.readOrCreateDetailOnlyPage(CmsObject cms, CmsUUID detailId, String detailOnlyRootPath)	Creates an empty detail-only page for a content, or just reads the resource if the detail-only page already exists.

Methods in org.opencms.ade.containerpage that return types with arguments of type CmsResource

Modifier and Type	Method	Description
static com.google.common.base.Optional<CmsResource>	CmsDetailOnlyContainerUtil.getDetailOnlyPage(CmsObject cms, CmsResource detailContent, String contentLocale)	Gets the detail only page for a detail content.
static com.google.common.base.Optional<CmsResource>	CmsDetailOnlyContainerUtil.getDetailOnlyResource(CmsObject cms, String contentLocale, CmsResource detailContentRes, CmsResource pageRes)	Gets the detail only resource for a given detail content and locale.
static List<CmsResource>	CmsDetailOnlyContainerUtil.getDetailOnlyResources(CmsObject cms, CmsResource resource)	Returns a list of detail only container pages associated with the given resource.
List<CmsResource>	CmsDetailOnlyContainerPageBuilder.ContainerInfo.getResources()	Gets the container element resources.
List<CmsResource>	CmsRelationTargetListBean.getResources()	Gets the list of resources which have been added.

Methods in org.opencms.ade.containerpage with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsRelationTargetListBean.add(CmsResource resource)	Adds a new resource.
void	CmsDetailOnlyContainerPageBuilder.addContainerElement(String name, CmsResource resource)	Adds a resource to a container as an element.
void	CmsDetailOnlyContainerPageBuilder.ContainerInfo.addResource(CmsResource resource)	Adds a container element resource.
static String	CmsDetailOnlyContainerUtil.getDetailContainerLocale(CmsObject cms, String contentLocale, CmsResource resource)	Returns the detail container resource locale appropriate for the given detail page.
static com.google.common.base.Optional<CmsResource>	CmsDetailOnlyContainerUtil.getDetailOnlyPage(CmsObject cms, CmsResource detailContent, String contentLocale)	Gets the detail only page for a detail content.
static String	CmsDetailOnlyContainerUtil.getDetailOnlyPageName(CmsObject cms, CmsResource pageResource, String detailPath, String locale)	Returns the site/root path to the detail only container page, for site/root path of the detail content.
static com.google.common.base.Optional<CmsResource>	CmsDetailOnlyContainerUtil.getDetailOnlyResource(CmsObject cms, String contentLocale, CmsResource detailContentRes, CmsResource pageRes)	Gets the detail only resource for a given detail content and locale.
static List<CmsResource>	CmsDetailOnlyContainerUtil.getDetailOnlyResources(CmsObject cms, CmsResource resource)	Returns a list of detail only container pages associated with the given resource.
CmsContainerElementData	CmsElementUtil.getElementData(CmsResource page, CmsContainerElementBean element, Collection<CmsContainer> containers)	Returns the data for an element.
CmsElementSettingsConfig	CmsElementUtil.getElementSettingsConfig(CmsResource page, CmsContainerElementBean element, String containerId, Collection<CmsContainer> containers)	Returns the formatter and settings config data for an element.
static Set<CmsUUID>	CmsElementUtil.getPageAndDetailOnlyIds(CmsObject cms, CmsUUID pageId, CmsResource detailContent)	Gets the ids for the current page and potentially detail-only containers.
static boolean	CmsContainerpageService.isEditingModelGroups(CmsObject cms, CmsResource containerPage)	Checks whether the current page is a model group page.
static boolean	CmsModelGroupHelper.isModelGroupResource(CmsResource resource)	Returns if the given resource is a model group resource.
static CmsXmlContainerPage	CmsDetailOnlyContainerUtil.saveDetailOnlyPage(CmsObject cms, CmsResource content, String locale, CmsContainerPageBean page)	Saves a detail-only page for a content.
CmsContainerPageBean	CmsModelGroupHelper.saveModelGroups(CmsContainerPageBean page, CmsResource pageResource)	Saves the model groups of the given container page.
static boolean	CmsModelGroupHelper.updateModelGroupResource(CmsObject cms, CmsResource group, String baseContainerName)	Updates a model group resource to the changed data structure.

Method parameters in org.opencms.ade.containerpage with type arguments of type CmsResource

Modifier and Type	Method	Description
static List<CmsModelResourceInfo>	CmsContainerpageService.generateModelResourceList(CmsObject cms, String resourceType, List<CmsResource> modelResources, Locale contentLocale)	Generates the model resource data list.

Uses of CmsResource in org.opencms.ade.containerpage.inherited

Methods in org.opencms.ade.containerpage.inherited that return CmsResource

Modifier and Type	Method	Description
static CmsResource	CmsInheritanceGroupUtils.getInheritanceGroupContentByName(CmsObject cms, String name)	Finds the inheritance group content with a given internal name.
CmsResource	CmsInheritanceReference.getResource()	Gets the reference resource.

Methods in org.opencms.ade.containerpage.inherited with parameters of type CmsResource

Modifier and Type	Method	Description
static Set<String>	CmsInheritanceGroupUtils.getNamesOfGroupsContainingResource(CmsObject cms, CmsResource inheritanceConfig, CmsResource target)	Parses an inheritance group configuration C and returns the names of inheritance groups in C in which a given resource is defined as a new element.
protected Map<String,CmsXmlContentProperty>	CmsContainerConfigurationWriter.getSettingConfiguration(CmsObject cms, CmsResource resource)	Gets the setting configuration of an element.
void	CmsContainerConfigurationParser.parse(CmsResource resource)	Parses the contents of a resource.
void	CmsInheritanceReferenceParser.parse(CmsResource resource)	Parses a given resource.
void	CmsContainerConfigurationCache.remove(CmsResource resource)
void	CmsContainerConfigurationWriter.save(CmsObject cms, String name, boolean newOrdering, CmsResource pageResource, List<CmsContainerElementBean> elements)	Saves a list of container element beans to a file in the VFS.
void	CmsContainerConfigurationGroup.setResource(CmsResource configResource)	Initializes the information about the resource from which this configuration was read.
void	CmsContainerConfigurationCache.update(CmsResource resource)

Method parameters in org.opencms.ade.containerpage.inherited with type arguments of type CmsResource

Modifier and Type	Method	Description
protected Map<CmsUUID,CmsContainerConfigurationGroup>	CmsContainerConfigurationCache.load(Collection<CmsResource> resources)	Loads the inheritance groups from a list of resources.

Constructors in org.opencms.ade.containerpage.inherited with parameters of type CmsResource

Modifier	Constructor	Description
	CmsInheritanceReference(String name, String title, String description, CmsResource res, Locale locale)	Creates a new instance.

Uses of CmsResource in org.opencms.ade.contenteditor

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

Modifier and Type	Method	Description
protected String	CmsContentService.getFileEncoding(CmsObject cms, CmsResource file)	Helper method to determine the encoding of the given file in the VFS, which must be set using the "content-encoding" property.

Uses of CmsResource in org.opencms.ade.detailpage

Methods in org.opencms.ade.detailpage that return CmsResource

Modifier and Type	Method	Description
static CmsResource	CmsDetailPageResourceHandler.getDetailFunctionPage(javax.servlet.ServletRequest req)	Returns the detail function page resource, if available.
static CmsResource	CmsDetailPageResourceHandler.getDetailResource(javax.servlet.ServletRequest req)	Returns the current detail content resource, or null if this is not a request to a content detail page.
CmsResource	CmsDetailPageResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
static CmsResource	CmsDetailPageUtil.lookupPage(CmsObject cms, String uri)	Looks up a page by URI (which may be a detail page URI, or a normal VFS uri).

Methods in org.opencms.ade.detailpage with parameters of type CmsResource

Modifier and Type	Method	Description
static List<String>	CmsDetailPageUtil.getAllDetailPagesWithUrlName(CmsObject cms, CmsResource res)	Gets a list of detail page URIs for the given resource, with its URL name appended.
CmsResource	CmsDetailPageResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
boolean	CmsDefaultDetailPageHandler.isValidDetailPage(CmsObject cms, CmsResource page, CmsResource detailRes)	Checks whether the given detail page is valid for the given resource.
protected boolean	CmsDetailPageResourceHandler.isValidDetailPage(CmsObject cms, CmsResource page, CmsResource detailRes)	Checks whether the given detail page is valid for the given resource.
boolean	CmsPermissiveDetailPageHandler.isValidDetailPage(CmsObject cms, CmsResource page, CmsResource detailRes)	Checks whether the given detail page is valid for the given resource.
boolean	I_CmsDetailPageHandler.isValidDetailPage(CmsObject cms, CmsResource page, CmsResource detailRes)	Checks whether the given detail page is valid for the given resource.

Constructors in org.opencms.ade.detailpage with parameters of type CmsResource

Modifier	Constructor	Description
	CmsDetailPageConfigurationWriter(CmsObject cms, CmsResource res)	Creates a new detail page configuration writer.
	CmsDetailPageFilter(CmsObject cms, CmsResource resource)	Creates a new instance based on an actual detail resource.

Uses of CmsResource in org.opencms.ade.galleries

Methods in org.opencms.ade.galleries that return types with arguments of type CmsResource

Modifier and Type	Method	Description
protected List<CmsResource>	A_CmsTreeTabDataPreloader.getChildren(CmsResource resource)	Gets the children of a resource.
protected List<CmsResource>	CmsGalleryService.CmsGalleryTypeInfo.getGalleries()	Returns the gallery folder resources.
protected List<CmsResource>	CmsGalleryService.getSitemapSubEntryResources(String rootPath)	Gets the sitemap sub entries for a given path as resources.
protected List<CmsResource>	CmsGalleryService.readAll(Collection<CmsUUID> structureIds, CmsResourceFilter filter)	Reads the resources for a collection of structure ids and returns the list of resources which could be read.

Methods in org.opencms.ade.galleries with parameters of type CmsResource

Modifier and Type	Method	Description
protected abstract T	A_CmsTreeTabDataPreloader.createEntry(CmsObject cms, CmsResource resource)	Creates a tree entry bean from a resource.
protected List<CmsResource>	A_CmsTreeTabDataPreloader.getChildren(CmsResource resource)	Gets the children of a resource.
static String	CmsPreviewService.getPreviewContent(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, CmsObject cms, CmsResource resource, Locale locale)	Renders the preview content for the given resource and locale.
static CmsVfsEntryBean	CmsGalleryService.internalCreateVfsEntryBean(CmsObject cms, CmsResource resource, String title, boolean isRoot, boolean isEditable, List<CmsVfsEntryBean> children, boolean isMatch)	Creates the VFS entry bean for a resource.
protected boolean	CmsGalleryService.isSitemapEntry(CmsObject cms, CmsResource resource)	Checks whether a given resource is a sitemap entry.
static CmsPoint	CmsPreviewService.readFocalPoint(CmsObject cms, CmsResource resource)	Reads the focal point from a resource.
void	CmsPreviewService.readResourceInfo(CmsObject cms, CmsResource resource, CmsResourceInfoBean resInfo, String locale)	Retrieves the resource information and puts it into the provided resource info bean.

Method parameters in org.opencms.ade.galleries with type arguments of type CmsResource

Modifier and Type	Method	Description
protected void	A_CmsTreeTabDataPreloader.findRoot(Collection<CmsResource> resources)	Finds the common root folder for a collection of resources.
protected String	A_CmsTreeTabDataPreloader.getCommonSite(Collection<CmsResource> resourceSet)	Gets the common site root of a set of resources.
T	A_CmsTreeTabDataPreloader.preloadData(CmsObject cms, Set<CmsResource> openResources, Set<CmsResource> selectedResources)	Creates the preload data for a collection of resources which correspond to "opened" tree items.
protected void	CmsGalleryService.CmsGalleryTypeInfo.setGalleries(List<CmsResource> galleries)	Sets the galleries.

Constructor parameters in org.opencms.ade.galleries with type arguments of type CmsResource

Modifier	Constructor	Description
protected	CmsGalleryTypeInfo(I_CmsResourceType resourceType, I_CmsResourceType contentType, List<CmsResource> galleries)	Constructor.
	TypeEntry(String type, List<CmsResource> resources, Map<CmsUUID,String> titleReplacements, String origin)	Creates a new entry.

Uses of CmsResource in org.opencms.ade.publish

Methods in org.opencms.ade.publish that return types with arguments of type CmsResource

Modifier and Type	Method	Description
protected List<CmsResource>	CmsCollectorPublishListHelper.computeCollectorResults(boolean online)	Computes the collector results.
Set<CmsResource>	CmsPublishRelationFinder.ResourceMap.get(Object res)
Set<CmsResource>	CmsDummyRelatedResourceProvider.getAdditionalRelatedResources(CmsObject cms, CmsResource res)
Set<CmsResource>	I_CmsPublishRelatedResourceProvider.getAdditionalRelatedResources(CmsObject cms, CmsResource res)	Gets the set of additional related resources.
Set<CmsResource>	CmsCollectorPublishListHelper.getPublishListFiles()	Gets the list to add to the publish list for the collector list.
Set<CmsResource>	CmsDefaultCollectorPublishListProvider.getPublishResources(CmsObject cms, I_CmsContentLoadCollectorInfo info)
Set<CmsResource>	CmsPublish.ResourcesAndRelated.getRelatedResources()	Returns the related resources.
List<CmsResource>	CmsCurrentPageProject.getResources(CmsObject cms, Map<String,String> params, String workflowId)
List<CmsResource>	CmsDirectPublishProject.getResources(CmsObject cms, Map<String,String> params, String workflowId)
List<CmsResource>	CmsMyChangesProject.getResources(CmsObject cms, Map<String,String> params, String workflowId)
Set<CmsResource>	CmsPublish.ResourcesAndRelated.getResources()	Returns the resources.
List<CmsResource>	CmsRealProjectVirtualWrapper.getResources(CmsObject cms, Map<String,String> params, String workflowId)
List<CmsResource>	I_CmsVirtualProject.getResources(CmsObject cms, Map<String,String> params, String workflowId)	Gets the resources of the virtual project.

Methods in org.opencms.ade.publish with parameters of type CmsResource

Modifier and Type	Method	Description
boolean	CmsPublish.ResourcesAndRelated.contains(CmsResource resource)	Checks if the given resource is present in at least one of the sets.
Set<CmsResource>	CmsDummyRelatedResourceProvider.getAdditionalRelatedResources(CmsObject cms, CmsResource res)
Set<CmsResource>	I_CmsPublishRelatedResourceProvider.getAdditionalRelatedResources(CmsObject cms, CmsResource res)	Gets the set of additional related resources.
protected CmsPublishResource	CmsPublish.resourceToBean(CmsResource resource, CmsPublishResourceInfo info, boolean removable, List<CmsPublishResource> related)	Creates a publish resource bean instance from the given parameters.

Method parameters in org.opencms.ade.publish with type arguments of type CmsResource

Modifier and Type	Method	Description
protected void	CmsPublishService.addSiblings(Set<CmsResource> publishResources)	Adds siblings to a set of publish resources.
protected void	CmsDirectPublishProject.addSubResources(CmsObject cms, Set<CmsResource> resources)	Adds contents of folders to a list of resources.
CmsPublishRelationFinder.ResourceMap	CmsPublishRelationFinder.ResourceMap.filter(com.google.common.base.Predicate<CmsResource> pred)	Creates a new resource map based on this instance while filtering some elements out.
List<CmsPublishResource>	CmsPublish.getBrokenResources(List<CmsResource> pubResources)	Checks for possible broken links when the given list of resources would be published.
void	CmsPublish.publishResources(List<CmsResource> resources)	Publishes the given list of resources.

Constructor parameters in org.opencms.ade.publish with type arguments of type CmsResource

Modifier	Constructor	Description
	CmsPublishRelationFinder(CmsObject cms, Collection<CmsResource> resources, boolean keepOriginalUnchangedResources, I_CmsPublishRelatedResourceProvider relProvider)	Creates a new instance.

Uses of CmsResource in org.opencms.ade.sitemap

Methods in org.opencms.ade.sitemap that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsModelPageHelper.createModelGroupPage(String name, String description, CmsUUID copyId)	Creates a new model group page.
CmsResource	CmsModelPageHelper.createPageInModelFolder(String name, String description, CmsUUID copyId)	Creates a new potential model page in the default folder for new model pages.
CmsResource	CmsModelPageHelper.ensureModelFolder(CmsResource rootResource)	Tries to either read or create the default folder for model pages in the current sitemap, and returns it.

Methods in org.opencms.ade.sitemap with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsModelPageHelper.addModelPageToSitemapConfiguration(CmsResource sitemapConfig, CmsResource modelPage, boolean disabled)	Adds a model page to the sitemap config.
void	CmsModelPageHelper.disableModelPage(CmsResource sitemapConfig, CmsUUID structureId, boolean disabled)	Disables the given model page.
protected CmsVfsSitemapService.LockInfo	CmsVfsSitemapService.ensureLockAndGetInfo(CmsResource resource)	Locks the given resource with a temporary, if not already locked by the current user.
CmsResource	CmsModelPageHelper.ensureModelFolder(CmsResource rootResource)	Tries to either read or create the default folder for model pages in the current sitemap, and returns it.
void	CmsModelPageHelper.removeModelPage(CmsResource sitemapConfig, CmsUUID structureId)	Removes a model page from the sitemap configuration.

Constructors in org.opencms.ade.sitemap with parameters of type CmsResource

Modifier	Constructor	Description
	CmsModelPageHelper(CmsObject cms, CmsResource rootResource)	Creates a new instance.
	CmsSitemapNavPosCalculator(List<CmsJspNavElement> navigation, CmsResource movedElement, int insertPosition)	Creates a new sitemap navigation position calculator and performs the navigation position calculation for a given insertion operation.

Uses of CmsResource in org.opencms.cache

Methods in org.opencms.cache with parameters of type CmsResource

Modifier and Type	Method	Description
String	CmsVfsNameBasedDiskCache.getCacheName(CmsResource resource, String parameters)	Returns the RFS name to use for caching the given VFS resource with parameters in the disk cache.
protected abstract void	CmsVfsCache.uncacheResource(CmsResource resource)	Removes a cached resource from the cache.
protected void	CmsVfsMemoryObjectCache.uncacheResource(CmsResource resource)

Method parameters in org.opencms.cache with type arguments of type CmsResource

Modifier and Type	Method	Description
protected void	CmsVfsCache.uncacheResources(List<CmsResource> resources)	Removes a bunch of cached resources from the cache.

Uses of CmsResource in org.opencms.cmis

Methods in org.opencms.cmis that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsCmisRelationHelper.RelationKey.getSource()	Gets the source resource of the relation.

Methods in org.opencms.cmis with parameters of type CmsResource

Modifier and Type	Method	Description
static void	CmsCmisUtil.addDynamicProperties(CmsObject cms, CmsCmisTypeManager typeManager, org.apache.chemistry.opencmis.commons.impl.dataobjects.PropertiesImpl props, String typeId, CmsResource resource, Set<String> filter)	Helper method to add the dynamic properties for a resource.
protected org.apache.chemistry.opencmis.commons.data.Acl	CmsCmisRelationHelper.collectAcl(CmsObject cms, CmsResource resource, boolean onlyBasic)	Compiles the ACL for a relation.
protected org.apache.chemistry.opencmis.commons.data.Acl	CmsCmisResourceHelper.collectAcl(CmsObject cms, CmsResource resource, boolean onlyBasic)	Compiles the ACL for a file or folder.
protected org.apache.chemistry.opencmis.commons.data.AllowableActions	CmsCmisRelationHelper.collectAllowableActions(CmsObject cms, CmsResource file, CmsRelation relation)	Collects the allowable actions for a relation.
protected org.apache.chemistry.opencmis.commons.data.AllowableActions	CmsCmisResourceHelper.collectAllowableActions(CmsObject cms, CmsResource file)	Compiles the allowable actions for a file or folder.
protected org.apache.chemistry.opencmis.commons.data.ObjectData	CmsCmisRelationHelper.collectObjectData(CmsCmisCallContext context, CmsObject cms, CmsResource resource, CmsRelation relation, Set<String> filter, boolean includeAllowableActions, boolean includeAcl)	Fills in an ObjectData record.
protected org.apache.chemistry.opencmis.commons.data.ObjectData	CmsCmisResourceHelper.collectObjectData(CmsCmisCallContext context, CmsObject cms, CmsResource resource, Set<String> filter, String renditionFilter, boolean includeAllowableActions, boolean includeAcl, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships)	Fills in an ObjectData record.
protected org.apache.chemistry.opencmis.commons.data.Properties	CmsCmisRelationHelper.collectProperties(CmsObject cms, CmsResource resource, CmsRelation relation, Set<String> orgfilter, org.apache.chemistry.opencmis.commons.impl.server.ObjectInfoImpl objectInfo)	Gathers all base properties of a file or folder.
protected org.apache.chemistry.opencmis.commons.data.Properties	CmsCmisResourceHelper.collectProperties(CmsObject cms, CmsResource resource, Set<String> orgfilter, org.apache.chemistry.opencmis.commons.impl.server.ObjectInfoImpl objectInfo)	Gathers all base properties of a file or folder.
protected List<org.apache.chemistry.opencmis.commons.data.RenditionData>	CmsCmisResourceHelper.collectRenditions(CmsObject cms, CmsResource resource, String renditionFilterString, org.apache.chemistry.opencmis.commons.impl.server.ObjectInfoImpl objectInfo)	Collects renditions for a resource.
static boolean	CmsCmisUtil.ensureLock(CmsObject cms, CmsResource resource)	Tries to lock a resource and throws an exception if it can't be locked.
byte[]	I_CmsCmisRenditionProvider.getContent(CmsObject cms, CmsResource resource)	Gets the rendition content stream for the resource.
String	I_CmsPropertyProvider.getPropertyValue(CmsObject cms, CmsResource resource)	Reads the property value.
protected List<org.apache.chemistry.opencmis.commons.data.ObjectData>	CmsCmisRepository.getRelationshipObjectData(CmsCmisCallContext context, CmsObject cms, CmsResource resource, org.apache.chemistry.opencmis.commons.enums.RelationshipDirection relationshipDirection, Set<String> filterSet, boolean includeAllowableActions)	Gets the relationship data for a given resource.
org.apache.chemistry.opencmis.commons.data.RenditionData	I_CmsCmisRenditionProvider.getRendition(CmsObject cms, CmsResource resource)	Gets the rendition data for a resource.
static boolean	CmsCmisUtil.hasChildren(CmsObject cms, CmsResource resource)	Checks whether the given resource has any children.
void	I_CmsPropertyProvider.setPropertyValue(CmsObject cms, CmsResource resource, String valueToSet)	Writes the property value.

Uses of CmsResource in org.opencms.db

Methods in org.opencms.db that return CmsResource

Modifier and Type	Method	Description
protected CmsResource	CmsPublishList.checkContainsSubResources(CmsObject cms, List<CmsResource> folders)	Checks whether the publish list contains all sub-resources of a list of folders.
CmsResource	CmsDriverManager.createResource(CmsDbContext dbc, String resourcename, int type, byte[] content, List<CmsProperty> properties)	Creates a new resource of the given resource type with the provided content and properties.
CmsResource	CmsDriverManager.createResource(CmsDbContext dbc, String resourcePath, CmsResource resource, byte[] content, List<CmsProperty> properties, boolean importCase)	Creates a new resource with the provided content and properties.
CmsResource	CmsSecurityManager.createResource(CmsRequestContext context, String resourcename, int type, byte[] content, List<CmsProperty> properties)	Creates a new resource of the given resource type with the provided content and properties.
CmsResource	CmsSecurityManager.createResource(CmsRequestContext context, String resourcePath, CmsResource resource, byte[] content, List<CmsProperty> properties)	Creates a new resource with the provided content and properties.
CmsResource	I_CmsVfsDriver.createResource(ResultSet res, CmsUUID projectId)	Creates a CmsResource instance from a JDBC ResultSet.
CmsResource	I_CmsVfsDriver.createResource(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, byte[] content)	Creates a new resource from a given CmsResource object.
CmsResource	CmsDriverManager.createSibling(CmsDbContext dbc, CmsResource source, String destination, List<CmsProperty> properties)	Creates a new sibling of the source resource.
CmsResource	CmsSecurityManager.createSibling(CmsRequestContext context, CmsResource source, String destination, List<CmsProperty> properties)	Creates a new sibling of the source resource.
CmsResource	CmsSecurityManager.importResource(CmsRequestContext context, String resourcePath, CmsResource resource, byte[] content, List<CmsProperty> properties, boolean importCase)	Creates a new resource with the provided content and properties.
CmsResource	CmsUserTrackingResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
CmsResource	CmsDriverManager.readDefaultFile(CmsDbContext dbc, CmsResource resource, CmsResourceFilter resourceFilter)	Returns the default file for the given folder.
CmsResource	CmsSecurityManager.readDefaultFile(CmsRequestContext context, CmsResource resource, CmsResourceFilter resourceFilter)	Returns the default file for the given folder.
CmsResource	CmsDriverManager.readParentFolder(CmsDbContext dbc, CmsUUID structureId)	Reads the parent folder to a given structure id.
CmsResource	CmsSecurityManager.readParentFolder(CmsRequestContext context, CmsUUID structureId)	Returns the parent folder to the given structure id.
CmsResource	CmsDriverManager.readResource(CmsDbContext dbc, String resourcePath, CmsResourceFilter filter)	Reads a resource from the VFS, using the specified resource filter.
CmsResource	CmsDriverManager.readResource(CmsDbContext dbc, CmsUUID structureID, CmsResourceFilter filter)	Reads a resource from the VFS, using the specified resource filter.
protected CmsResource	CmsSecurityManager.readResource(CmsDbContext dbc, String resourcePath, CmsResourceFilter filter)	Reads a resource from the OpenCms VFS, using the specified resource filter.
protected CmsResource	CmsSecurityManager.readResource(CmsDbContext dbc, CmsUUID structureID, CmsResourceFilter filter)	Reads a resource from the OpenCms VFS, using the specified resource filter.
CmsResource	CmsSecurityManager.readResource(CmsRequestContext context, String resourcePath, CmsResourceFilter filter)	Reads a resource from the VFS, using the specified resource filter.
CmsResource	CmsSecurityManager.readResource(CmsRequestContext context, CmsUUID structureID, CmsResourceFilter filter)	Reads a resource from the VFS, using the specified resource filter.
CmsResource	I_CmsVfsDriver.readResource(CmsDbContext dbc, CmsUUID projectId, String filename, boolean includeDeleted)	Reads a resource specified by it's resource name.
CmsResource	I_CmsVfsDriver.readResource(CmsDbContext dbc, CmsUUID projectId, CmsUUID structureId, boolean includeDeleted)	Reads a resource specified by it's structure ID.

Methods in org.opencms.db that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsDriverManager.changeResourcesInFolderWithProperty(CmsDbContext dbc, CmsResource resource, String propertyDefinition, String oldValue, String newValue, boolean recursive)	Returns a list with all sub resources of a given folder that have set the given property, matching the current property's value with the given old value and replacing it by a given new value.
List<CmsResource>	CmsSecurityManager.changeResourcesInFolderWithProperty(CmsRequestContext context, CmsResource resource, String propertyDefinition, String oldValue, String newValue, boolean recursive)	Returns a list with all sub resources of a given folder that have set the given property, matching the current property's value with the given old value and replacing it by a given new value.
List<CmsResource>	CmsPublishList.getAllResources()	Returns a list of all resources in the publish list, including folders and files.
List<CmsResource>	CmsPublishList.getDeletedFolderList()	Returns a list of folder resources with the deleted state.
List<CmsResource>	CmsPublishList.getDirectPublishResources()	Returns the list of resources that should be published for a "direct" publish operation.
List<CmsResource>	CmsPublishList.getFileList()	Returns an unmodifiable list of the files in this publish list.
List<CmsResource>	CmsPublishList.getFolderList()	Returns an unmodifiable list of the new/changed folders in this publish list.
List<CmsResource>	CmsImportFolder.getImportedResources()	Returns the list of imported resources.
List<CmsResource>	CmsDriverManager.getLockedResourcesObjects(CmsDbContext dbc, CmsResource resource, CmsLockFilter filter)	Returns all locked resources in a given folder.
List<CmsResource>	CmsSecurityManager.getLockedResourcesObjects(CmsRequestContext context, CmsResource resource, CmsLockFilter filter)	Returns all locked resources in a given folder.
List<CmsResource>	CmsDriverManager.getLockedResourcesObjectsWithCache(CmsDbContext dbc, CmsResource resource, CmsLockFilter filter, Map<String,CmsResource> cache)	Returns all locked resources in a given folder, but uses a cache for resource lookups.
List<CmsResource>	CmsSecurityManager.getLockedResourcesObjectsWithCache(CmsRequestContext context, CmsResource resource, CmsLockFilter filter, Map<String,CmsResource> cache)	Returns all locked resources in a given folder, but uses a cache for resource lookups.
protected List<CmsResource>	CmsSecurityManager.getManageableResources(CmsDbContext dbc, CmsRole role)	Returns all resources of organizational units for which the current user has the given role role.
List<CmsResource>	CmsSecurityManager.getManageableResources(CmsRequestContext context, CmsRole role)	Returns all resources of organizational units for which the current user has the given role role.
protected List<CmsResource>	CmsPublishList.getMissingSubResources(CmsObject cms, List<CmsResource> folders)	Gets the sub-resources of a list of folders which are missing from the publish list.
protected List<CmsResource>	CmsPublishList.getMovedFolders(CmsObject cms)	Internal method to get the moved folders from the publish list.
List<CmsResource>	CmsDriverManager.getResourcesForOrganizationalUnit(CmsDbContext dbc, CmsOrganizationalUnit orgUnit)	Returns all resources of the given organizational unit.
List<CmsResource>	CmsSecurityManager.getResourcesForOrganizationalUnit(CmsRequestContext context, CmsOrganizationalUnit orgUnit)	Returns all resources of the given organizational unit.
List<CmsResource>	I_CmsUserDriver.getResourcesForOrganizationalUnit(CmsDbContext dbc, CmsOrganizationalUnit orgUnit)	Returns all resources of the given organizational unit.
Set<CmsResource>	CmsDriverManager.getResourcesForPrincipal(CmsDbContext dbc, CmsProject project, CmsUUID principalId, CmsPermissionSet permissions, boolean includeAttr)	Returns all resources associated to a given principal via an ACE with the given permissions.
Set<CmsResource>	CmsSecurityManager.getResourcesForPrincipal(CmsRequestContext context, CmsUUID principalId, CmsPermissionSet permissions, boolean includeAttr)	Returns all resources associated to a given principal via an ACE with the given permissions.
protected List<CmsResource>	CmsPublishList.getTopFolders(List<CmsResource> folders)	Gives the "roots" of a list of folders, i.e.
List<CmsResource>	CmsPublishList.getTopMovedFolders(CmsObject cms)	Gets the list of moved folders which are not subfolders of other moved folders in the publish list.
List<CmsResource>	CmsDriverManager.getUsersPubList(CmsDbContext dbc, CmsUUID userId)	Returns the given user's publish list.
List<CmsResource>	CmsSecurityManager.getUsersPubList(CmsRequestContext context)	Returns the current user's publish list.
List<CmsResource>	I_CmsProjectDriver.getUsersPubList(CmsDbContext dbc, CmsUUID userId)	Returns the given user's publish list.
List<CmsResource>	CmsDriverManager.readAllSubscribedResources(CmsDbContext dbc, String poolName, CmsPrincipal principal)	Returns all resources subscribed by the given user or group.
List<CmsResource>	CmsSecurityManager.readAllSubscribedResources(CmsRequestContext context, String poolName, CmsPrincipal principal)	Returns all resources subscribed by the given user or group.
List<CmsResource>	CmsSubscriptionManager.readAllSubscribedResources(CmsObject cms, CmsPrincipal principal)	Returns all resources subscribed by the given user or group.
List<CmsResource>	I_CmsSubscriptionDriver.readAllSubscribedResources(CmsDbContext dbc, String poolName, CmsPrincipal principal)	Returns all resources subscribed by the given user or group.
List<CmsResource>	CmsDriverManager.readChildResources(CmsDbContext dbc, CmsResource resource, CmsResourceFilter filter, boolean getFolders, boolean getFiles, boolean checkPermissions)	Returns the child resources of a resource, that is the resources contained in a folder.
List<CmsResource>	CmsSecurityManager.readChildResources(CmsRequestContext context, CmsResource resource, CmsResourceFilter filter, boolean getFolders, boolean getFiles)	Returns the child resources of a resource, that is the resources contained in a folder.
List<CmsResource>	I_CmsVfsDriver.readChildResources(CmsDbContext dbc, CmsProject currentProject, CmsResource resource, boolean getFolders, boolean getFiles)	Reads all child-files and/or child-folders of a specified parent resource.
List<CmsResource>	CmsDriverManager.readPath(CmsDbContext dbc, String path, CmsResourceFilter filter)	Builds a list of resources for a given path.
List<CmsResource>	CmsSecurityManager.readPath(CmsRequestContext context, String path, CmsResourceFilter filter)	Builds a list of resources for a given path.
List<CmsResource>	CmsDriverManager.readProjectView(CmsDbContext dbc, CmsUUID projectId, CmsResourceState state)	Reads all resources of a project that match a given state from the VFS.
List<CmsResource>	CmsSecurityManager.readProjectView(CmsRequestContext context, CmsUUID projectId, CmsResourceState state)	Reads all resources of a project that match a given state from the VFS.
List<CmsResource>	CmsDriverManager.readResources(CmsDbContext dbc, CmsResource parent, CmsResourceFilter filter, boolean readTree)	Reads all resources below the given path matching the filter criteria, including the full tree below the path only in case the readTree parameter is true.
List<CmsResource>	CmsSecurityManager.readResources(CmsRequestContext context, CmsResource parent, CmsResourceFilter filter, boolean readTree)	Reads all resources below the given path matching the filter criteria, including the full tree below the path only in case the readTree parameter is true.
List<CmsResource>	I_CmsVfsDriver.readResources(CmsDbContext dbc, CmsUUID currentProject, CmsResourceState state, int mode)	Reads all resources inside a given project and with a given state.
List<CmsResource>	I_CmsVfsDriver.readResourcesForPrincipalACE(CmsDbContext dbc, CmsProject project, CmsUUID principalId)	Returns all resources associated to a given principal via an ACE.
List<CmsResource>	I_CmsVfsDriver.readResourcesForPrincipalAttr(CmsDbContext dbc, CmsProject project, CmsUUID principalId)	Returns all resources associated to a given principal through some of following attributes.
List<CmsResource>	CmsDriverManager.readResourcesVisitedBy(CmsDbContext dbc, String poolName, CmsVisitedByFilter filter)	Returns the resources that were visited by a user set in the filter.
List<CmsResource>	CmsSecurityManager.readResourcesVisitedBy(CmsRequestContext context, String poolName, CmsVisitedByFilter filter)	Returns the resources that were visited by a user set in the filter.
List<CmsResource>	CmsSubscriptionManager.readResourcesVisitedBy(CmsObject cms, CmsVisitedByFilter filter)	Returns the resources that were visited by a user set in the filter.
List<CmsResource>	I_CmsSubscriptionDriver.readResourcesVisitedBy(CmsDbContext dbc, String poolName, CmsVisitedByFilter filter)	Returns the resources that were visited by a user set in the filter.
List<CmsResource>	CmsDriverManager.readResourcesWithProperty(CmsDbContext dbc, CmsResource folder, String propertyDefinition, String value, CmsResourceFilter filter)	Reads all resources that have a value (containing the given value string) set for the specified property (definition) in the given path.
List<CmsResource>	CmsSecurityManager.readResourcesWithProperty(CmsRequestContext context, CmsResource folder, String propertyDefinition, String value, CmsResourceFilter filter)	Reads all resources that have a value (containing the specified value) set for the specified property (definition) in the given path.
List<CmsResource>	I_CmsVfsDriver.readResourcesWithProperty(CmsDbContext dbc, CmsUUID projectId, CmsUUID propertyDefinition, String path, String value)	Reads all resources that have a value (containing the specified value) set for the specified property (definition), in the given path.
List<CmsResource>	I_CmsVfsDriver.readResourceTree(CmsDbContext dbc, CmsUUID projectId, String parent, int type, CmsResourceState state, long startTime, long endTime, long releasedAfter, long releasedBefore, long expiredAfter, long expiredBefore, int mode)	Reads all resources inside a given project matching the criteria specified by parameter values.
List<CmsResource>	CmsDriverManager.readSiblings(CmsDbContext dbc, CmsResource resource, CmsResourceFilter filter)	Returns a List of all siblings of the specified resource, the specified resource being always part of the result set.
List<CmsResource>	CmsSecurityManager.readSiblings(CmsRequestContext context, CmsResource resource, CmsResourceFilter filter)	Returns a List of all siblings of the specified resource, the specified resource being always part of the result set.
List<CmsResource>	I_CmsVfsDriver.readSiblings(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, boolean includeDeleted)	Reads all siblings that point to the resource record of a specified resource.
List<CmsResource>	CmsDriverManager.readSubscribedResources(CmsDbContext dbc, String poolName, CmsSubscriptionFilter filter)	Returns the resources that were subscribed by a user or group set in the filter.
List<CmsResource>	CmsSecurityManager.readSubscribedResources(CmsRequestContext context, String poolName, CmsSubscriptionFilter filter)	Returns the resources that were subscribed by a user or group set in the filter.
List<CmsResource>	CmsSubscriptionManager.readSubscribedResources(CmsObject cms, CmsSubscriptionFilter filter)	Returns the resources that were subscribed by a user or group set in the filter.
List<CmsResource>	I_CmsSubscriptionDriver.readSubscribedResources(CmsDbContext dbc, String poolName, CmsSubscriptionFilter filter)	Returns the resources that were subscribed by a user or group set in the filter.

Methods in org.opencms.db with parameters of type CmsResource

Modifier and Type	Method	Description
protected void	CmsPublishList.add(CmsResource resource, boolean check)	Adds a new/changed Cms folder resource to the publish list.
void	CmsDriverManager.addRelationToResource(CmsDbContext dbc, CmsResource resource, CmsResource target, CmsRelationType type, boolean importCase)	Adds a new relation to the given resource.
void	CmsSecurityManager.addRelationToResource(CmsRequestContext context, CmsResource resource, CmsResource target, CmsRelationType type, boolean importCase)	Adds a new relation to a given resource.
void	I_CmsUserDriver.addResourceToOrganizationalUnit(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, CmsResource resource)	Adds a resource to the given organizational unit.
void	CmsDriverManager.addResourceToOrgUnit(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, CmsResource resource)	Adds a resource to the given organizational unit.
void	CmsSecurityManager.addResourceToOrgUnit(CmsRequestContext context, CmsOrganizationalUnit orgUnit, CmsResource resource)	Adds a resource to the given organizational unit.
void	CmsDriverManager.changeLock(CmsDbContext dbc, CmsResource resource, CmsLockType lockType)	Changes the lock of a resource to the current user, that is "steals" the lock from another user.
void	CmsSecurityManager.changeLock(CmsRequestContext context, CmsResource resource)	Changes the lock of a resource to the current user, that is "steals" the lock from another user.
List<CmsResource>	CmsDriverManager.changeResourcesInFolderWithProperty(CmsDbContext dbc, CmsResource resource, String propertyDefinition, String oldValue, String newValue, boolean recursive)	Returns a list with all sub resources of a given folder that have set the given property, matching the current property's value with the given old value and replacing it by a given new value.
List<CmsResource>	CmsSecurityManager.changeResourcesInFolderWithProperty(CmsRequestContext context, CmsResource resource, String propertyDefinition, String oldValue, String newValue, boolean recursive)	Returns a list with all sub resources of a given folder that have set the given property, matching the current property's value with the given old value and replacing it by a given new value.
protected void	CmsSecurityManager.checkPermissions(CmsDbContext dbc, CmsResource resource, CmsPermissionSet requiredPermissions, boolean checkLock, CmsResourceFilter filter)	Performs a blocking permission check on a resource.
protected void	CmsSecurityManager.checkPermissions(CmsDbContext dbc, CmsResource resource, CmsPermissionSet requiredPermissions, I_CmsPermissionHandler.LockCheck checkLock, CmsResourceFilter filter)	Performs a blocking permission check on a resource.
void	CmsSecurityManager.checkPermissions(CmsRequestContext context, CmsResource resource, CmsPermissionSet requiredPermissions, boolean checkLock, CmsResourceFilter filter)	Performs a blocking permission check on a resource.
protected void	CmsSecurityManager.checkPermissions(CmsRequestContext context, CmsResource resource, CmsPermissionSet requiredPermissions, I_CmsPermissionHandler.CmsPermissionCheckResult permissions)	Applies the permission check result of a previous call to CmsSecurityManager.hasPermissions(CmsRequestContext, CmsResource, CmsPermissionSet, boolean, CmsResourceFilter).
void	CmsSecurityManager.checkRoleForResource(CmsDbContext dbc, CmsRole role, CmsResource resource)	Checks if the user of the current database context has permissions to impersonate the given role for the given resource.
void	CmsSecurityManager.checkRoleForResource(CmsRequestContext context, CmsRole role, CmsResource resource)	Checks if the user of the current context has permissions to impersonate the given role for the given resource.
protected void	CmsSecurityManager.checkSystemLocks(CmsDbContext dbc, CmsResource resource)	Checks if the given resource contains a resource that has a system lock.
void	CmsDriverManager.chflags(CmsDbContext dbc, CmsResource resource, int flags)	Changes the resource flags of a resource.
void	CmsSecurityManager.chflags(CmsRequestContext context, CmsResource resource, int flags)	Changes the resource flags of a resource.
void	CmsDriverManager.chtype(CmsDbContext dbc, CmsResource resource, int type)	Changes the resource type of a resource.
void	CmsSecurityManager.chtype(CmsRequestContext context, CmsResource resource, int type)	Changes the resource type of a resource.
protected boolean	CmsPublishList.containsResource(CmsResource res)	Checks if the publish list contains a resource.
protected boolean	CmsPublishList.containsSubResources(CmsObject cms, CmsResource folder)	Checks if the publish list contains all sub-resources of a given folder.
protected CmsFolder	CmsDriverManager.convertResourceToFolder(CmsResource resource)	Converts a resource to a folder (if possible).
void	CmsDriverManager.copyAccessControlEntries(CmsDbContext dbc, CmsResource source, CmsResource destination, boolean updateLastModifiedInfo)	Copies the access control entries of a given resource to a destination resource.
void	CmsSecurityManager.copyAccessControlEntries(CmsRequestContext context, CmsResource source, CmsResource destination)	Copies the access control entries of a given resource to a destination resource.
void	CmsDriverManager.copyResource(CmsDbContext dbc, CmsResource source, String destination, CmsResource.CmsResourceCopyMode siblingMode)	Copies a resource.
void	CmsSecurityManager.copyResource(CmsRequestContext context, CmsResource source, String destination, CmsResource.CmsResourceCopyMode siblingMode)	Copies a resource.
void	CmsDriverManager.copyResourceToProject(CmsDbContext dbc, CmsResource resource)	Copies a resource to the current project of the user.
void	CmsSecurityManager.copyResourceToProject(CmsRequestContext context, CmsResource resource)	Copies a resource to the current project of the user.
CmsOrganizationalUnit	CmsDriverManager.createOrganizationalUnit(CmsDbContext dbc, String ouFqn, String description, int flags, CmsResource resource)	Creates a new organizational unit.
CmsOrganizationalUnit	CmsSecurityManager.createOrganizationalUnit(CmsRequestContext context, String ouFqn, String description, int flags, CmsResource resource)	Creates a new organizational unit.
CmsResource	CmsDriverManager.createResource(CmsDbContext dbc, String resourcePath, CmsResource resource, byte[] content, List<CmsProperty> properties, boolean importCase)	Creates a new resource with the provided content and properties.
CmsResource	CmsSecurityManager.createResource(CmsRequestContext context, String resourcePath, CmsResource resource, byte[] content, List<CmsProperty> properties)	Creates a new resource with the provided content and properties.
CmsResource	I_CmsVfsDriver.createResource(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, byte[] content)	Creates a new resource from a given CmsResource object.
CmsResource	CmsDriverManager.createSibling(CmsDbContext dbc, CmsResource source, String destination, List<CmsProperty> properties)	Creates a new sibling of the source resource.
CmsResource	CmsSecurityManager.createSibling(CmsRequestContext context, CmsResource source, String destination, List<CmsProperty> properties)	Creates a new sibling of the source resource.
void	I_CmsVfsDriver.createSibling(CmsDbContext dbc, CmsProject project, CmsResource resource)	Creates a new sibling for a specified resource.
void	I_CmsVfsDriver.deletePropertyObjects(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, int deleteOption)	Deletes all property values of a file or folder.
void	I_CmsVfsDriver.deleteRelations(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, CmsRelationFilter filter)	Deletes all relations with the given filter for the given resource.
void	CmsDriverManager.deleteRelationsForResource(CmsDbContext dbc, CmsResource resource, CmsRelationFilter filter)	Deletes all relations for the given resource matching the given filter.
void	CmsSecurityManager.deleteRelationsForResource(CmsRequestContext context, CmsResource resource, CmsRelationFilter filter)	Deletes all relations for the given resource matching the given filter.
protected void	CmsDriverManager.deleteRelationsWithSiblings(CmsDbContext dbc, CmsResource resource)	Deletes all relations for the given resource and all its siblings.
void	CmsDriverManager.deleteResource(CmsDbContext dbc, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode)	Deletes a resource.
protected void	CmsSecurityManager.deleteResource(CmsDbContext dbc, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode)	Internal recursive method for deleting a resource.
void	CmsSecurityManager.deleteResource(CmsRequestContext context, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode)	Deletes a resource given its name.
List<CmsAccessControlEntry>	CmsDriverManager.getAccessControlEntries(CmsDbContext dbc, CmsResource resource, boolean getInherited)	Returns the list of access control entries of a resource given its name.
List<CmsAccessControlEntry>	CmsSecurityManager.getAccessControlEntries(CmsRequestContext context, CmsResource resource, boolean getInherited)	Returns the list of access control entries of a resource given its name.
CmsAccessControlList	CmsDriverManager.getAccessControlList(CmsDbContext dbc, CmsResource resource)	Returns the full access control list of a given resource.
CmsAccessControlList	CmsDriverManager.getAccessControlList(CmsDbContext dbc, CmsResource resource, boolean inheritedOnly)	Returns the access control list of a given resource.
CmsAccessControlList	CmsSecurityManager.getAccessControlList(CmsRequestContext context, CmsResource resource, boolean inheritedOnly)	Returns the access control list (summarized access control entries) of a given resource.
String	CmsCacheKey.getCacheKeyForUserPermissions(String prefix, CmsDbContext context, CmsResource resource, CmsPermissionSet requiredPermissions)
String	I_CmsCacheKey.getCacheKeyForUserPermissions(String prefix, CmsDbContext context, CmsResource resource, CmsPermissionSet requiredPermissions)	Returns the cache key for the permission cache.
long	CmsDriverManager.getDateLastVisitedBy(CmsDbContext dbc, String poolName, CmsUser user, CmsResource resource)	Returns the date when the resource was last visited by the user.
long	CmsSecurityManager.getDateLastVisitedBy(CmsRequestContext context, String poolName, CmsUser user, CmsResource resource)	Returns the date when the resource was last visited by the user.
long	CmsSubscriptionManager.getDateLastVisitedBy(CmsObject cms, CmsUser user, CmsResource resource)	Returns the date when the resource was last visited by the user.
long	I_CmsSubscriptionDriver.getDateLastVisitedBy(CmsDbContext dbc, String poolName, CmsUser user, CmsResource resource)	Returns the date when the resource was last visited by the user.
CmsLock	CmsDriverManager.getLock(CmsDbContext dbc, CmsResource resource)	Returns the lock state of a resource.
CmsLock	CmsSecurityManager.getLock(CmsRequestContext context, CmsResource resource)	Returns the lock state of a resource.
List<String>	CmsDriverManager.getLockedResources(CmsDbContext dbc, CmsResource resource, CmsLockFilter filter)	Returns all locked resources in a given folder.
List<String>	CmsSecurityManager.getLockedResources(CmsRequestContext context, CmsResource resource, CmsLockFilter filter)	Returns all locked resources in a given folder.
List<CmsResource>	CmsDriverManager.getLockedResourcesObjects(CmsDbContext dbc, CmsResource resource, CmsLockFilter filter)	Returns all locked resources in a given folder.
List<CmsResource>	CmsSecurityManager.getLockedResourcesObjects(CmsRequestContext context, CmsResource resource, CmsLockFilter filter)	Returns all locked resources in a given folder.
List<CmsResource>	CmsDriverManager.getLockedResourcesObjectsWithCache(CmsDbContext dbc, CmsResource resource, CmsLockFilter filter, Map<String,CmsResource> cache)	Returns all locked resources in a given folder, but uses a cache for resource lookups.
List<CmsResource>	CmsSecurityManager.getLockedResourcesObjectsWithCache(CmsRequestContext context, CmsResource resource, CmsLockFilter filter, Map<String,CmsResource> cache)	Returns all locked resources in a given folder, but uses a cache for resource lookups.
CmsPermissionSetCustom	CmsDriverManager.getPermissions(CmsDbContext dbc, CmsResource resource, CmsUser user)	Returns the set of permissions of the current user for a given resource.
CmsPermissionSetCustom	CmsSecurityManager.getPermissions(CmsRequestContext context, CmsResource resource, CmsUser user)	Returns the set of permissions of the current user for a given resource.
List<CmsRelation>	CmsDriverManager.getRelationsForResource(CmsDbContext dbc, CmsResource resource, CmsRelationFilter filter)	Returns all relations for the given resource matching the given filter.
List<CmsRelation>	CmsSecurityManager.getRelationsForResource(CmsRequestContext context, CmsResource resource, CmsRelationFilter filter)	Returns all relations for the given resource matching the given filter.
List<CmsOrganizationalUnit>	CmsDriverManager.getResourceOrgUnits(CmsDbContext dbc, CmsResource resource)	Returns the list of organizational units the given resource belongs to.
List<CmsOrganizationalUnit>	I_CmsVfsDriver.getResourceOus(CmsDbContext dbc, CmsUUID projectId, CmsResource resource)	Returns all organizational units for the given resource.
List<CmsRole>	CmsDriverManager.getRolesForResource(CmsDbContext dbc, CmsUser user, CmsResource resource)	Returns all roles the given user has for the given resource.
List<CmsRole>	CmsSecurityManager.getRolesForResource(CmsRequestContext context, CmsUser user, CmsResource resource)	Returns all roles the given user has for the given resource.
protected I_CmsPermissionHandler.CmsPermissionCheckResult	CmsSecurityManager.hasPermissions(CmsDbContext dbc, CmsResource resource, CmsPermissionSet requiredPermissions, I_CmsPermissionHandler.LockCheck checkLock, CmsResourceFilter filter)	Performs a non-blocking permission check on a resource.
I_CmsPermissionHandler.CmsPermissionCheckResult	CmsSecurityManager.hasPermissions(CmsRequestContext context, CmsResource resource, CmsPermissionSet requiredPermissions, boolean checkLock, CmsResourceFilter filter)	Performs a non-blocking permission check on a resource.
I_CmsPermissionHandler.CmsPermissionCheckResult	CmsSecurityManager.hasPermissions(CmsRequestContext context, CmsResource resource, CmsPermissionSet requiredPermissions, I_CmsPermissionHandler.LockCheck checkLock, CmsResourceFilter filter)	Performs a non-blocking permission check on a resource.
boolean	CmsSecurityManager.hasRoleForResource(CmsDbContext dbc, CmsUser user, CmsRole role, CmsResource resource)	Checks if the given user has the given role for the given resource.
boolean	CmsSecurityManager.hasRoleForResource(CmsRequestContext context, CmsUser user, CmsRole role, CmsResource resource)	Checks if the given user has the given role for the given resource.
void	CmsDriverManager.importAccessControlEntries(CmsDbContext dbc, CmsResource resource, List<CmsAccessControlEntry> acEntries)	Writes a vector of access control entries as new access control entries of a given resource.
void	CmsSecurityManager.importAccessControlEntries(CmsRequestContext context, CmsResource resource, List<CmsAccessControlEntry> acEntries)	Writes a list of access control entries as new access control entries of a given resource.
CmsResource	CmsSecurityManager.importResource(CmsRequestContext context, String resourcePath, CmsResource resource, byte[] content, List<CmsProperty> properties, boolean importCase)	Creates a new resource with the provided content and properties.
CmsResource	CmsUserTrackingResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
boolean	CmsDriverManager.labelResource(CmsDbContext dbc, CmsResource resource, String newResource, int action)	Checks if one of the resources (except the resource itself) is a sibling in a "labeled" site folder.
CmsUser	CmsDriverManager.lockedBy(CmsDbContext dbc, CmsResource resource)	Returns the user, who had locked the resource.
void	CmsDriverManager.lockResource(CmsDbContext dbc, CmsResource resource, CmsLockType type)	Locks a resource.
void	CmsSecurityManager.lockResource(CmsRequestContext context, CmsResource resource, CmsLockType type)	Locks a resource.
void	CmsDriverManager.markResourceAsVisitedBy(CmsDbContext dbc, String poolName, CmsResource resource, CmsUser user)	Mark the given resource as visited by the user.
void	CmsSecurityManager.markResourceAsVisitedBy(CmsRequestContext context, String poolName, CmsResource resource, CmsUser user)	Mark the given resource as visited by the user.
void	CmsSubscriptionManager.markResourceAsVisitedBy(CmsObject cms, CmsResource resource, CmsUser user)	Mark the given resource as visited by the user.
void	I_CmsSubscriptionDriver.markResourceAsVisitedBy(CmsDbContext dbc, String poolName, CmsResource resource, CmsUser user)	Mark the given resource as visited by the user.
void	CmsDriverManager.moveResource(CmsDbContext dbc, CmsResource source, String destination, boolean internal)	Moves a resource.
protected void	CmsSecurityManager.moveResource(CmsDbContext dbc, CmsResource source, String destination, Set<CmsResource> allMovedResources)	Internal recursive method to move a resource.
void	CmsSecurityManager.moveResource(CmsRequestContext context, CmsResource source, String destination)	Moves a resource.
void	I_CmsVfsDriver.moveResource(CmsDbContext dbc, CmsUUID projectId, CmsResource source, String destinationPath)	Moves the given resource to the specified destination path.
String	CmsDriverManager.moveToLostAndFound(CmsDbContext dbc, CmsResource resource, boolean returnNameOnly)	Moves a resource to the "lost and found" folder.
String	CmsSecurityManager.moveToLostAndFound(CmsRequestContext context, CmsResource resource, boolean returnNameOnly)	Moves a resource to the "lost and found" folder.
void	I_CmsProjectDriver.publishFile(CmsDbContext dbc, I_CmsReport report, int m, int n, CmsProject onlineProject, CmsResource offlineResource, Set<CmsUUID> publishedContentIds, CmsUUID publishHistoryId, int publishTag)	Publishes a new, changed or deleted file.
CmsFile	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.
void	I_CmsVfsDriver.publishResource(CmsDbContext dbc, CmsProject onlineProject, CmsResource onlineResource, CmsResource offlineResource)	Publishes the structure and resource records of an offline resource into it's online counterpart.
void	CmsDriverManager.publishUrlNameMapping(CmsDbContext dbc, CmsResource res)	Transfers the new URL name mappings (if any) for a given resource to the online project.
void	I_CmsVfsDriver.publishVersions(CmsDbContext dbc, CmsResource resource, boolean firstSibling)	Copies the version number from the offline resource to the online resource, this has to be done during publishing, direct after copying the resource itself.
CmsAccessControlEntry	CmsDriverManager.readAccessControlEntry(CmsDbContext dbc, CmsResource resource, CmsUUID principal)	Reads an access control entry from the cms.
List<I_CmsHistoryResource>	CmsDriverManager.readAllAvailableVersions(CmsDbContext dbc, CmsResource resource)	Reads all versions of the given resource. This method returns a list with the history of the given resource, i.e.
List<I_CmsHistoryResource>	CmsSecurityManager.readAllAvailableVersions(CmsRequestContext context, CmsResource resource)	Reads all historical versions of a resource.
CmsFolder	CmsSecurityManager.readAncestor(CmsRequestContext context, CmsResource resource, CmsResourceFilter filter)	Returns the first ancestor folder matching the filter criteria.
List<CmsResource>	CmsDriverManager.readChildResources(CmsDbContext dbc, CmsResource resource, CmsResourceFilter filter, boolean getFolders, boolean getFiles, boolean checkPermissions)	Returns the child resources of a resource, that is the resources contained in a folder.
List<CmsResource>	CmsSecurityManager.readChildResources(CmsRequestContext context, CmsResource resource, CmsResourceFilter filter, boolean getFolders, boolean getFiles)	Returns the child resources of a resource, that is the resources contained in a folder.
List<CmsResource>	I_CmsVfsDriver.readChildResources(CmsDbContext dbc, CmsProject currentProject, CmsResource resource, boolean getFolders, boolean getFiles)	Reads all child-files and/or child-folders of a specified parent resource.
CmsResource	CmsDriverManager.readDefaultFile(CmsDbContext dbc, CmsResource resource, CmsResourceFilter resourceFilter)	Returns the default file for the given folder.
CmsResource	CmsSecurityManager.readDefaultFile(CmsRequestContext context, CmsResource resource, CmsResourceFilter resourceFilter)	Returns the default file for the given folder.
List<I_CmsHistoryResource>	CmsDriverManager.readDeletedResources(CmsDbContext dbc, CmsResource resource, boolean readTree, boolean isVfsManager)	Reads all deleted (historical) resources below the given path, including the full tree below the path, if required.
List<I_CmsHistoryResource>	CmsSecurityManager.readDeletedResources(CmsRequestContext context, CmsResource resource, boolean readTree)	Reads all deleted (historical) resources below the given path, including the full tree below the path, if required.
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.
CmsProperty	CmsDriverManager.readPropertyObject(CmsDbContext dbc, CmsResource resource, String key, boolean search)	Reads a property object from a resource specified by a property name.
CmsProperty	CmsDriverManager.readPropertyObject(CmsDbContext dbc, CmsResource resource, String key, boolean search, Locale locale)	Reads a property object from a resource specified by a property name.
CmsProperty	CmsSecurityManager.readPropertyObject(CmsRequestContext context, CmsResource resource, String key, boolean search)	Reads a property object from a resource specified by a property name.
CmsProperty	CmsSecurityManager.readPropertyObject(CmsRequestContext context, CmsResource resource, String key, boolean search, Locale locale)	Reads a property object from a resource specified by a property name.
CmsProperty	I_CmsVfsDriver.readPropertyObject(CmsDbContext dbc, String key, CmsProject project, CmsResource resource)	Reads a property object from the database specified by it's key name mapped to a resource.
List<CmsProperty>	CmsDriverManager.readPropertyObjects(CmsDbContext dbc, CmsResource resource, boolean search)	Reads all property objects mapped to a specified resource from the database.
List<CmsProperty>	CmsSecurityManager.readPropertyObjects(CmsRequestContext context, CmsResource resource, boolean search)	Reads all property objects from a resource.
List<CmsProperty>	I_CmsVfsDriver.readPropertyObjects(CmsDbContext dbc, CmsProject project, CmsResource resource)	Reads all property objects mapped to a specified resource from the database.
List<CmsRelation>	I_CmsVfsDriver.readRelations(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, CmsRelationFilter filter)	Reads all relations with the given filter for the given resource.
I_CmsHistoryResource	CmsDriverManager.readResource(CmsDbContext dbc, CmsResource resource, int version)	Reads an historical resource entry for the given resource and with the given version number.
I_CmsHistoryResource	CmsSecurityManager.readResource(CmsRequestContext context, CmsResource resource, int version)	Reads the historical resource entry for the given resource with the given version number.
List<CmsResource>	CmsDriverManager.readResources(CmsDbContext dbc, CmsResource parent, CmsResourceFilter filter, boolean readTree)	Reads all resources below the given path matching the filter criteria, including the full tree below the path only in case the readTree parameter is true.
List<CmsResource>	CmsSecurityManager.readResources(CmsRequestContext context, CmsResource parent, CmsResourceFilter filter, boolean readTree)	Reads all resources below the given path matching the filter criteria, including the full tree below the path only in case the readTree parameter is true.
List<CmsResource>	CmsDriverManager.readResourcesWithProperty(CmsDbContext dbc, CmsResource folder, String propertyDefinition, String value, CmsResourceFilter filter)	Reads all resources that have a value (containing the given value string) set for the specified property (definition) in the given path.
List<CmsResource>	CmsSecurityManager.readResourcesWithProperty(CmsRequestContext context, CmsResource folder, String propertyDefinition, String value, CmsResourceFilter filter)	Reads all resources that have a value (containing the specified value) set for the specified property (definition) in the given path.
Set<I_CmsPrincipal>	CmsDriverManager.readResponsiblePrincipals(CmsDbContext dbc, CmsResource resource)	Returns the set of users that are responsible for a specific resource.
Set<I_CmsPrincipal>	CmsSecurityManager.readResponsiblePrincipals(CmsRequestContext context, CmsResource resource)	Returns a set of users that are responsible for a specific resource.
Set<CmsUser>	CmsDriverManager.readResponsibleUsers(CmsDbContext dbc, CmsResource resource)	Returns the set of users that are responsible for a specific resource.
Set<CmsUser>	CmsSecurityManager.readResponsibleUsers(CmsRequestContext context, CmsResource resource)	Returns a set of users that are responsible for a specific resource.
List<CmsResource>	CmsDriverManager.readSiblings(CmsDbContext dbc, CmsResource resource, CmsResourceFilter filter)	Returns a List of all siblings of the specified resource, the specified resource being always part of the result set.
List<CmsResource>	CmsSecurityManager.readSiblings(CmsRequestContext context, CmsResource resource, CmsResourceFilter filter)	Returns a List of all siblings of the specified resource, the specified resource being always part of the result set.
List<CmsResource>	I_CmsVfsDriver.readSiblings(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, boolean includeDeleted)	Reads all siblings that point to the resource record of a specified resource.
List<I_CmsHistoryResource>	CmsDriverManager.readSubscribedDeletedResources(CmsDbContext dbc, String poolName, CmsUser user, List<CmsGroup> groups, CmsResource parent, boolean includeSubFolders, long deletedFrom)	Returns the subscribed history resources that were deleted.
List<I_CmsHistoryResource>	CmsSecurityManager.readSubscribedDeletedResources(CmsRequestContext context, String poolName, CmsUser user, List<CmsGroup> groups, CmsResource parent, boolean includeSubFolders, long deletedFrom)	Returns the subscribed history resources that were deleted.
List<I_CmsHistoryResource>	I_CmsSubscriptionDriver.readSubscribedDeletedResources(CmsDbContext dbc, String poolName, CmsUser user, List<CmsGroup> groups, CmsResource parent, boolean includeSubFolders, long deletedFrom)	Returns the subscribed history resources that were deleted.
protected boolean	CmsPublishList.remove(CmsResource resource)	Removes a Cms resource from the publish list.
void	CmsDriverManager.removeAccessControlEntry(CmsDbContext dbc, CmsResource resource, CmsUUID principal)	Removes an access control entry for a given resource and principal.
void	CmsSecurityManager.removeAccessControlEntry(CmsRequestContext context, CmsResource resource, CmsUUID principal)	Removes an access control entry for a given resource and principal.
void	I_CmsVfsDriver.removeFile(CmsDbContext dbc, CmsUUID projectId, CmsResource resource)	Removes a file physically in the database.
void	I_CmsVfsDriver.removeFolder(CmsDbContext dbc, CmsProject currentProject, CmsResource resource)	Removes a folder physically in the database.
void	I_CmsUserDriver.removeResourceFromOrganizationalUnit(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, CmsResource resource)	Removes a resource from the given organizational unit.
void	CmsDriverManager.removeResourceFromOrgUnit(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, CmsResource resource)	Removes a resource from the given organizational unit.
void	CmsSecurityManager.removeResourceFromOrgUnit(CmsRequestContext context, CmsOrganizationalUnit orgUnit, CmsResource resource)	Removes a resource from the given organizational unit.
void	CmsDriverManager.removeResourceFromProject(CmsDbContext dbc, CmsResource resource)	Removes a resource from the current project of the user.
void	CmsSecurityManager.removeResourceFromProject(CmsRequestContext context, CmsResource resource)	Removes a resource from the current project of the user.
void	CmsDriverManager.repairCategories(CmsDbContext dbc, CmsUUID projectId, CmsResource resource)	Repairs broken categories.
void	CmsDriverManager.replaceResource(CmsDbContext dbc, CmsResource resource, int type, byte[] content, List<CmsProperty> properties)	Replaces the content, type and properties of a resource.
void	CmsSecurityManager.replaceResource(CmsRequestContext context, CmsResource resource, int type, byte[] content, List<CmsProperty> properties)	Replaces the content, type and properties of a resource.
void	I_CmsVfsDriver.replaceResource(CmsDbContext dbc, CmsResource newResource, byte[] newResourceContent, int newResourceType)	Replaces the content and properties of an existing resource.
String	CmsSecurityManager.resourceOriginalPath(CmsRequestContext context, CmsResource resource)	Returns the original path of given resource, that is the online path for the resource.
void	CmsDriverManager.restoreResource(CmsDbContext dbc, CmsResource resource, int version)	Restores a resource in the current project with a version from the historical archive.
void	CmsSecurityManager.restoreResource(CmsRequestContext context, CmsResource resource, int version)	Restores a resource in the current project with the given version from the historical archive.
void	CmsSecurityManager.saveAliases(CmsRequestContext context, CmsResource resource, List<CmsAlias> aliases)	Saves the aliases for a given resource.
void	CmsDriverManager.setDateExpired(CmsDbContext dbc, CmsResource resource, long dateExpired)	Changes the "expire" date of a resource.
void	CmsSecurityManager.setDateExpired(CmsRequestContext context, CmsResource resource, long dateExpired)	Changes the "expire" date of a resource.
void	CmsDriverManager.setDateLastModified(CmsDbContext dbc, CmsResource resource, long dateLastModified)	Changes the "last modified" timestamp of a resource.
void	CmsSecurityManager.setDateLastModified(CmsRequestContext context, CmsResource resource, long dateLastModified)	Changes the "last modified" time stamp of a resource.
void	CmsDriverManager.setDateReleased(CmsDbContext dbc, CmsResource resource, long dateReleased)	Changes the "release" date of a resource.
void	CmsSecurityManager.setDateReleased(CmsRequestContext context, CmsResource resource, long dateReleased)	Changes the "release" date of a resource.
void	CmsVisitedByFilter.setParentResource(CmsResource parentResource)	Sets the parent path to read visited resources from using the given resource as parent.
void	CmsSecurityManager.setRestricted(CmsRequestContext context, CmsResource resource, CmsGroup group, boolean restricted)	Sets/clears the 'restricted' status for the given resource and group.
void	CmsDriverManager.setSubscribedResourceAsDeleted(CmsDbContext dbc, String poolName, CmsResource resource)	Marks a subscribed resource as deleted.
void	CmsSecurityManager.setSubscribedResourceAsDeleted(CmsRequestContext context, String poolName, CmsResource resource)	Marks a subscribed resource as deleted.
void	CmsSubscriptionManager.setSubscribedResourceAsDeleted(CmsObject cms, CmsResource resource)	Marks a subscribed resource as deleted.
void	I_CmsSubscriptionDriver.setSubscribedResourceAsDeleted(CmsDbContext dbc, String poolName, CmsResource resource)	Marks a subscribed resource as deleted.
void	CmsDriverManager.subscribeResourceFor(CmsDbContext dbc, String poolName, CmsPrincipal principal, CmsResource resource)	Subscribes the user or group to the resource.
void	CmsSecurityManager.subscribeResourceFor(CmsRequestContext context, String poolName, CmsPrincipal principal, CmsResource resource)	Subscribes the user or group to the resource.
void	CmsSubscriptionManager.subscribeResourceFor(CmsObject cms, CmsPrincipal principal, CmsResource resource)	Subscribes the user or group to the resource.
void	I_CmsSubscriptionDriver.subscribeResourceFor(CmsDbContext dbc, String poolName, CmsPrincipal principal, CmsResource resource)	Subscribes the user or group to the resource.
void	I_CmsVfsDriver.transferResource(CmsDbContext dbc, CmsProject project, CmsResource resource, CmsUUID createdUser, CmsUUID lastModifiedUser)	Transfers the attributes of a resource from to the given users.
void	CmsDriverManager.undelete(CmsDbContext dbc, CmsResource resource)	Undelete the resource.
void	CmsSecurityManager.undelete(CmsRequestContext context, CmsResource resource)	Undelete the resource by resetting it's state.
void	CmsDriverManager.undoChanges(CmsDbContext dbc, CmsResource resource, CmsResource.CmsResourceUndoMode mode)	Undos all changes in the resource by restoring the version from the online project to the current offline project.
void	CmsSecurityManager.undoChanges(CmsRequestContext context, CmsResource resource, CmsResource.CmsResourceUndoMode mode)	Undos all changes in the resource by restoring the version from the online project to the current offline project.
void	CmsDriverManager.unlockResource(CmsDbContext dbc, CmsResource resource, boolean force, boolean removeSystemLock)	Unlocks a resource.
void	CmsSecurityManager.unlockResource(CmsRequestContext context, CmsResource resource)	Unlocks a resource.
void	CmsDriverManager.unsubscribeResourceFor(CmsDbContext dbc, String poolName, CmsPrincipal principal, CmsResource resource)	Unsubscribes the principal from the resource.
void	CmsSecurityManager.unsubscribeResourceFor(CmsRequestContext context, String poolName, CmsPrincipal principal, CmsResource resource)	Unsubscribes the principal from the resource.
void	CmsSubscriptionManager.unsubscribeResourceFor(CmsObject cms, CmsPrincipal principal, CmsResource resource)	Unsubscribes the principal from the resource.
void	I_CmsSubscriptionDriver.unsubscribeResourceFor(CmsDbContext dbc, String poolName, CmsPrincipal principal, CmsResource resource)	Unsubscribes the principal from the resource.
void	CmsDriverManager.unsubscribeResourceForAll(CmsDbContext dbc, String poolName, CmsResource resource)	Unsubscribes all groups and users from the resource.
void	CmsSecurityManager.unsubscribeResourceForAll(CmsRequestContext context, String poolName, CmsResource resource)	Unsubscribes all groups and users from the resource.
void	CmsSubscriptionManager.unsubscribeResourceForAll(CmsObject cms, CmsResource resource)	Unsubscribes all groups and users from the resource.
void	I_CmsSubscriptionDriver.unsubscribeResourceForAll(CmsDbContext dbc, String poolName, CmsResource resource)	Unsubscribes all groups and users from the resource.
void	I_CmsVfsDriver.updateRelations(CmsDbContext dbc, CmsProject onlineProject, CmsResource offlineResource)	Updates the relations on the online project copying the relations from the offline project.
void	CmsDriverManager.updateRelationsForResource(CmsDbContext dbc, CmsResource resource, List<CmsLink> links, boolean updateSiblingState)	Updates/Creates the given relations for the given resource.
void	CmsSecurityManager.updateRelationsForResource(CmsRequestContext context, CmsResource resource, List<CmsLink> relations, boolean updateSiblingState)	Updates/Creates the relations for the given resource.
void	CmsDriverManager.writeAccessControlEntry(CmsDbContext dbc, CmsResource resource, CmsAccessControlEntry ace)	Writes an access control entries to a given resource.
void	CmsSecurityManager.writeAccessControlEntry(CmsRequestContext context, CmsResource resource, CmsAccessControlEntry ace)	Writes an access control entries to a given resource.
void	I_CmsVfsDriver.writeLastModifiedProjectId(CmsDbContext dbc, CmsProject project, CmsUUID projectId, CmsResource resource)	Writes the "last-modified-in-project" ID of a resource.
void	CmsDriverManager.writeProjectLastModified(CmsDbContext dbc, CmsResource resource, CmsUUID projectId)	Writes a new project into the PROJECT_LASTMODIFIED field of a resource record.
void	I_CmsHistoryDriver.writeProperties(CmsDbContext dbc, CmsResource resource, List<CmsProperty> properties, int publishTag)	Writes the properties of a resource to the history.
void	CmsDriverManager.writePropertyObject(CmsDbContext dbc, CmsResource resource, CmsProperty property)	Writes a property for a specified resource.
void	CmsSecurityManager.writePropertyObject(CmsRequestContext context, CmsResource resource, CmsProperty property)	Writes a property for a specified resource.
void	I_CmsVfsDriver.writePropertyObject(CmsDbContext dbc, CmsProject project, CmsResource resource, CmsProperty property)	Writes a property object to the database mapped to a specified resource.
void	CmsDriverManager.writePropertyObjects(CmsDbContext dbc, CmsResource resource, List<CmsProperty> properties, boolean updateState)	Writes a list of properties for a specified resource.
void	CmsSecurityManager.writePropertyObjects(CmsRequestContext context, CmsResource resource, List<CmsProperty> properties)	Writes a list of properties for a specified resource.
void	I_CmsVfsDriver.writePropertyObjects(CmsDbContext dbc, CmsProject project, CmsResource resource, List<CmsProperty> properties)	Writes a list of property objects to the database mapped to a specified resource.
void	CmsDriverManager.writeResource(CmsDbContext dbc, CmsResource resource)	Writes a resource to the OpenCms VFS.
void	CmsSecurityManager.writeResource(CmsRequestContext context, CmsResource resource)	Writes a resource to the OpenCms VFS.
void	I_CmsHistoryDriver.writeResource(CmsDbContext dbc, CmsResource resource, List<CmsProperty> properties, int publishTag)	Writes a resource to the history.
void	I_CmsVfsDriver.writeResource(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, int changed)	Writes the structure and/or resource record(s) of an existing file.
void	CmsSecurityManager.writeResourceProjectLastModified(CmsRequestContext context, CmsResource resource, CmsProject project)	Writes the 'projectlastmodified' field of a resource record.
void	I_CmsVfsDriver.writeResourceState(CmsDbContext dbc, CmsProject project, CmsResource resource, int changed, boolean isPublishing)	Writes file state in either the structure or resource record, or both of them.

Method parameters in org.opencms.db with type arguments of type CmsResource

Modifier and Type	Method	Description
protected void	CmsPublishList.addAll(Collection<CmsResource> resources, boolean check)	Appends all the given resources to this publish list.
protected CmsResource	CmsPublishList.checkContainsSubResources(CmsObject cms, List<CmsResource> folders)	Checks whether the publish list contains all sub-resources of a list of folders.
List<CmsResource>	CmsDriverManager.getLockedResourcesObjectsWithCache(CmsDbContext dbc, CmsResource resource, CmsLockFilter filter, Map<String,CmsResource> cache)	Returns all locked resources in a given folder, but uses a cache for resource lookups.
List<CmsResource>	CmsSecurityManager.getLockedResourcesObjectsWithCache(CmsRequestContext context, CmsResource resource, CmsLockFilter filter, Map<String,CmsResource> cache)	Returns all locked resources in a given folder, but uses a cache for resource lookups.
protected List<CmsResource>	CmsPublishList.getMissingSubResources(CmsObject cms, List<CmsResource> folders)	Gets the sub-resources of a list of folders which are missing from the publish list.
protected List<CmsResource>	CmsPublishList.getTopFolders(List<CmsResource> folders)	Gives the "roots" of a list of folders, i.e.
protected void	CmsSecurityManager.moveResource(CmsDbContext dbc, CmsResource source, String destination, Set<CmsResource> allMovedResources)	Internal recursive method to move a resource.
protected void	CmsDriverManager.resetResourcesInProject(CmsDbContext dbc, CmsUUID projectId, List<CmsResource> modifiedFiles, List<CmsResource> modifiedFolders)	Resets the resources in a project to their online state.

Constructors in org.opencms.db with parameters of type CmsResource

Modifier	Constructor	Description
	CmsPublishedResource(CmsResource resource)	Creates an object for published VFS resources.
	CmsPublishedResource(CmsResource resource, int publishTag)	Creates an object for published VFS resources.
	CmsPublishedResource(CmsResource resource, int publishTag, CmsResourceState state)	Creates an object for published VFS resources.
	CmsPublishList(CmsResource directPublishResource, boolean publishSiblings)	Constructs a publish list for a single direct publish resource.

Constructor parameters in org.opencms.db with type arguments of type CmsResource

Modifier	Constructor	Description
	CmsPublishList(boolean all, List<CmsResource> directPublishResources, boolean directPublishSiblings)	Constructs a publish list for a list of direct publish resources.
	CmsPublishList(List<CmsResource> directPublishResources, boolean publishSiblings)	Constructs a publish list for a list of direct publish resources.
	CmsPublishList(List<CmsResource> directPublishResources, boolean publishSiblings, boolean publishSubResources)	Constructs a publish list for a list of direct publish resources.

Uses of CmsResource in org.opencms.db.generic

Methods in org.opencms.db.generic that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsVfsDriver.createResource(ResultSet res, CmsUUID projectId)
CmsResource	CmsVfsDriver.createResource(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, byte[] content)
protected CmsResource	CmsUserDriver.internalCreateResourceForOrgUnit(CmsDbContext dbc, String path, int flags)	Creates a folder with the given path an properties, offline AND online.
protected CmsResource	CmsUserDriver.internalOrgUnitFolder(CmsDbContext dbc, CmsOrganizationalUnit orgUnit)	Returns the folder for the given organizational units, or the base folder if null.
CmsResource	CmsVfsDriver.readResource(CmsDbContext dbc, CmsUUID projectId, String path, boolean includeDeleted)
CmsResource	CmsVfsDriver.readResource(CmsDbContext dbc, CmsUUID projectId, CmsUUID structureId, boolean includeDeleted)

Methods in org.opencms.db.generic that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsUserDriver.getResourcesForOrganizationalUnit(CmsDbContext dbc, CmsOrganizationalUnit orgUnit)
List<CmsResource>	CmsProjectDriver.getUsersPubList(CmsDbContext dbc, CmsUUID userId)
protected List<CmsResource>	CmsProjectDriver.getUsersPubListFromLog(CmsDbContext dbc, CmsUUID userId)	Implementation of reading the user publish list which uses the log table.
List<CmsResource>	CmsSubscriptionDriver.readAllSubscribedResources(CmsDbContext dbc, String poolName, CmsPrincipal principal)
List<CmsResource>	CmsVfsDriver.readChildResources(CmsDbContext dbc, CmsProject currentProject, CmsResource resource, boolean getFolders, boolean getFiles)
List<CmsResource>	CmsVfsDriver.readResources(CmsDbContext dbc, CmsUUID projectId, CmsResourceState state, int mode)
List<CmsResource>	CmsVfsDriver.readResourcesForPrincipalACE(CmsDbContext dbc, CmsProject project, CmsUUID principalId)
List<CmsResource>	CmsVfsDriver.readResourcesForPrincipalAttr(CmsDbContext dbc, CmsProject project, CmsUUID principalId)
List<CmsResource>	CmsSubscriptionDriver.readResourcesVisitedBy(CmsDbContext dbc, String poolName, CmsVisitedByFilter filter)
List<CmsResource>	CmsVfsDriver.readResourcesWithProperty(CmsDbContext dbc, CmsUUID projectId, CmsUUID propertyDef, String path, String value)
List<CmsResource>	CmsVfsDriver.readResourceTree(CmsDbContext dbc, CmsUUID projectId, String parentPath, int type, CmsResourceState state, long lastModifiedAfter, long lastModifiedBefore, long releasedAfter, long releasedBefore, long expiredAfter, long expiredBefore, int mode)
List<CmsResource>	CmsVfsDriver.readSiblings(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, boolean includeDeleted)
List<CmsResource>	CmsSubscriptionDriver.readSubscribedResources(CmsDbContext dbc, String poolName, CmsSubscriptionFilter filter)
protected List<CmsResource>	CmsVfsDriver.readTypesInResourceTree(CmsDbContext dbc, CmsUUID projectId, String parentPath, List<Integer> types, CmsResourceState state, long lastModifiedAfter, long lastModifiedBefore, long releasedAfter, long releasedBefore, long expiredAfter, long expiredBefore, int mode)	Reads all resources inside a given project matching the criteria specified by parameter values.

Methods in org.opencms.db.generic with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsUserDriver.addResourceToOrganizationalUnit(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, CmsResource resource)
protected void	CmsVfsDriver.checkWritePermissionsInFolder(CmsDbContext dbc, CmsResource folder)	Checks that the current user has write permissions for all subresources of the given folder.
CmsResource	CmsVfsDriver.createResource(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, byte[] content)
void	CmsVfsDriver.createSibling(CmsDbContext dbc, CmsProject project, CmsResource resource)
void	CmsVfsDriver.deletePropertyObjects(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, int deleteOption)
void	CmsVfsDriver.deleteRelations(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, CmsRelationFilter filter)
protected CmsResourceState	CmsProjectDriver.fixMovedResource(CmsDbContext dbc, CmsProject onlineProject, CmsResource offlineResource, CmsUUID publishHistoryId, int publishTag)	Checks if the given resource (by id) is available in the online project, if there exists a resource with a different path (a moved file), then the online entry is moved to the right (new) location before publishing.
long	CmsSubscriptionDriver.getDateLastVisitedBy(CmsDbContext dbc, String poolName, CmsUser user, CmsResource resource)
List<CmsOrganizationalUnit>	CmsVfsDriver.getResourceOus(CmsDbContext dbc, CmsUUID projectId, CmsResource resource)	Returns all organizational units for the given resource.
protected CmsOrganizationalUnit	CmsUserDriver.internalCreateOrgUnitFromResource(CmsDbContext dbc, CmsResource resource)	Returns the organizational unit represented by the given resource.
protected void	CmsUserDriver.internalDeleteOrgUnitResource(CmsDbContext dbc, CmsResource resource)	Deletes a resource representing a organizational unit, offline AND online.
protected CmsResourceState	CmsVfsDriver.internalReadResourceState(CmsDbContext dbc, CmsUUID projectId, CmsResource resource)	Returns the resource state of the given resource.
protected CmsResourceState	CmsVfsDriver.internalReadStructureState(CmsDbContext dbc, CmsUUID projectId, CmsResource resource)	Returns the structure state of the given resource.
protected void	CmsVfsDriver.internalRemoveFolder(CmsDbContext dbc, CmsProject currentProject, CmsResource resource)	Removes a resource physically in the database.
protected void	CmsProjectDriver.internalResetResourceState(CmsDbContext dbc, CmsResource resource)	Resets the state to UNCHANGED for a specified resource.
protected List<String>	CmsUserDriver.internalResourcesForOrgUnit(CmsDbContext dbc, CmsResource ouResource)	Returns the list of root paths associated to the organizational unit represented by the given resource.
protected void	CmsVfsDriver.internalUpdateVersions(CmsDbContext dbc, CmsResource resource)	Updates the offline version numbers.
protected boolean	CmsHistoryDriver.internalValidateResource(CmsDbContext dbc, CmsResource resource, int publishTag)	Tests if a history resource does exist.
protected void	CmsVfsDriver.internalValidateResourceLength(CmsResource resource)	Validates that the length setting of a resource is always correct.
protected void	CmsProjectDriver.internalWriteHistory(CmsDbContext dbc, CmsResource resource, CmsResourceState state, List<CmsProperty> properties, CmsUUID publishHistoryId, int publishTag)	Writes the needed history entries.
protected void	CmsUserDriver.internalWriteOrgUnitProperty(CmsDbContext dbc, CmsResource resource, CmsProperty property)	Writes a property for an organizational unit resource, online AND offline.
void	CmsSubscriptionDriver.markResourceAsVisitedBy(CmsDbContext dbc, String poolName, CmsResource resource, CmsUser user)
void	CmsVfsDriver.moveResource(CmsDbContext dbc, CmsUUID projectId, CmsResource source, String destinationPath)
protected String	CmsVfsDriver.prepareRelationConditions(CmsUUID projectId, CmsRelationFilter filter, CmsResource resource, List<Object> params, boolean checkSource)	Build the whole WHERE sql statement part for the given relation filter.
protected void	CmsProjectDriver.publishChangedFile(CmsDbContext dbc, CmsProject onlineProject, CmsResource offlineResource, Set<CmsUUID> publishedResourceIds, CmsUUID publishHistoryId, int publishTag)	Publishes a changed file.
protected void	CmsProjectDriver.publishDeletedFile(CmsDbContext dbc, CmsProject onlineProject, CmsResource offlineResource, CmsUUID publishHistoryId, int publishTag)	Publishes a deleted file.
void	CmsProjectDriver.publishFile(CmsDbContext dbc, I_CmsReport report, int m, int n, CmsProject onlineProject, CmsResource offlineResource, Set<CmsUUID> publishedContentIds, CmsUUID publishHistoryId, int publishTag)
CmsFile	CmsProjectDriver.publishFileContent(CmsDbContext dbc, CmsProject offlineProject, CmsProject onlineProject, CmsResource offlineResource, Set<CmsUUID> publishedResourceIds, boolean needToUpdateContent, int publishTag)
protected void	CmsProjectDriver.publishNewFile(CmsDbContext dbc, CmsProject onlineProject, CmsResource offlineResource, Set<CmsUUID> publishedContentIds, CmsUUID publishHistoryId, int publishTag)	Publishes a new file.
void	CmsVfsDriver.publishResource(CmsDbContext dbc, CmsProject onlineProject, CmsResource onlineResource, CmsResource offlineResource)
void	CmsVfsDriver.publishVersions(CmsDbContext dbc, CmsResource resource, boolean firstSibling)
List<CmsResource>	CmsVfsDriver.readChildResources(CmsDbContext dbc, CmsProject currentProject, CmsResource resource, boolean getFolders, boolean getFiles)
CmsProperty	CmsVfsDriver.readPropertyObject(CmsDbContext dbc, String key, CmsProject project, CmsResource resource)
List<CmsProperty>	CmsVfsDriver.readPropertyObjects(CmsDbContext dbc, CmsProject project, CmsResource resource)
List<CmsRelation>	CmsVfsDriver.readRelations(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, CmsRelationFilter filter)
List<CmsResource>	CmsVfsDriver.readSiblings(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, boolean includeDeleted)
List<I_CmsHistoryResource>	CmsSubscriptionDriver.readSubscribedDeletedResources(CmsDbContext dbc, String poolName, CmsUser user, List<CmsGroup> groups, CmsResource parent, boolean includeSubFolders, long deletedFrom)
void	CmsVfsDriver.removeFile(CmsDbContext dbc, CmsUUID projectId, CmsResource resource)
void	CmsVfsDriver.removeFolder(CmsDbContext dbc, CmsProject currentProject, CmsResource resource)
void	CmsUserDriver.removeResourceFromOrganizationalUnit(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, CmsResource resource)
void	CmsVfsDriver.replaceResource(CmsDbContext dbc, CmsResource newResource, byte[] resContent, int newResourceType)
void	CmsSubscriptionDriver.setSubscribedResourceAsDeleted(CmsDbContext dbc, String poolName, CmsResource resource)
void	CmsSubscriptionDriver.subscribeResourceFor(CmsDbContext dbc, String poolName, CmsPrincipal principal, CmsResource resource)
void	CmsVfsDriver.transferResource(CmsDbContext dbc, CmsProject project, CmsResource resource, CmsUUID createdUser, CmsUUID lastModifiedUser)
void	CmsSubscriptionDriver.unsubscribeResourceFor(CmsDbContext dbc, String poolName, CmsPrincipal principal, CmsResource resource)
void	CmsSubscriptionDriver.unsubscribeResourceForAll(CmsDbContext dbc, String poolName, CmsResource resource)
void	CmsVfsDriver.updateRelations(CmsDbContext dbc, CmsProject onlineProject, CmsResource offlineResource)
void	CmsVfsDriver.writeLastModifiedProjectId(CmsDbContext dbc, CmsProject project, CmsUUID projectId, CmsResource resource)
void	CmsHistoryDriver.writeProperties(CmsDbContext dbc, CmsResource resource, List<CmsProperty> properties, int publishTag)
void	CmsVfsDriver.writePropertyObject(CmsDbContext dbc, CmsProject project, CmsResource resource, CmsProperty property)
void	CmsVfsDriver.writePropertyObjects(CmsDbContext dbc, CmsProject project, CmsResource resource, List<CmsProperty> properties)
void	CmsHistoryDriver.writeResource(CmsDbContext dbc, CmsResource resource, List<CmsProperty> properties, int publishTag)
void	CmsVfsDriver.writeResource(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, int changed)
void	CmsVfsDriver.writeResourceState(CmsDbContext dbc, CmsProject project, CmsResource resource, int changed, boolean isPublishing)

Uses of CmsResource in org.opencms.db.mysql

Methods in org.opencms.db.mysql with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsSubscriptionDriver.markResourceAsVisitedBy(CmsDbContext dbc, String poolName, CmsResource resource, CmsUser user)

Uses of CmsResource in org.opencms.db.oracle

Methods in org.opencms.db.oracle with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsSubscriptionDriver.markResourceAsVisitedBy(CmsDbContext dbc, String poolName, CmsResource resource, CmsUser user)

Uses of CmsResource in org.opencms.file

Subclasses of CmsResource in org.opencms.file

Modifier and Type	Class	Description
class	CmsFile	A file resource in the OpenCms VFS.
class	CmsFolder	A folder resource in the OpenCms VFS.

Fields in org.opencms.file with type parameters of type CmsResource

Modifier and Type	Field	Description
protected Map<CmsUUID,CmsResource>	CmsLinkRewriter.m_translationsById	A map from source folder structure ids to corresponding target folder resources.
protected Map<String,CmsResource>	CmsLinkRewriter.m_translationsByPath	A map from source folder root paths to the corresponding target folder resources.

Methods in org.opencms.file that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsResourceBuilder.buildResource()	Builds the resource.
CmsResource	CmsObject.createResource(String resourcename, int type)	Deprecated. Use CmsObject.createResource(String, I_CmsResourceType) instead.
CmsResource	CmsObject.createResource(String resourcename, int type, byte[] content, List<CmsProperty> properties)	Deprecated. Use CmsObject.createResource(String, I_CmsResourceType, byte[], List) instead.
CmsResource	CmsObject.createResource(String sitePath, CmsResource resource, byte[] content, List<CmsProperty> properties)	Creates a resource with the given properties and content.
CmsResource	CmsObject.createResource(String resourcename, I_CmsResourceType type)	Creates a new resource of the given resource type with empty content and no properties.
CmsResource	CmsObject.createResource(String resourcename, I_CmsResourceType type, byte[] content, List<CmsProperty> properties)	Creates a new resource of the given resource type with the provided content and properties.
CmsResource	CmsObject.createSibling(String source, String destination, List<CmsProperty> properties)	Creates a new sibling of the source resource.
CmsResource	CmsResource.getCopy()	Creates a copy of this resource.
CmsResource	CmsRequestContext.getDetailResource()	Gets the detail content resource (or null if no detail content has been loaded).
protected CmsResource	CmsLinkRewriter.getResource(CmsUUID structureId)	Accesses a resource by structure id.
CmsResource	CmsObject.importResource(String resourcename, CmsResource resource, byte[] content, List<CmsProperty> properties)	Imports a resource to the OpenCms VFS.
CmsResource	CmsObject.importResource(String resourcename, I_CmsReport report, CmsResource resource, byte[] content, List<CmsProperty> properties)	Imports a resource to the OpenCms VFS.
CmsResource	CmsObject.readDefaultFile(String resourceNameOrID)	Returns the default resource for the given folder.
CmsResource	CmsObject.readDefaultFile(String resourceNameOrID, CmsResourceFilter filter)	Returns the default resource for the given folder.
CmsResource	CmsObject.readDefaultFile(CmsResource folderResource, CmsResourceFilter resourceFilter)	Returns the default resource for the given folder.
CmsResource	CmsObject.readParentFolder(CmsUUID structureId)	Returns the parent folder to the given structure id.
CmsResource	CmsObject.readResource(String resourcename)	Reads a resource from the VFS, using the CmsResourceFilter.DEFAULT filter.
CmsResource	CmsObject.readResource(String resourcename, CmsResourceFilter filter)	Reads a resource from the VFS, using the specified resource filter.
CmsResource	CmsObject.readResource(CmsUUID structureID)	Reads a resource from the VFS, using the CmsResourceFilter.DEFAULT filter.
CmsResource	CmsObject.readResource(CmsUUID structureID, CmsResourceFilter filter)	Reads a resource from the VFS, using the specified resource filter.

Methods in org.opencms.file that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsObject.changeResourcesInFolderWithProperty(String resourcename, String property, String oldValue, String newValue, boolean recursive)	Returns a list with all sub resources of a given folder that have set the given property, matching the current property's value with the given old value and replacing it by a given new value.
List<CmsResource>	CmsObject.getBlockingLockedResources(String resourceName)	Returns a list of child resources to the given resource that can not be locked by the current user.
List<CmsResource>	CmsObject.getBlockingLockedResources(CmsResource resource)	Returns a list of child resources to the given resource that can not be locked by the current user.
List<CmsResource>	CmsObject.getFilesInFolder(String resourcename)	Returns all file resources contained in a folder.
List<CmsResource>	CmsObject.getFilesInFolder(String resourcename, CmsResourceFilter filter)	Returns all file resources contained in a folder.
List<CmsResource>	CmsObject.getLockedResources(CmsResource resource, CmsLockFilter filter)	Returns all locked resources within a folder or matches the lock of the given resource.
List<CmsResource>	CmsObject.getLockedResourcesWithCache(CmsResource resource, CmsLockFilter filter, Map<String,CmsResource> cache)	Returns all locked resources within a folder or matches the lock of the given resource, but uses a cache for resource lookup.
protected List<CmsPair<CmsResource,CmsResource>>	CmsLinkRewriter.getMatchingResources(String source, String target)	Gets a list of resource pairs whose paths relative to the source/target roots passed match.
protected List<CmsPair<CmsResource,CmsResource>>	CmsLinkRewriter.getMatchingResources(String source, String target)	Gets a list of resource pairs whose paths relative to the source/target roots passed match.
protected Map<String,CmsResource>	CmsLinkRewriter.getResourcesByRelativePath(List<CmsResource> resources, String basePath)	Collects a list of resources in a map where the key for each resource is the path relative to a given folder.
Set<CmsResource>	CmsObject.getResourcesForPrincipal(CmsUUID principalId, CmsPermissionSet permissions, boolean includeAttr)	Returns all resources associated to a given principal via an ACE with the given permissions.
List<CmsResource>	CmsObject.getResourcesInFolder(String resourcename, CmsResourceFilter filter)	Returns all child resources of a resource, that is the resources contained in a folder.
List<CmsResource>	CmsObject.getSubFolders(String resourcename)	Returns all folder resources contained in a folder.
List<CmsResource>	CmsObject.getSubFolders(String resourcename, CmsResourceFilter filter)	Returns all folder resources contained in a folder.
List<CmsResource>	CmsObject.readPath(String path, CmsResourceFilter filter)	Builds a list of resources for a given path.
List<CmsResource>	CmsObject.readPath(CmsResource resource, CmsResourceFilter filter)	Builds a list of resources for a given path.
List<CmsResource>	CmsObject.readProjectView(CmsUUID projectId, CmsResourceState state)	Reads all resources of a project that match a given state from the VFS.
List<CmsResource>	CmsObject.readResources(String resourcename, CmsResourceFilter filter)	Reads all resources below the given path matching the filter criteria, including the full tree below the path.
List<CmsResource>	CmsObject.readResources(String resourcename, CmsResourceFilter filter, boolean readTree)	Reads all resources below the given path matching the filter criteria, including the full tree below the path only in case the readTree parameter is true.
List<CmsResource>	CmsObject.readResources(CmsResource resource, CmsResourceFilter filter, boolean readTree)	Reads all resources below the given resource matching the filter criteria, including the full tree below the path only in case the readTree parameter is true.
List<CmsResource>	CmsObject.readResourcesWithProperty(String propertyDefinition)	Reads all resources that have a value set for the specified property.
List<CmsResource>	CmsObject.readResourcesWithProperty(String path, String propertyDefinition)	Reads all resources that have a value set for the specified property in the given path.
List<CmsResource>	CmsObject.readResourcesWithProperty(String path, String propertyDefinition, String value)	Reads all resources that have a value (containing the specified value) set for the specified property in the given path.
List<CmsResource>	CmsObject.readResourcesWithProperty(String path, String propertyDefinition, String value, CmsResourceFilter filter)	Reads all resources that have a value (containing the specified value) set for the specified property in the given path.
List<CmsResource>	CmsObject.readSiblings(String resourcename, CmsResourceFilter filter)	Returns a list of all siblings of the specified resource, the specified resource being always part of the result set.
List<CmsResource>	CmsObject.readSiblings(CmsResource resource, CmsResourceFilter filter)	Returns a list of all siblings of the specified resource, the specified resource being always part of the result set.
List<CmsResource>	CmsObject.readSiblingsForResourceId(CmsUUID resourceId, CmsResourceFilter filter)	Reads all resources with the given resource id.
protected List<CmsResource>	CmsLinkRewriter.readTree(String rootPath)	Reads the resources in a subtree.

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

Modifier and Type	Method	Description
void	CmsObject.addRelationToResource(CmsResource resource, CmsResource target, String type)	Adds a new relation to the given resource.
void	CmsObject.changeLock(CmsResource resource)	Changes the lock of a resource to the current user, that is "steals" the lock from another user.
protected static void	CmsLinkRewriter.checkIsFolder(CmsResource resource)	Checks whether a given resource is a folder and throws an exception otherwise.
void	CmsObject.chtype(CmsResource resource, I_CmsResourceType type)	Changes the resource type of a resource.
void	CmsObject.copyResourceToProject(CmsResource resource)	Copies a resource to the current project of the user.
CmsResource	CmsObject.createResource(String sitePath, CmsResource resource, byte[] content, List<CmsProperty> properties)	Creates a resource with the given properties and content.
void	CmsObject.deleteRelationsFromResource(CmsResource resource, CmsRelationFilter filter)	Deletes the relations to a given resource.
void	CmsObject.deleteResource(CmsResource res, CmsResource.CmsResourceDeleteMode deletePreserveSiblings)	Deletes a resource.
List<CmsResource>	CmsObject.getBlockingLockedResources(CmsResource resource)	Returns a list of child resources to the given resource that can not be locked by the current user.
protected String	CmsLinkRewriter.getConfiguredEncoding(CmsObject cms, CmsResource resource)	Gets the encoding which is configured at the location of a given resource.
String	CmsObject.getDetailName(CmsResource res, Locale locale, List<Locale> defaultLocales)	Returns the detail name of a resource.
CmsLock	CmsObject.getLock(CmsResource resource)	Returns the edition lock state for a specified resource.
List<CmsResource>	CmsObject.getLockedResources(CmsResource resource, CmsLockFilter filter)	Returns all locked resources within a folder or matches the lock of the given resource.
List<CmsResource>	CmsObject.getLockedResourcesWithCache(CmsResource resource, CmsLockFilter filter, Map<String,CmsResource> cache)	Returns all locked resources within a folder or matches the lock of the given resource, but uses a cache for resource lookup.
List<CmsRelation>	CmsObject.getRelationsForResource(CmsResource resource, CmsRelationFilter filter)	Returns all relations for the given resource matching the given filter.
String	CmsObject.getSitePath(CmsResource resource)	Adjusts the absolute resource root path for the current site.
String	CmsRequestContext.getSitePath(CmsResource resource)	Adjusts the absolute resource root path for the current site.
boolean	CmsObject.hasPermissions(CmsResource resource, CmsPermissionSet requiredPermissions)	Checks if the current user has required permissions to access a given resource.
boolean	CmsObject.hasPermissions(CmsResource resource, CmsPermissionSet requiredPermissions, boolean checkLock, CmsResourceFilter filter)	Checks if the current user has required permissions to access a given resource.
void	CmsObject.importAccessControlEntries(CmsResource resource, List<CmsAccessControlEntry> acEntries)	Writes a list of access control entries as new access control entries of a given resource.
CmsResource	CmsObject.importResource(String resourcename, CmsResource resource, byte[] content, List<CmsProperty> properties)	Imports a resource to the OpenCms VFS.
CmsResource	CmsObject.importResource(String resourcename, I_CmsReport report, CmsResource resource, byte[] content, List<CmsProperty> properties)	Imports a resource to the OpenCms VFS.
protected static boolean	CmsLinkRewriter.isFolder(CmsResource resource)	Helper method to check whether a given resource is a folder.
static boolean	CmsProject.isInsideProject(List<String> projectResources, CmsResource resource)	Checks if the full resource name (including the site root) of a resource matches any of the project resources of a project.
boolean	CmsResourceFilter.isValid(CmsRequestContext context, CmsResource resource)	Validates if a CmsResource fits to all filer settings.
void	CmsObject.lockResource(CmsResource resource)	Locks a resource.
void	CmsObject.lockResourceShallow(CmsResource resource)	Locks the given resource with a shallow lock that is not inherited on subresources.
void	CmsObject.lockResourceTemporary(CmsResource resource)	Locks a resource temporary.
List<I_CmsHistoryResource>	CmsObject.readAllAvailableVersions(CmsResource resource)	Reads all available versions for a given resource.
CmsResource	CmsObject.readDefaultFile(CmsResource folderResource, CmsResourceFilter resourceFilter)	Returns the default resource for the given folder.
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).
List<CmsResource>	CmsObject.readPath(CmsResource resource, CmsResourceFilter filter)	Builds a list of resources for a given path.
CmsProperty	CmsObject.readPropertyObject(CmsResource resource, String property, boolean search)	Reads a property object from a resource specified by a property name.
CmsProperty	CmsObject.readPropertyObject(CmsResource resource, String property, boolean search, Locale locale)	Reads the locale specific version of a property object from a resource specified by a property name.
List<CmsProperty>	CmsObject.readPropertyObjects(CmsResource resource, boolean search)	Reads all property objects from a resource.
List<CmsResource>	CmsObject.readResources(CmsResource resource, CmsResourceFilter filter, boolean readTree)	Reads all resources below the given resource matching the filter criteria, including the full tree below the path only in case the readTree parameter is true.
Set<I_CmsPrincipal>	CmsObject.readResponsiblePrincipals(CmsResource resource)	Returns a set of principals that are responsible for a specific resource.
Set<CmsUser>	CmsObject.readResponsibleUsers(CmsResource resource)	Returns a set of users that are responsible for a specific resource.
List<CmsResource>	CmsObject.readSiblings(CmsResource resource, CmsResourceFilter filter)	Returns a list of all siblings of the specified resource, the specified resource being always part of the result set.
protected void	CmsLinkRewriter.rewriteLinks(CmsResource resource, Collection<CmsRelation> relations)	Rewrites the links for a single resource.
protected void	CmsLinkRewriter.rewriteOtherRelations(CmsResource res, Collection<CmsRelation> relations)	Rewrites relations which are not derived from links in the content itself.
void	CmsObject.setDateExpired(CmsResource resource, long dateExpired, boolean recursive)	Changes the "expire" date of a resource.
void	CmsObject.setDateReleased(CmsResource resource, long dateReleased, boolean recursive)	Changes the "release" date of a resource.
void	CmsRequestContext.setDetailResource(CmsResource detailResource)	Sets the detail content resource.
void	CmsObject.setRestricted(CmsResource res, String groupName, boolean restricted)	Sets/clears the 'restricted' status for the given resource and group.
void	CmsObject.unlockResource(CmsResource resource)	Unlocks a resource.
void	CmsObject.writeProjectLastModified(CmsResource resource, CmsProject project)	Writes the 'projectlastmodified' field of a resource record.
void	CmsObject.writePropertyObjects(CmsResource res, List<CmsProperty> properties)	Writes a list of properties for a specified resource.
void	CmsObject.writeResource(CmsResource resource)	Writes a resource.

Method parameters in org.opencms.file with type arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsObject.getLockedResourcesWithCache(CmsResource resource, CmsLockFilter filter, Map<String,CmsResource> cache)	Returns all locked resources within a folder or matches the lock of the given resource, but uses a cache for resource lookup.
protected Map<String,CmsResource>	CmsLinkRewriter.getResourcesByRelativePath(List<CmsResource> resources, String basePath)	Collects a list of resources in a map where the key for each resource is the path relative to a given folder.

Constructors in org.opencms.file with parameters of type CmsResource

Modifier	Constructor	Description
	CmsFile(CmsResource resource)	Constructor, creates a new file Object from the given resource with an empty byte array as file content, if the resource does not implement a file.
	CmsFolder(CmsResource resource)	Constructor, creates a new CmsFolder Object from the given CmsResource.

Uses of CmsResource in org.opencms.file.collectors

Fields in org.opencms.file.collectors with type parameters of type CmsResource

Modifier and Type	Field	Description
static final Comparator<CmsResource>	CmsCategoryResourceCollector.COMPARE_DATE_RELEASED_DESC	Compares the release date of resources in descending order.

Methods in org.opencms.file.collectors that return types with arguments of type CmsResource

Modifier and Type	Method	Description
protected List<CmsResource>	CmsChangedResourceCollector.allChangedInFolderDate(CmsObject cms, String param, boolean tree, boolean asc, int numResults)	Returns a List of all changed resources in the folder pointed to by the parameter sorted by the date attributes specified in the parameter.
protected List<CmsResource>	CmsDateResourceCollector.allInFolderDate(CmsObject cms, String param, boolean tree, boolean asc, int numResults)	Returns a List of all resources in the folder pointed to by the parameter sorted by the selected dates.
protected List<CmsResource>	CmsDefaultResourceCollector.allInFolderDateReleasedDesc(CmsObject cms, String param, boolean tree, int numResults)	Returns a List of all resources in the folder pointed to by the parameter sorted by the release date, descending.
protected List<CmsResource>	CmsDefaultResourceCollector.allInFolderNavPos(CmsObject cms, String param, boolean readSubTree, int numResults)	Collects all resources in a folder (or subtree) sorted by the NavPos property.
protected List<CmsResource>	CmsPriorityResourceCollector.allInFolderPriorityDate(CmsObject cms, String param, boolean tree, boolean asc, int numResults)	Returns a list of all resource in a specified folder sorted by priority, then date ascending or descending.
protected List<CmsResource>	CmsPriorityResourceCollector.allInFolderPriorityTitle(CmsObject cms, String param, boolean tree, int numResults)	Returns a list of all resource in a specified folder sorted by priority descending, then Title ascending.
protected List<CmsResource>	CmsCategoryResourceCollector.allKeyValuePairFiltered(CmsObject cms, String param, int numResults)	Collects all resources for the given categories filtered and sorted by the given collector parameter.
protected List<CmsResource>	CmsPriorityResourceCollector.allMappedToUriPriorityDate(CmsObject cms, String param, boolean asc, int numResults)	Returns a list of all resource from specified folder that have been mapped to the currently requested uri, sorted by priority, then date ascending or descending.
protected List<CmsResource>	CmsDefaultResourceCollector.getAllInFolder(CmsObject cms, String param, boolean tree, int numResults)	Returns all resources in the folder pointed to by the parameter.
Set<CmsResource>	A_CmsResourceCollector.getPublishResources(CmsObject cms, I_CmsContentLoadCollectorInfo info)
Set<CmsResource>	I_CmsCollectorPublishListProvider.getPublishResources(CmsObject cms, I_CmsContentLoadCollectorInfo info)	Gets the publish list for the collector.
List<CmsResource>	A_CmsResourceCollector.getResults(CmsObject cms)
List<CmsResource>	CmsCategoryResourceCollector.getResults(CmsObject cms, String collectorName, String param)
List<CmsResource>	CmsCategoryResourceCollector.getResults(CmsObject cms, String collectorName, String param, int numResults)
List<CmsResource>	CmsChangedResourceCollector.getResults(CmsObject cms, String collectorName, String param)
List<CmsResource>	CmsChangedResourceCollector.getResults(CmsObject cms, String collectorName, String param, int numResults)
List<CmsResource>	CmsDateResourceCollector.getResults(CmsObject cms, String collectorName, String param)
List<CmsResource>	CmsDateResourceCollector.getResults(CmsObject cms, String collectorName, String param, int numResults)
List<CmsResource>	CmsDefaultResourceCollector.getResults(CmsObject cms, String collectorName, String param)
List<CmsResource>	CmsDefaultResourceCollector.getResults(CmsObject cms, String collectorName, String param, int numResults)
List<CmsResource>	CmsPriorityResourceCollector.getResults(CmsObject cms, String collectorName, String param)
List<CmsResource>	CmsPriorityResourceCollector.getResults(CmsObject cms, String collectorName, String param, int numResults)
List<CmsResource>	CmsSolrCollector.getResults(CmsObject cms, String collectorName, String param)
List<CmsResource>	CmsSolrCollector.getResults(CmsObject cms, String name, String param, int numResults)
List<CmsResource>	CmsSubscriptionCollector.getResults(CmsObject cms, String collectorName, String param)
List<CmsResource>	CmsSubscriptionCollector.getResults(CmsObject cms, String collectorName, String param, int numResults)
List<CmsResource>	CmsTimeFrameCategoryCollector.getResults(CmsObject cms, String collectorName, String param)
List<CmsResource>	CmsTimeFrameCategoryCollector.getResults(CmsObject cms, String collectorName, String param, int numResults)
List<CmsResource>	I_CmsResourceCollector.getResults(CmsObject cms)	Returns a list of CmsResource Objects that are gathered in the VFS using the default collector name and parameter.
List<CmsResource>	I_CmsResourceCollector.getResults(CmsObject cms, String collectorName, String param)	Returns a list of CmsResource Objects that are gathered in the VFS using the named collector.
List<CmsResource>	I_CmsResourceCollector.getResults(CmsObject cms, String collectorName, String params, int numResults)	Returns a list of CmsResource Objects that are gathered in the VFS using the named collector.
protected List<CmsResource>	CmsDefaultResourceCollector.getSingleFile(CmsObject cms, String param)	Returns a List containing the resources pointed to by the parameter.
protected List<CmsResource>	CmsSubscriptionCollector.getSubscribedDeletedResources(CmsObject cms, String param, int numResults)	Returns the subscribed deleted resources according to the collector parameter.
protected List<CmsResource>	CmsSubscriptionCollector.getSubscribedResources(CmsObject cms, String param, int numResults)	Returns the subscribed resources according to the collector parameter.
protected List<CmsResource>	CmsSubscriptionCollector.getVisitedResources(CmsObject cms, String param, int numResults)	Returns the visited resources according to the collector parameter.
protected List<CmsResource>	A_CmsResourceCollector.shrinkToFit(List<CmsResource> result, int maxSize)	Shrinks a List to fit a maximum size.
protected List<CmsResource>	A_CmsResourceCollector.shrinkToFit(List<CmsResource> result, int maxSize, int explicitNumResults)	Shrinks a List to fit a maximum size.

Methods in org.opencms.file.collectors with parameters of type CmsResource

Modifier and Type	Method	Description
static long	CmsDateResourceComparator.calculateDate(CmsObject cms, CmsResource resource, List<String> dateIdentifiers, long defaultValue)	Calculates the date to use for comparison of this resource based on the given date identifiers.
int	CmsDateResourceComparator.compare(CmsResource res0, CmsResource res1)
int	CmsPriorityDateResourceComparator.compare(CmsResource res0, CmsResource res1)
int	CmsPriorityTitleResourceComparator.compare(CmsResource res0, CmsResource res1)
int	CmsPropertyResourceComparator.compare(CmsResource res0, CmsResource res1)
void	CmsAddCategoriesPostCreateHandler.onCreate(CmsObject cms, CmsResource createdResource, boolean copyMode)
void	CmsAddCategoriesPostCreateHandler.onCreate(CmsObject cms, CmsResource createdResource, boolean copyMode, String config)	Adds the categories specified via config to the newly created resource iff not in copy mode.
void	CmsDefaultPostCreateHandler.onCreate(CmsObject cms, CmsResource createdResource, boolean copyMode)
void	I_CmsCollectorPostCreateHandler.onCreate(CmsObject cms, CmsResource createdResource, boolean copyMode)	This is called after the new content has been created (and possibly already been filled with content).
default void	I_CmsCollectorPostCreateHandler.onCreate(CmsObject cms, CmsResource createdResource, boolean copyMode, String config)	This is called after the new content has been created (and possibly already been filled with content).

Method parameters in org.opencms.file.collectors with type arguments of type CmsResource

Modifier and Type	Method	Description
protected List<CmsResource>	A_CmsResourceCollector.shrinkToFit(List<CmsResource> result, int maxSize)	Shrinks a List to fit a maximum size.
protected List<CmsResource>	A_CmsResourceCollector.shrinkToFit(List<CmsResource> result, int maxSize, int explicitNumResults)	Shrinks a List to fit a maximum size.

Uses of CmsResource in org.opencms.file.history

Subclasses of CmsResource in org.opencms.file.history

Modifier and Type	Class	Description
class	CmsHistoryFile	A historical version of a file in the OpenCms VFS resource history.
class	CmsHistoryFolder	A historical version of a file in the OpenCms VFS resource history.

Methods in org.opencms.file.history that return CmsResource

Modifier and Type	Method	Description
static CmsResource	CmsHistoryResourceHandler.getResourceWithHistory(CmsObject cms, String resourceUri)	Returns the correct resource for the given URI, taken into account historical versions marked by the version parameter.
CmsResource	CmsHistoryResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)

Methods in org.opencms.file.history with parameters of type CmsResource

Modifier and Type	Method	Description
CmsResource	CmsHistoryResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)

Constructors in org.opencms.file.history with parameters of type CmsResource

Modifier	Constructor	Description
	CmsHistoryFile(CmsResource resource)	Creates a dummy historical file from the given resource.

Uses of CmsResource in org.opencms.file.types

Methods in org.opencms.file.types that return CmsResource

Modifier and Type	Method	Description
protected CmsResource	A_CmsResourceType.createRelations(CmsObject cms, CmsSecurityManager securityManager, String resourceName, boolean updateSiblingState)	Creates the relation information for the resource with the given resource name.
CmsResource	A_CmsResourceType.createResource(CmsObject cms, CmsSecurityManager securityManager, String resourcename, byte[] content, List<CmsProperty> properties)
CmsResource	A_CmsResourceTypeFolderBase.createResource(CmsObject cms, CmsSecurityManager securityManager, String resourcename, byte[] content, List<CmsProperty> properties)
CmsResource	CmsResourceTypeImage.createResource(CmsObject cms, CmsSecurityManager securityManager, String resourcename, byte[] content, List<CmsProperty> properties)
CmsResource	CmsResourceTypeXmlContainerPage.createResource(CmsObject cms, CmsSecurityManager securityManager, String resourcename, byte[] content, List<CmsProperty> properties)
CmsResource	CmsResourceTypeXmlContent.createResource(CmsObject cms, CmsSecurityManager securityManager, String resourcename, byte[] content, List<CmsProperty> properties)
CmsResource	CmsResourceTypeXmlPage.createResource(CmsObject cms, CmsSecurityManager securityManager, String resourcename, byte[] content, List<CmsProperty> properties)
CmsResource	I_CmsResourceType.createResource(CmsObject cms, CmsSecurityManager securityManager, String resourcename, byte[] content, List<CmsProperty> properties)	Creates a new resource of the given resource type with the provided content and properties.
CmsResource	A_CmsResourceType.createSibling(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, String destination, List<CmsProperty> properties)
CmsResource	I_CmsResourceType.createSibling(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, String destination, List<CmsProperty> properties)	Creates a new sibling of the source resource.
CmsResource	A_CmsResourceType.importResource(CmsObject cms, CmsSecurityManager securityManager, I_CmsReport report, String resourcename, CmsResource resource, byte[] content, List<CmsProperty> properties)
CmsResource	CmsResourceTypeImage.importResource(CmsObject cms, CmsSecurityManager securityManager, I_CmsReport report, String resourcename, CmsResource resource, byte[] content, List<CmsProperty> properties)
CmsResource	I_CmsResourceType.importResource(CmsObject cms, CmsSecurityManager securityManager, I_CmsReport report, String resourcename, CmsResource resource, byte[] content, List<CmsProperty> properties)	Imports a resource to the OpenCms VFS.

Methods in org.opencms.file.types that return types with arguments of type CmsResource

Modifier and Type	Method	Description
static List<CmsResource>	CmsResourceTypeXmlContent.getModelFiles(CmsObject cms, String currentFolder, String newResourceTypeName)	Returns the possible model files for the new resource.

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

Modifier and Type	Method	Description
void	A_CmsResourceType.changeLock(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource)
void	I_CmsResourceType.changeLock(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource)	Changes the lock of a resource to the current user, that is "steals" the lock from another user.
void	A_CmsResourceType.chflags(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int flags)
void	I_CmsResourceType.chflags(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int flags)	Changes the resource flags of a resource.
void	A_CmsResourceType.chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type)	Deprecated. Use A_CmsResourceType.chtype(CmsObject, CmsSecurityManager, CmsResource, I_CmsResourceType) instead.
void	A_CmsResourceType.chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, I_CmsResourceType type)
void	A_CmsResourceTypeFolderBase.chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource filename, int newType)
void	CmsResourceTypeJsp.chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type)
void	CmsResourceTypePlain.chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type)
void	I_CmsResourceType.chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type)	Deprecated. Use I_CmsResourceType.chtype(CmsObject, CmsSecurityManager, CmsResource, I_CmsResourceType) instead.
void	I_CmsResourceType.chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, I_CmsResourceType type)	Changes the resource type of a resource.
void	A_CmsResourceType.copyResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, String destination, CmsResource.CmsResourceCopyMode siblingMode)
void	A_CmsResourceTypeFolderBase.copyResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, String destination, CmsResource.CmsResourceCopyMode siblingMode)
void	I_CmsResourceType.copyResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, String destination, CmsResource.CmsResourceCopyMode siblingMode)	Copies a resource.
void	A_CmsResourceType.copyResourceToProject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource)
void	I_CmsResourceType.copyResourceToProject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource)	Copies a resource to the current project of the user.
CmsResource	A_CmsResourceType.createSibling(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, String destination, List<CmsProperty> properties)
CmsResource	I_CmsResourceType.createSibling(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, String destination, List<CmsProperty> properties)	Creates a new sibling of the source resource.
void	A_CmsResourceType.deleteResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode)
void	CmsResourceTypeJsp.deleteResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode)
void	CmsResourceTypePlain.deleteResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode)
void	CmsResourceTypeXmlContent.deleteResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode)
void	I_CmsResourceType.deleteResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode)	Deletes a resource given its name.
CmsFormatterConfiguration	A_CmsResourceType.getFormattersForResource(CmsObject cms, CmsResource res)
CmsFormatterConfiguration	CmsResourceTypeJsp.getFormattersForResource(CmsObject cms, CmsResource res)
CmsFormatterConfiguration	CmsResourceTypeXmlContent.getFormattersForResource(CmsObject cms, CmsResource resource)
CmsFormatterConfiguration	I_CmsResourceType.getFormattersForResource(CmsObject cms, CmsResource resource)	Returns the formatter configuration for the given resource.
protected Set<String>	CmsResourceTypeJsp.getReferencingStrongLinks(CmsObject cms, CmsResource resource)	Returns a set of root paths of files that are including the given resource using the 'link.strong' macro.
protected Set<String>	CmsResourceTypePlain.getReferencingStrongLinks(CmsObject cms, CmsResource resource)	Returns a set of root paths of files that are including the given resource using the 'link.strong' macro.
protected I_CmsResourceType	A_CmsResourceType.getResourceType(CmsResource resource)	Convenience method to get the initialized resource type instance for the given resource, with a fall back to special "unknown" resource types in case the resource type is not configured.
CmsResource	A_CmsResourceType.importResource(CmsObject cms, CmsSecurityManager securityManager, I_CmsReport report, String resourcename, CmsResource resource, byte[] content, List<CmsProperty> properties)
CmsResource	CmsResourceTypeImage.importResource(CmsObject cms, CmsSecurityManager securityManager, I_CmsReport report, String resourcename, CmsResource resource, byte[] content, List<CmsProperty> properties)
CmsResource	I_CmsResourceType.importResource(CmsObject cms, CmsSecurityManager securityManager, I_CmsReport report, String resourcename, CmsResource resource, byte[] content, List<CmsProperty> properties)	Imports a resource to the OpenCms VFS.
static boolean	CmsResourceTypeXmlContainerPage.isContainerPage(CmsResource resource)	Returns true in case the given resource is a container page.
static boolean	CmsResourceTypeFunctionConfig.isFunction(CmsResource res)	Checks if a resource has this type.
static boolean	CmsResourceTypeJsp.isJsp(CmsResource resource)	Returns true in case the given resource is a JSP.
static boolean	CmsResourceTypeXmlContainerPage.isModelCopyGroup(CmsObject cms, CmsResource resource)	Checks whether the given resource is a model reuse group.
static boolean	CmsResourceTypeXmlContainerPage.isModelGroup(CmsResource resource)	Checks whether the given resource is a model group.
static boolean	CmsResourceTypeHtmlRedirect.isRedirect(CmsResource resource)	Checks if the given resource is a htmlredirect.
static boolean	CmsResourceTypeFolderSubSitemap.isSubSitemap(CmsResource resource)	Returns true in case the given resource is a sub site map.
static boolean	CmsResourceTypeXmlContent.isXmlContent(CmsResource resource)	Returns true in case the given resource is an XML content.
static boolean	CmsResourceTypeXmlPage.isXmlPage(CmsResource resource)	Returns true in case the given resource is an XML page.
void	A_CmsResourceType.lockResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsLockType type)
void	I_CmsResourceType.lockResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsLockType type)	Locks a resource.
void	A_CmsResourceType.moveResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, String destination)
void	A_CmsResourceTypeFolderBase.moveResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, String destination)
void	CmsResourceTypeJsp.moveResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, String destination)
void	CmsResourceTypePlain.moveResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, String destination)
void	CmsResourceTypeXmlContent.moveResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, String destination)
void	I_CmsResourceType.moveResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, String destination)	Moves a resource to the given destination.
void	A_CmsResourceType.removeResourceFromProject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource)
void	I_CmsResourceType.removeResourceFromProject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource)	Removes a resource from the current project of the user.
void	A_CmsResourceType.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, List<CmsProperty> properties)	Deprecated. Use A_CmsResourceType.replaceResource(CmsObject, CmsSecurityManager, CmsResource, I_CmsResourceType, byte[], List) instead.
void	A_CmsResourceType.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, I_CmsResourceType type, byte[] content, List<CmsProperty> properties)
void	A_CmsResourceTypeFolderBase.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, List<CmsProperty> properties)
void	CmsResourceTypeImage.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, List<CmsProperty> properties)
void	CmsResourceTypeJsp.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, List<CmsProperty> properties)
void	CmsResourceTypePlain.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, List<CmsProperty> properties)
void	I_CmsResourceType.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, List<CmsProperty> properties)	Deprecated. Use I_CmsResourceType.replaceResource(CmsObject, CmsSecurityManager, CmsResource, I_CmsResourceType, byte[], List) instead.
void	I_CmsResourceType.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, I_CmsResourceType type, byte[] content, List<CmsProperty> properties)	Replaces the content, type and properties of a resource.
void	A_CmsResourceType.restoreResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int version)
void	CmsResourceTypeJsp.restoreResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int version)
void	CmsResourceTypePlain.restoreResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int version)
void	I_CmsResourceType.restoreResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int version)	Restores a resource in the current project with a version from the historical archive.
void	A_CmsResourceType.setDateExpired(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateExpired, boolean recursive)
void	A_CmsResourceTypeFolderBase.setDateExpired(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive)
void	CmsResourceTypeJsp.setDateExpired(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateExpired, boolean recursive)
void	CmsResourceTypePlain.setDateExpired(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateExpired, boolean recursive)
void	CmsResourceTypeXmlContent.setDateExpired(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateExpired, boolean recursive)
void	I_CmsResourceType.setDateExpired(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateExpired, boolean recursive)	Changes the "expire" date of a resource.
void	A_CmsResourceType.setDateLastModified(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive)
void	A_CmsResourceTypeFolderBase.setDateLastModified(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive)
void	CmsResourceTypeJsp.setDateLastModified(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive)
void	CmsResourceTypePlain.setDateLastModified(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive)
void	I_CmsResourceType.setDateLastModified(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive)	Changes the "last modified" date of a resource.
void	A_CmsResourceType.setDateReleased(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateReleased, boolean recursive)
void	A_CmsResourceTypeFolderBase.setDateReleased(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive)
void	CmsResourceTypeJsp.setDateReleased(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateReleased, boolean recursive)
void	CmsResourceTypePlain.setDateReleased(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateReleased, boolean recursive)
void	CmsResourceTypeXmlContent.setDateReleased(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateReleased, boolean recursive)
void	I_CmsResourceType.setDateReleased(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateReleased, boolean recursive)	Changes the "release" date of a resource.
void	A_CmsResourceType.undelete(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, boolean recursive)
void	A_CmsResourceTypeFolderBase.undelete(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, boolean recursive)
void	I_CmsResourceType.undelete(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, boolean recursive)	Undeletes a resource.
void	A_CmsResourceType.undoChanges(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceUndoMode mode)
void	A_CmsResourceTypeFolderBase.undoChanges(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceUndoMode mode)
void	CmsResourceTypeJsp.undoChanges(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceUndoMode mode)
void	CmsResourceTypePlain.undoChanges(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceUndoMode mode)
void	I_CmsResourceType.undoChanges(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceUndoMode mode)	Undos all changes in the resource by restoring the version from the online project to the current offline project.
void	A_CmsResourceType.unlockResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource)
void	I_CmsResourceType.unlockResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource)	Unlocks a resource.
protected void	A_CmsResourceType.updateRelationForUndo(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource)	Update the relations after an undo changes operation.
void	A_CmsResourceType.writePropertyObject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsProperty property)
void	I_CmsResourceType.writePropertyObject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsProperty property)	Writes a property for a specified resource.
void	A_CmsResourceType.writePropertyObjects(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, List<CmsProperty> properties)
void	I_CmsResourceType.writePropertyObjects(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, List<CmsProperty> properties)	Writes a list of properties for a specified resource.

Uses of CmsResource in org.opencms.file.wrapper

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

Modifier and Type	Method	Description
protected CmsResource	CmsResourceWrapperModules.createFakeBinaryFile(String rootPath)	Creates a fake CmsResource of type 'binary'.
protected CmsResource	CmsResourceWrapperModules.createFakeBinaryFile(String rootPath, long dateLastModified)	Creates a fake CmsResource of type 'binary'.
protected CmsResource	CmsResourceWrapperModulesNonLazy.createFakeBinaryFile(String rootPath)	Creates a fake CmsResource of type 'binary'.
protected CmsResource	CmsResourceWrapperModulesNonLazy.createFakeBinaryFile(String rootPath, long dateLastModified)	Creates a fake CmsResource of type 'binary'.
protected CmsResource	CmsResourceWrapperModules.createFakeFolder(String rootPath)	Creates a fake CmsResource of type 'folder'.
protected CmsResource	CmsResourceWrapperModulesNonLazy.createFakeFolder(String rootPath)	Creates a fake CmsResource of type 'folder'.
CmsResource	A_CmsResourceExtensionWrapper.createResource(CmsObject cms, String resourcename, int type, byte[] content, List<CmsProperty> properties)
CmsResource	A_CmsResourceWrapper.createResource(CmsObject cms, String resourcename, int type, byte[] content, List<CmsProperty> properties)
CmsResource	CmsObjectWrapper.createResource(String resourcename, int type)	Creates a new resource of the given resource type with empty content and no properties.
CmsResource	CmsObjectWrapper.createResource(String resourcename, int type, byte[] content, List<CmsProperty> properties)	Creates a new resource of the given resource type with the provided content and properties.
CmsResource	CmsResourceWrapperModules.createResource(CmsObject cms, String resourcename, int type, byte[] content, List<CmsProperty> properties)
CmsResource	CmsResourceWrapperModulesNonLazy.createResource(CmsObject cms, String resourcename, int type, byte[] content, List<CmsProperty> properties)
CmsResource	CmsResourceWrapperPreventCreateNameCI.createResource(CmsObject cms, String resourcepath, int type, byte[] content, List<CmsProperty> properties)
CmsResource	CmsResourceWrapperPreventCreateNameRegex.createResource(CmsObject cms, String resourcepath, int type, byte[] content, List<CmsProperty> properties)
CmsResource	CmsResourceWrapperPropertyFile.createResource(CmsObject cms, String resourcename, int type, byte[] content, List<CmsProperty> properties)
CmsResource	CmsResourceWrapperReplaceDeleted.createResource(CmsObject cms, String resourcename, int type, byte[] content, List<CmsProperty> properties)
CmsResource	CmsResourceWrapperXmlPage.createResource(CmsObject cms, String resourcename, int type, byte[] content, List<CmsProperty> properties)
CmsResource	I_CmsResourceWrapper.createResource(CmsObject cms, String resourcename, int type, byte[] content, List<CmsProperty> properties)	Creates a new resource of the given resource type with the provided content and properties.
CmsResource	CmsWrappedResource.getResource()	Returns the virtual resource.
CmsResource	A_CmsResourceExtensionWrapper.readResource(CmsObject cms, String resourcename, CmsResourceFilter filter)
CmsResource	A_CmsResourceWrapper.readResource(CmsObject cms, String resourcename, CmsResourceFilter filter)
CmsResource	CmsObjectWrapper.readResource(String resourcename, CmsResourceFilter filter)	Reads a resource from the VFS, using the CmsResourceFilter.DEFAULT filter.
CmsResource	CmsObjectWrapper.readResource(CmsUUID structureID, CmsResourceFilter filter)	Delegate method for CmsObject.readResource(CmsUUID, CmsResourceFilter).
CmsResource	CmsResourceWrapperModules.readResource(CmsObject cms, String resourcepath, CmsResourceFilter filter)
CmsResource	CmsResourceWrapperModulesNonLazy.readResource(CmsObject cms, String resourcepath, CmsResourceFilter filter)
CmsResource	CmsResourceWrapperPropertyFile.readResource(CmsObject cms, String resourcename, CmsResourceFilter filter)
CmsResource	CmsResourceWrapperSystemFolder.readResource(CmsObject cms, String resourcename, CmsResourceFilter filter)
CmsResource	CmsResourceWrapperXmlPage.readResource(CmsObject cms, String resourcename, CmsResourceFilter filter)
CmsResource	I_CmsResourceWrapper.readResource(CmsObject cms, String resourcename, CmsResourceFilter filter)	Reads a resource from the VFS, using the specified resource filter.
CmsResource	A_CmsResourceExtensionWrapper.wrapResource(CmsObject cms, CmsResource res)
CmsResource	A_CmsResourceWrapper.wrapResource(CmsObject cms, CmsResource resource)
CmsResource	CmsResourceWrapperXmlPage.wrapResource(CmsObject cms, CmsResource res)
CmsResource	I_CmsResourceWrapper.wrapResource(CmsObject cms, CmsResource resource)	Changes the given resource based on the implementation of this wrapper.

Methods in org.opencms.file.wrapper that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	A_CmsResourceWrapper.addResourcesToFolder(CmsObject cms, String resourcename, CmsResourceFilter filter)
List<CmsResource>	CmsResourceWrapperModules.addResourcesToFolder(CmsObject cms, String resourcename, CmsResourceFilter filter)
List<CmsResource>	CmsResourceWrapperModulesNonLazy.addResourcesToFolder(CmsObject cms, String resourcename, CmsResourceFilter filter)
List<CmsResource>	CmsResourceWrapperPropertyFile.addResourcesToFolder(CmsObject cms, String resourcename, CmsResourceFilter filter)
List<CmsResource>	CmsResourceWrapperSystemFolder.addResourcesToFolder(CmsObject cms, String resourcename, CmsResourceFilter filter)
List<CmsResource>	CmsResourceWrapperXmlPage.addResourcesToFolder(CmsObject cms, String resourcename, CmsResourceFilter filter)
List<CmsResource>	I_CmsResourceWrapper.addResourcesToFolder(CmsObject cms, String resourcename, CmsResourceFilter filter)	Here it is possible to add additional (virtual) child resources to those already existing in the VFS.
List<CmsResource>	CmsObjectWrapper.getResourcesInFolder(String resourcename, CmsResourceFilter filter)	Returns all child resources of a resource, that is the resources contained in a folder.

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

Modifier and Type	Method	Description
static CmsFile	CmsResourceWrapperUtils.createPropertyFile(CmsObject cms, CmsResource res, String path)	Creates a virtual CmsFile with the individual and shared properties as content.
CmsLock	A_CmsResourceExtensionWrapper.getLock(CmsObject cms, CmsResource resource)
CmsLock	A_CmsResourceWrapper.getLock(CmsObject cms, CmsResource resource)
CmsLock	CmsObjectWrapper.getLock(CmsResource resource)	Returns the lock state for a specified resource.
CmsLock	CmsResourceWrapperModules.getLock(CmsObject cms, CmsResource resource)
CmsLock	CmsResourceWrapperModulesNonLazy.getLock(CmsObject cms, CmsResource resource)
CmsLock	CmsResourceWrapperPropertyFile.getLock(CmsObject cms, CmsResource resource)
CmsLock	CmsResourceWrapperXmlPage.getLock(CmsObject cms, CmsResource resource)
CmsLock	I_CmsResourceWrapper.getLock(CmsObject cms, CmsResource resource)	Returns the lock for the resource.
String	CmsObjectWrapper.getSitePath(CmsResource resource)	Delegate method for CmsObject.getSitePath(CmsResource).
protected String	CmsResourceWrapperXmlPage.getUriStyleSheet(CmsObject cms, CmsResource res)	Returns the OpenCms VFS uri of the style sheet of the resource.
protected String	CmsResourceWrapperXmlPage.getUriTemplate(CmsObject cms, CmsResource res)	Returns the OpenCms VFS uri of the template of the resource.
boolean	A_CmsResourceExtensionWrapper.isWrappedResource(CmsObject cms, CmsResource res)
boolean	CmsResourceWrapperModules.isWrappedResource(CmsObject cms, CmsResource res)
boolean	CmsResourceWrapperModulesNonLazy.isWrappedResource(CmsObject cms, CmsResource res)
boolean	CmsResourceWrapperPreventCreateNameCI.isWrappedResource(CmsObject cms, CmsResource res)
boolean	CmsResourceWrapperPreventCreateNameRegex.isWrappedResource(CmsObject cms, CmsResource res)
boolean	CmsResourceWrapperPropertyFile.isWrappedResource(CmsObject cms, CmsResource res)
boolean	CmsResourceWrapperReplaceDeleted.isWrappedResource(CmsObject cms, CmsResource res)
boolean	CmsResourceWrapperSystemFolder.isWrappedResource(CmsObject cms, CmsResource res)
boolean	CmsResourceWrapperXmlPage.isWrappedResource(CmsObject cms, CmsResource res)
boolean	I_CmsResourceWrapper.isWrappedResource(CmsObject cms, CmsResource res)	Is called to check if the given resource is handled by this wrapper.
protected String	CmsResourceWrapperXmlPage.prepareContent(String content, CmsObject cms, CmsResource xmlPage, String path)	Prepare the content of a xml page before returning.
CmsProperty	CmsObjectWrapper.readPropertyObject(CmsResource resource, String property, boolean search)	Delegate method for CmsObject.readPropertyObject(CmsResource, String, boolean).
String	A_CmsResourceExtensionWrapper.rewriteLink(CmsObject cms, CmsResource res)
String	A_CmsResourceWrapper.rewriteLink(CmsObject cms, CmsResource res)
String	CmsResourceWrapperXmlPage.rewriteLink(CmsObject cms, CmsResource res)
String	I_CmsResourceWrapper.rewriteLink(CmsObject cms, CmsResource res)	Returns the link how it is for the resource after using this resource wrapper.
CmsResource	A_CmsResourceExtensionWrapper.wrapResource(CmsObject cms, CmsResource res)
CmsResource	A_CmsResourceWrapper.wrapResource(CmsObject cms, CmsResource resource)
CmsResource	CmsResourceWrapperXmlPage.wrapResource(CmsObject cms, CmsResource res)
CmsResource	I_CmsResourceWrapper.wrapResource(CmsObject cms, CmsResource resource)	Changes the given resource based on the implementation of this wrapper.

Constructors in org.opencms.file.wrapper with parameters of type CmsResource

Modifier	Constructor	Description
	CmsWrappedResource(CmsResource res)	Creates a new virtual resource.

Uses of CmsResource in org.opencms.flex

Methods in org.opencms.flex that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsFlexController.getCmsResource()	This method provides access to the top-level CmsResource of the request which is of a type that supports the FlexCache, i.e.

Methods in org.opencms.flex with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsFlexRequestContextInfo.updateFromResource(CmsResource resource)	Updates the "last modified" date for this context as well as the "expires" date with the values from a given resource.

Constructors in org.opencms.flex with parameters of type CmsResource

Modifier	Constructor	Description
	CmsFlexController(CmsObject cms, CmsResource resource, CmsFlexCache cache, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, boolean streaming, boolean top)	Default constructor.

Uses of CmsResource in org.opencms.gwt

Methods in org.opencms.gwt with parameters of type CmsResource

Modifier and Type	Method	Description
static CmsListInfoBean	CmsVfsService.addLockInfo(CmsObject cms, CmsResource resource, CmsListInfoBean resourceInfo)	Adds the lock state information to the resource info bean.
static CmsListInfoBean	CmsVfsService.addPageInfo(CmsObject cms, CmsResource resource, CmsListInfoBean listInfo)	Gets page information of a resource and adds it to the given list info bean.
protected CmsBrokenLinkBean	CmsBrokenLinkRenderer.createSitemapBrokenLinkBean(CmsResource resource)	Creates a "broken link" bean based on a resource.
protected CmsBrokenLinkBean	CmsVfsService.createSitemapBrokenLinkBean(CmsResource resource)	Creates a "broken link" bean based on a resource.
protected CmsLockActionRecord	CmsGwtService.ensureLock(CmsResource resource)	Locks the given resource with a temporary, if not already locked by the current user.
protected CmsLockActionRecord	CmsGwtService.ensureLock(CmsResource resource, boolean shallow)	Locks the given resource with a temporary, if not already locked by the current user.
static String	CmsIconUtil.getDisplayType(CmsObject cms, CmsResource resource)	Returns the resource type name used to display the resource icon.
static String	CmsVfsService.getNoPreviewReason(CmsObject cms, CmsResource resource)	Returns the no preview reason if there is any.
static CmsListInfoBean	CmsVfsService.getPageInfo(CmsObject cms, CmsResource res)	Gets page information of a resource.
static CmsListInfoBean	CmsVfsService.getPageInfoWithLock(CmsObject cms, CmsResource resource)	Returns a bean to display the org.opencms.gwt.client.ui.CmsListItemWidget including the lock state.
protected List<CmsResourceStatusRelationBean>	CmsDefaultResourceStatusProvider.getSiblings(CmsObject cms, String locale, CmsResource resource)	Gets beans which represents the siblings of a resource.
protected List<CmsResourceStatusRelationBean>	CmsDefaultResourceStatusProvider.getTargets(CmsObject cms, String locale, CmsResource resource, List<CmsUUID> additionalStructureIds)	Gets the list of relation targets for a resource.
protected boolean	CmsPropertyEditorHelper.isWritable(CmsObject cms, CmsResource resource)	Returns whether the current user has write permissions, the resource is lockable or already locked by the current user and is in the current project.
protected CmsVfsEntryBean	CmsVfsService.makeEntryBean(CmsResource resource, boolean root)	Helper method for creating a VFS entry bean from a resource.
static String	CmsVfsService.prepareFileNameForEditor(CmsObject cms, CmsResource res, String pathWithMacros)	Processes a file path, which may have macros in it, so it can be opened by the XML content editor.
List<CmsBrokenLinkBean>	CmsBrokenLinkRenderer.renderBrokenLink(CmsResource target, CmsResource source)	Renders the source of a broken link as a list of CmsBrokenLinkBean instances.
List<CmsBrokenLinkBean>	CmsBrokenLinkRenderer.renderBrokenLinkDefault(CmsResource target, CmsResource source)	The default method for rendering broken link sources.
List<CmsBrokenLinkBean>	CmsBrokenLinkRenderer.renderBrokenLinkGroupContainer(CmsResource target, CmsResource source)	Renders the broken links for a group container.
List<CmsBrokenLinkBean>	CmsBrokenLinkRenderer.renderBrokenLinkInheritanceGroup(CmsResource target, CmsResource source)	Renders broken links from an inheritance group.
protected void	CmsGwtService.tryUnlock(CmsResource resource)	Tries to unlock a resource.
static void	CmsPropertyEditorHelper.updateWysiwygConfig(Map<String,CmsXmlContentProperty> propertyConfig, CmsObject cms, CmsResource resource)	Updates the property configuration for properties using WYSIWYG widgets.

Method parameters in org.opencms.gwt with type arguments of type CmsResource

Modifier and Type	Method	Description
protected List<CmsVfsEntryBean>	CmsVfsService.makeEntryBeans(List<CmsResource> resources, boolean root)	Helper method for creating a list of VFS entry beans from a list of the corresponding resources.

Uses of CmsResource in org.opencms.i18n

Methods in org.opencms.i18n that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsLocaleGroupService.findLocalizationRoot(CmsResource resource)	Tries to find the 'best' localized subsitemap parent folder for a resource.
protected CmsResource	CmsLocaleGroupService.getDefaultFileOrSelf(CmsResource res)	Helper method for reading the default file of a folder.
CmsResource	CmsLocaleGroup.getPrimaryResource()	Gets the primary resource.

Methods in org.opencms.i18n that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsLocaleGroup.getAllResources()	Gets the list of all resources of this group (primary and secondary).
Map<Locale,CmsResource>	CmsLocaleGroup.getResourcesByLocale()	Gets a map which contains the resources of the locale group as keys, indexed by their locale.
Collection<CmsResource>	CmsLocaleGroup.getResourcesForLocale(Locale locale)	Gets the resources of this group which have the given locale.
Set<CmsResource>	CmsLocaleGroup.getSecondaryResources()	Gets the secondary resources of this group.

Methods in org.opencms.i18n with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsLocaleGroupService.attachLocaleGroup(CmsResource secondaryPage, CmsResource primaryPage)	Adds a resource to a locale group.
void	CmsLocaleGroupService.attachLocaleGroupIndirect(CmsResource first, CmsResource second)	Smarter method to connect a resource to a locale group.
CmsLocaleGroupService.Status	CmsLocaleGroupService.checkLinkable(CmsResource firstResource, CmsResource secondResource)	Checks if the two resources are linkable as locale variants and returns an appropriate status
void	CmsLocaleGroupService.detachLocaleGroup(CmsResource firstPage, CmsResource secondPage)	Removes a locale group relation between two resources.
CmsResource	CmsLocaleGroupService.findLocalizationRoot(CmsResource resource)	Tries to find the 'best' localized subsitemap parent folder for a resource.
List<Locale>	CmsLocaleManager.getAvailableLocales(CmsObject cms, CmsResource resource)	Returns an array of available locale names for the given resource.
Locale	CmsLocaleManager.getBestAvailableLocaleForXmlContent(CmsObject cms, CmsResource resource, I_CmsXmlDocument content)	Returns the best available locale present in the given XML content, or the default locale.
protected CmsResource	CmsLocaleGroupService.getDefaultFileOrSelf(CmsResource res)	Helper method for reading the default file of a folder.
Locale	CmsLocaleManager.getDefaultLocale(CmsObject cms, CmsResource resource)	Returns the "the" default locale for the given resource.
List<Locale>	CmsLocaleManager.getDefaultLocales(CmsObject cms, CmsResource resource)	Returns an array of default locales for the given resource.
static Locale	CmsLocaleManager.getMainLocale(CmsObject cms, CmsResource res)	Utility method to get the primary locale for a given resource.
static CmsVfsBundleManager.NameAndLocale	CmsVfsBundleManager.getNameAndLocale(CmsResource bundleRes)	Extracts the locale and base name from a resource's file name.
static List<Locale>	CmsLocaleGroupService.getPossibleLocales(CmsObject cms, CmsResource currentResource)	Helper method for getting the possible locales for a resource.
static final String	CmsLocaleManager.getResourceEncoding(CmsObject cms, CmsResource res)	Returns the content encoding set for the given resource.
CmsLocaleGroup	CmsLocaleGroupService.readDefaultFileLocaleGroup(CmsResource resource)	Reads the locale group of a default file.
CmsLocaleGroup	CmsLocaleGroupService.readLocaleGroup(CmsResource resource)	Reads a locale group from the VFS.

Constructors in org.opencms.i18n with parameters of type CmsResource

Modifier	Constructor	Description
	CmsLocaleGroup(CmsObject cms, CmsResource primaryResource, List<CmsResource> secondaryResources)	Creates a new instance.

Constructor parameters in org.opencms.i18n with type arguments of type CmsResource

Modifier	Constructor	Description
	CmsLocaleGroup(CmsObject cms, CmsResource primaryResource, List<CmsResource> secondaryResources)	Creates a new instance.

Uses of CmsResource in org.opencms.i18n.tools

Methods in org.opencms.i18n.tools that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsContainerPageCopier.getCopiedFolderOrPage()	Gets the copied folder or page.
CmsResource	CmsContainerPageCopier.NoCustomReplacementException.getResource()	Gets the resource for which no replacement was found.
CmsResource	CmsContainerPageCopier.getTargetFolder()	Returns the target folder.

Methods in org.opencms.i18n.tools with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsContainerPageCopier.adjustLocalesForElement(CmsResource elementResource, CmsResource originalResource)	Converts locales for the copied container element.
void	CmsContainerPageCopier.copyPageOnly(CmsResource originalPage, String targetPageRootPath)	Copies the given container page to the provided root path.
CmsContainerElementBean	CmsContainerPageCopier.replaceContainerElement(CmsResource targetPage, CmsContainerElementBean originalElement)	Produces the replacement for a container page element to use in a copy of an existing container page.
void	CmsContainerPageCopier.replaceElements(CmsResource containerPage)	Replaces the elements in the copied container page with copies, if appropriate based on the current copy mode.
void	CmsContainerPageCopier.run(CmsResource source, CmsResource target)	Starts the page copying process.
void	CmsContainerPageCopier.run(CmsResource source, CmsResource target, String targetName)	Starts the page copying process.

Constructors in org.opencms.i18n.tools with parameters of type CmsResource

Modifier	Constructor	Description
	NoCustomReplacementException(CmsResource resource)	Creates a new instance.

Uses of CmsResource in org.opencms.importexport

Fields in org.opencms.importexport declared as CmsResource

Modifier and Type	Field	Description
protected CmsResource	CmsImportVersion10.m_resource	The current imported resource.

Fields in org.opencms.importexport with type parameters of type CmsResource

Modifier and Type	Field	Description
protected List<CmsResource>	CmsImportVersion10.m_parseables	The list of resource to be parsed, this is a global list, which will be handled at the end of the import.
protected List<CmsResource>	CmsImportVersion5.m_parseables	Deprecated. Stores all resources of any type that implements the I_CmsLinkParseable interface.

Methods in org.opencms.importexport that return CmsResource

Modifier and Type	Method	Description
protected CmsResource	CmsImportVersion10.createResourceObjectFromFields(String translatedName, int size)	Create a CmsResource object from the currently set field values.
protected CmsResource	CmsImportVersion5.importResource(String source, String destination, I_CmsResourceType type, String uuidstructure, String uuidresource, long datelastmodified, String userlastmodified, long datecreated, String usercreated, long datereleased, long dateexpired, String flags, List<CmsProperty> properties)	Deprecated. Imports a resource (file or folder) into the cms.

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

Modifier and Type	Method	Description
protected void	CmsExport.appendResourceToManifest(CmsResource resource, boolean source)
protected void	CmsExport.appendResourceToManifest(CmsResource resource, boolean source, boolean isSuperFolder)	Writes the data for a resource (like access-rights) to the manifest.xml file.
protected CmsAccessControlEntry	A_CmsImport.getImportAccessControlEntry(CmsResource res, String id, String allowed, String denied, String flags)	Deprecated. Creates a new access control entry and stores it for later write out.
protected void	A_CmsImport.importAccessControlEntries(CmsResource resource, List<CmsAccessControlEntry> aceList)	Deprecated. Writes already imported access control entries for a given resource.
protected void	CmsImportVersion5.importRelations(CmsResource resource, org.dom4j.Element parentElement)	Deprecated. Reads all the relations of the resource from the manifest.xml file and adds them to the according resource.
protected boolean	CmsExport.isInExportableProject(CmsResource res)	Checks if a resource is belongs to the correct project for exporting.

Method parameters in org.opencms.importexport with type arguments of type CmsResource

Modifier and Type	Method	Description
static void	CmsImportVersion10.parseLinks(CmsObject cms, List<CmsResource> parseables, I_CmsReport report)	Parses the links.
protected void	CmsImportVersion7.sortParseableResources(List<CmsResource> parseables)	Deprecated. Sorts the parsealble resources before we actually parse the links.

Uses of CmsResource in org.opencms.jlan

Methods in org.opencms.jlan with parameters of type CmsResource

Modifier and Type	Method	Description
protected String	CmsJlanNetworkFile.getFullChildPath(CmsResource child)	Adds the name of a child resource to this file's path.

Constructors in org.opencms.jlan with parameters of type CmsResource

Modifier	Constructor	Description
	CmsJlanNetworkFile(CmsObjectWrapper cms, CmsResource resource, String fullName)	Creates a new network file instance.

Uses of CmsResource in org.opencms.jsp

Subclasses of CmsResource in org.opencms.jsp

Modifier and Type	Class	Description
class	CmsJspResourceWrapper	Wrapper subclass of CmsResource with some convenience methods.

Fields in org.opencms.jsp declared as CmsResource

Modifier and Type	Field	Description
protected CmsResource	CmsJspTagFormatter.m_resource	Reference to the last loaded resource element.
protected CmsResource	CmsJspTagResourceLoad.m_resource	Reference to the last loaded resource element.

Fields in org.opencms.jsp with type parameters of type CmsResource

Modifier and Type	Field	Description
protected List<CmsResource>	CmsJspTagResourceLoad.m_collectorResult	The list of collected resource items.

Methods in org.opencms.jsp that return CmsResource

Modifier and Type	Method	Description
protected CmsResource	CmsJspTagResourceLoad.getNextResource()	Returns the next resource from the collector.
CmsResource	CmsJspNavElement.getResource()	Returns the resource.
CmsResource	CmsJspTagContentLoop.getResource()
CmsResource	CmsJspTagResourceLoad.getResource()
CmsResource	I_CmsResourceContainer.getResource()	Returns the currently loaded resource.

Methods in org.opencms.jsp that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsJspTagContentLoop.getCollectorResult()
List<CmsResource>	CmsJspTagResourceLoad.getCollectorResult()
List<CmsResource>	I_CmsResourceContainer.getCollectorResult()	Returns the list of all currently loaded resources (instances of CmsResource).
Set<CmsResource>	CmsJspTagSearch.getPublishResources(CmsObject cms, I_CmsContentLoadCollectorInfo info)
Set<CmsResource>	CmsJspTagSimpleSearch.getPublishResources(CmsObject cms, I_CmsContentLoadCollectorInfo info)
static Set<CmsResource>	CmsJspTagSearch.getPublishResourcesInternal(CmsObject cms, I_CmsContentLoadCollectorInfo info)
static Set<CmsResource>	CmsJspTagSimpleSearch.getPublishResourcesInternal(CmsObject cms, I_CmsContentLoadCollectorInfo info)
protected static List<CmsResource>	CmsJspTagResourceLoad.limitCollectorResult(CmsContentInfoBean contentInfoBean, List<CmsResource> collectorResult)	Limits the collector's result list to the size of a page to be displayed in a JSP.

Methods in org.opencms.jsp with parameters of type CmsResource

Modifier and Type	Method	Description
static void	CmsJspTagDisplay.displayAction(CmsResource elementResource, I_CmsFormatterBean formatter, Map<String,String> settings, boolean cacheable, boolean editable, boolean canCreate, boolean canDelete, String creationSiteMap, String postCreateHandler, String uploadFolder, javax.servlet.jsp.PageContext context, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)	Includes the formatter rendering the given element.
static boolean	CmsJspTagEdit.insertDirectEditStart(CmsObject cms, javax.servlet.jsp.PageContext pageContext, CmsResource resource, boolean canCreate, boolean canDelete, String createType, String creationSitemap, String postCreateHandler, String binaryUploadFolder)	Inserts the opening direct edit tag.
boolean	CmsJspResourceWrapper.isChildResourceOf(CmsResource resource)	Returns true in case this resource is child resource of the provided resource which is assumed to be a folder.
static boolean	CmsJspNavBuilder.isNavLevelFolder(CmsObject cms, CmsResource resource)	Returns whether the given resource is a folder and is marked to be a navigation level folder.
boolean	CmsJspResourceWrapper.isParentFolderOf(CmsResource resource)	Returns true in case this resource is a parent folder of the provided resource.
protected void	CmsJspNavElement.setResource(CmsResource resource)	Sets the resource.
static CmsJspResourceWrapper	CmsJspResourceWrapper.wrap(CmsObject cms, CmsResource res)	Factory method to create a new CmsJspResourceWrapper instance from a CmsResource.

Method parameters in org.opencms.jsp with type arguments of type CmsResource

Modifier and Type	Method	Description
protected static List<CmsResource>	CmsJspTagResourceLoad.limitCollectorResult(CmsContentInfoBean contentInfoBean, List<CmsResource> collectorResult)	Limits the collector's result list to the size of a page to be displayed in a JSP.

Constructors in org.opencms.jsp with parameters of type CmsResource

Modifier	Constructor	Description
	CmsJspNavElement(String sitePath, CmsResource resource, Map<String,String> properties)	Create a new instance of the bean and calls the init method with the provided parameters.
	CmsJspNavElement(String sitePath, CmsResource resource, Map<String,String> properties, int navTreeLevel)	Create a new instance of the bean and calls the init method with the provided parameters.
	CmsJspNavElement(String sitePath, CmsResource resource, Map<String,String> properties, int navTreeLevel, Locale locale)	Create a new instance of the bean and calls the init method with the provided parameters.

Uses of CmsResource in org.opencms.jsp.decorator

Constructors in org.opencms.jsp.decorator with parameters of type CmsResource

Modifier	Constructor	Description
	CmsDecorationMap(CmsObject cms, CmsResource res, CmsDecorationDefintion decDef)	Constructor, creates a new CmsDecorationMap.

Uses of CmsResource in org.opencms.jsp.search.config.parser.simplesearch

Methods in org.opencms.jsp.search.config.parser.simplesearch with parameters of type CmsResource

Modifier and Type	Method	Description
static CmsConfigurationBean	CmsConfigParserUtils.parseListConfiguration(CmsObject cms, CmsResource res)	Parses the list configuration resource.

Uses of CmsResource in org.opencms.jsp.userdata

Methods in org.opencms.jsp.userdata that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsUserDataResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)

Methods in org.opencms.jsp.userdata with parameters of type CmsResource

Modifier and Type	Method	Description
CmsResource	CmsUserDataResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)

Uses of CmsResource in org.opencms.jsp.util

Fields in org.opencms.jsp.util with type parameters of type CmsResource

Modifier and Type	Field	Description
protected Optional<CmsResource>	CmsJspLinkWrapper.m_resource	Cached link target resource.
protected List<CmsResource>	CmsJspResourceLoadBean.m_resources	The list of results of the resource loader.

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

Modifier and Type	Method	Description
static CmsResource	CmsJspElFunctions.convertRawResource(CmsObject cms, Object input)	Returns a resource created from an Object.
static CmsResource	CmsFunctionRenderer.getDefaultFunctionInstance(CmsObject cms)	Cached method for accessing the default function formatter.
static CmsResource	CmsFunctionRenderer.getDefaultFunctionJsp(CmsObject cms)	Cached method for accessing the default function formatter JSP.
CmsResource	CmsJspResourceAccessBean.getResource()	Returns the current resource.
CmsResource	CmsJspStandardContextBean.CmsContainerElementWrapper.getResource()
CmsResource	CmsJspStandardContextBean.TemplateBean.getResource()	Gets the template resource.
protected CmsResource	A_CmsJspCustomContextBean.toResource(Object input)	Convert the input to a CmsResource using the current context.

Methods in org.opencms.jsp.util that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsJspResourceLoadBean.getResources()	Returns a list of CmsResource instances.

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

Modifier and Type	Method	Description
static List<String>	CmsJspContentAttachmentsBean.getAttachmentLocales(CmsObject cms, CmsResource content)	Gets the list of locales for which attachments / detail-only containers are available.
static CmsJspContentAttachmentsBean	CmsJspContentAttachmentsBean.getAttachmentsForCurrentPage(CmsObject cms, CmsResource content)	Gets the attachments / detail-only contents for the current page (i.e.
static CmsJspContentAttachmentsBean	CmsJspContentAttachmentsBean.getAttachmentsForLocale(CmsObject cms, CmsResource content, String locale)	Loads the attachments for a given content.
void	CmsJspContentAccessBean.init(CmsObject cms, Locale locale, I_CmsXmlDocument content, CmsResource resource)	Initialize this instance.
protected void	CmsJspImageBean.init(CmsObject cms, CmsResource imageRes, String scaleParams)	Initializes this new image bean based on a VFS resource and optional scaler parameters.
void	CmsJspResourceAccessBean.init(CmsObject cms, CmsResource resource)	Initialize this instance.
static boolean	CmsJspElFunctions.isSubSitemap(CmsResource resource)	Returns whether the given resource is a sub sitemap folder.
static String	CmsStringTemplateRenderer.renderTemplate(CmsObject cms, String template, CmsResource content, Map<String,Object> contextObjects)	Renders the given string template.
static String	CmsStringTemplateRenderer.renderTemplate(CmsObject cms, String template, CmsResource content, Map<String,Object> contextObjects, String pathPrefix)	Renders the given string template.
protected void	CmsJspImageBean.setResource(CmsObject cms, CmsResource resource)	Sets the CmsResource for this image.

Method parameters in org.opencms.jsp.util with type arguments of type CmsResource

Modifier and Type	Method	Description
static List<CmsJspContentAccessBean>	CmsJspContentLoadBean.convertResourceList(CmsObject cms, List<CmsResource> resources)	Converts a list of CmsResource objects to a list of CmsJspContentAccessBean objects, using the current request context locale.
static List<CmsJspContentAccessBean>	CmsJspContentLoadBean.convertResourceList(CmsObject cms, Locale locale, List<CmsResource> resources)	Converts a list of CmsResource objects to a list of CmsJspContentAccessBean objects, using the given locale.
static List<CmsJspResourceWrapper>	CmsJspElFunctions.convertResourceList(CmsObject cms, List<CmsResource> list)	Returns a list of resource wrappers created from the input list of resources.
void	CmsJspContentLoadBean.init(CmsObject cms, Locale locale, List<CmsResource> content)	Initialize this instance.
void	CmsJspResourceLoadBean.init(CmsObject cms, List<CmsResource> resources)	Initialize this instance.

Constructors in org.opencms.jsp.util with parameters of type CmsResource

Modifier	Constructor	Description
	CmsJspCategoryAccessBean(CmsObject cms, CmsResource resource)	Default constructor.
	CmsJspContentAccessBean(CmsObject cms, Locale locale, CmsResource resource)	Creates a content access bean based on a Resource.
	CmsJspContentAccessBean(CmsObject cms, CmsResource resource)	Creates a content access bean based on a Resource, using the current request context locale.
	CmsJspContentAttachmentsBean(CmsObject cms, CmsResource pageResource)	Initializes this bean with the contents of a detail-only page.
	CmsJspImageBean(CmsObject cms, CmsResource imageRes, String scaleParams)	Initializes a new image bean based on a VFS resource and optional scaler parameters.
	CmsJspResourceAccessBean(CmsObject cms, CmsResource resource)	Creates a content access bean based on a Resource.
	CmsLocalePropertyLoaderTransformer(CmsObject cms, CmsResource resource, boolean search)	Default constructor.
	CmsPropertyLoaderSingleTransformer(CmsResource resource, boolean search)	Creates a new property loading Transformer.
	CmsPropertyLoaderTransformer(CmsObject cms, CmsResource resource, boolean search)	Creates a new property loading Transformer.
	CmsPropertyLoaderTransformer(CmsObject cms, CmsResource resource, boolean search, Locale locale)	Creates a new property loading Transformer.
	TemplateBean(String name, CmsResource resource)	Creates a new instance.

Constructor parameters in org.opencms.jsp.util with type arguments of type CmsResource

Modifier	Constructor	Description
	CmsJspContentLoadBean(CmsObject cms, List<CmsResource> content)	Creates a new context bean using the OpenCms context of the current user.
	CmsJspContentLoadBean(CmsObject cms, Locale locale, List<CmsResource> content)	Creates a new context bean using the OpenCms context of the current user with the given locale.
	CmsJspResourceLoadBean(CmsObject cms, List<CmsResource> resources)	Creates a new context bean using the OpenCms context of the current user.

Uses of CmsResource in org.opencms.loader

Methods in org.opencms.loader that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsTemplateLoaderFacade.getLoaderStartResource()	Returns the loaders start resource.
CmsResource	CmsResourceManager.NamedTemplate.getResource()	Gets the template resource.
CmsResource	CmsTemplateLoaderFacade.getResource()	Returns the resource.
CmsResource	CmsTemplateLoaderFacade.getTemplate()	Returns the template.
protected CmsResource	CmsJspLoader.readJspResource(CmsFlexController controller, String jspName)	Returns the jsp resource identified by the given name, using the controllers cms context.

Methods in org.opencms.loader with parameters of type CmsResource

Modifier and Type	Method	Description
protected boolean	CmsDumpLoader.canSendLastModifiedHeader(CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Checks if the requested resource must be send to the client by checking the "If-Modified-Since" http header.
byte[]	CmsDumpLoader.dump(CmsObject cms, CmsResource resource, String element, Locale locale, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsJspLoader.dump(CmsObject cms, CmsResource file, String element, Locale locale, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsMacroFormatterLoader.dump(CmsObject cms, CmsResource resource, String element, Locale selectedLocale, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsPointerLoader.dump(CmsObject cms, CmsResource resource, String element, Locale locale, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsRedirectLoader.dump(CmsObject cms, CmsResource resource, String element, Locale locale, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	I_CmsResourceLoader.dump(CmsObject cms, CmsResource resource, String element, Locale locale, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Dumps the processed content of the the requested file (and it's sub-elements) to a byte array.
String	I_CmsResourceStringDumpLoader.dumpAsString(CmsObject cms, CmsResource resource, String element, Locale locale, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)	Dumps the processed content of the the requested file (and it's sub-elements) to a String.
byte[]	CmsDumpLoader.export(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsJspLoader.export(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsMacroFormatterLoader.export(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsPointerLoader.export(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsRedirectLoader.export(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	I_CmsResourceLoader.export(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Static exports the contents of the requested file and it's sub-elements.
protected CmsFlexController	CmsJspLoader.getController(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, boolean streaming, boolean top)	Delivers a Flex controller, either by creating a new one, or by re-using an existing one.
protected CmsFlexController	CmsRedirectLoader.getController(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, boolean streaming, boolean top)	Delivers a Flex controller, either by creating a new one, or by re-using an existing one.
I_CmsResourceLoader	CmsResourceManager.getLoader(CmsResource resource)	Returns the loader class instance for a given resource.
void	CmsJspLoader.getReferencingStrongLinks(CmsObject cms, CmsResource resource, Set<String> referencingPaths)	Returns a set of root paths of files that are including the given resource using the 'link.strong' macro.
I_CmsResourceType	CmsResourceManager.getResourceType(CmsResource resource)	Convenience method to get the initialized resource type instance for the given resource, with a fall back to special "unknown" resource types in case the resource type is not configured.
protected CmsFile	CmsImageLoader.getScaledImage(CmsObject cms, CmsResource resource, CmsImageScaler scaler)	Returns a scaled version of the given OpenCms VFS image resource.
CmsTemplateContext	CmsDefaultTemplateContextProvider.getTemplateContext(CmsObject cms, javax.servlet.http.HttpServletRequest request, CmsResource resource)
CmsTemplateContext	CmsTemplateContextManager.getTemplateContext(String providerName, CmsObject cms, javax.servlet.http.HttpServletRequest request, CmsResource resource)	Gets the template context to use.
CmsTemplateContext	CmsTransformerTemplateProvider.getTemplateContext(CmsObject cms, javax.servlet.http.HttpServletRequest request, CmsResource resource)
CmsTemplateContext	I_CmsTemplateContextProvider.getTemplateContext(CmsObject cms, javax.servlet.http.HttpServletRequest request, CmsResource resource)	Determines the template context from the current CMS context, request, and resource.
CmsTemplateLoaderFacade	CmsResourceManager.getTemplateLoaderFacade(CmsObject cms, javax.servlet.http.HttpServletRequest request, CmsResource resource, String templateProperty)	Returns a template loader facade for the given file.
CmsTemplateLoaderFacade	CmsResourceManager.getTemplateLoaderFacade(CmsObject cms, CmsResource resource, String templateProperty)	Returns a template loader facade for the given file.
protected CmsTemplateLoaderFacade	CmsSeoFileLoader.getTemplateLoaderFacade(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req)
void	CmsDumpLoader.load(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	CmsImageLoader.load(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	CmsJspLoader.load(CmsObject cms, CmsResource file, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	CmsMacroFormatterLoader.load(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	CmsPointerLoader.load(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	CmsRedirectLoader.load(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	CmsXmlContainerPageLoader.load(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	I_CmsResourceLoader.load(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Basic top-page processing method for a I_CmsResourceLoader, this method is called if the page is called as a sub-element on a page not already loaded with a I_CmsResourceLoader.
void	CmsResourceManager.loadResource(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Loads the requested resource and writes the contents to the response stream.
String	CmsTemplateContextManager.readPropertyFromTemplate(CmsObject cms, CmsResource res, String propertyName, String fallbackValue)	Utility method which either reads a property from the template used for a specific resource, or from the template context provider used for the resource if available.
void	CmsJspLoader.removeOfflineJspFromRepository(CmsResource resource)	Removes a JSP from an offline project from the RFS.
void	CmsDumpLoader.service(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
void	CmsJspLoader.service(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
void	CmsMacroFormatterLoader.service(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
void	CmsPointerLoader.service(CmsObject cms, CmsResource file, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
void	CmsRedirectLoader.service(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
void	I_CmsResourceLoader.service(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)	Does the job of including the requested resource, this method is called directly if the element is called as a sub-element from another I_CmsResourceLoader.
protected void	CmsJspLoader.showSource(CmsObject cms, CmsResource file, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Delivers the plain uninterpreted resource with escaped XML.
protected I_CmsXmlDocument	CmsSeoFileLoader.unmarshalXmlDocument(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)
protected CmsXmlContainerPage	CmsXmlContainerPageLoader.unmarshalXmlDocument(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)
protected I_CmsXmlDocument	CmsXmlContentLoader.unmarshalXmlDocument(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)
protected I_CmsXmlDocument	CmsXmlPageLoader.unmarshalXmlDocument(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)
String	CmsJspLoader.updateJsp(CmsResource resource, CmsFlexController controller, Set<String> updatedFiles)	Updates a JSP page in the "real" file system in case the VFS resource has changed.
protected boolean	CmsJspLoader.updateStrongLinks(CmsResource resource, CmsFlexController controller, Set<String> updatedFiles)	Updates all jsp files that include the given jsp file using the 'link.strong' macro.

Constructors in org.opencms.loader with parameters of type CmsResource

Modifier	Constructor	Description
	CmsImageScaler(CmsObject cms, CmsResource res)	Creates a new image scaler by reading the property CmsPropertyDefinition.PROPERTY_IMAGE_SIZE from the given resource.
	CmsTemplateLoaderFacade(I_CmsResourceLoader loader, CmsResource resource, CmsResource template)	Creates a new template loader facade.
	NamedTemplate(CmsResource resource, String name)	Creates a new instance.

Uses of CmsResource in org.opencms.lock

Methods in org.opencms.lock that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsLockManager.getLockedResources(CmsDbContext dbc, CmsResource resource, CmsLockFilter filter)	Returns all exclusive locked resources matching the given resource and filter.
List<CmsResource>	CmsLockManager.getLockedResourcesWithCache(CmsDbContext dbc, CmsResource resource, CmsLockFilter filter, Map<String,CmsResource> cache)	Returns all exclusive locked resources matching the given resource and filter, but uses a cache for resource loookups.

Methods in org.opencms.lock with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsLockManager.addResource(CmsDbContext dbc, CmsResource resource, CmsUser user, CmsProject project, CmsLockType type)	Adds a resource to the lock manager.
static CmsLockActionRecord	CmsLockUtil.ensureLock(CmsObject cms, CmsResource resource)	Static helper method to lock a resource.
static CmsLockActionRecord	CmsLockUtil.ensureLock(CmsObject cms, CmsResource resource, boolean shallow)	Static helper method to lock a resource.
CmsLock	CmsLockManager.getLock(CmsDbContext dbc, CmsResource resource)	Returns the lock state of the given resource.
CmsLock	CmsLockManager.getLock(CmsDbContext dbc, CmsResource resource, boolean includeSiblings)	Returns the lock state of the given resource.
List<CmsResource>	CmsLockManager.getLockedResources(CmsDbContext dbc, CmsResource resource, CmsLockFilter filter)	Returns all exclusive locked resources matching the given resource and filter.
List<CmsResource>	CmsLockManager.getLockedResourcesWithCache(CmsDbContext dbc, CmsResource resource, CmsLockFilter filter, Map<String,CmsResource> cache)	Returns all exclusive locked resources matching the given resource and filter, but uses a cache for resource loookups.
boolean	CmsLockManager.hasSystemLocks(CmsDbContext dbc, CmsResource resource)	Returns true if the given resource contains a resource that has a system lock.
static CmsLockUtil.LockedFile	CmsLockUtil.LockedFile.lockResource(CmsObject cms, CmsResource resource)	Lock and read a file.
CmsLock	CmsLockManager.removeResource(CmsDbContext dbc, CmsResource resource, boolean forceUnlock, boolean removeSystemLock)	Removes a resource from the lock manager.
static void	CmsLockUtil.tryUnlock(CmsObject cms, CmsResource resource)	Tries to unlock the given resource.
static AutoCloseable	CmsLockUtil.withLockedResources(CmsObject cms, boolean shallow, CmsResource... resources)	Utility method for locking and unlocking a set of resources conveniently with the try-with syntax from Java 1.7.
static AutoCloseable	CmsLockUtil.withLockedResources(CmsObject cms, CmsResource... resources)	Utility method for locking and unlocking a set of resources conveniently with the try-with syntax from Java 1.7.

Method parameters in org.opencms.lock with type arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsLockManager.getLockedResourcesWithCache(CmsDbContext dbc, CmsResource resource, CmsLockFilter filter, Map<String,CmsResource> cache)	Returns all exclusive locked resources matching the given resource and filter, but uses a cache for resource loookups.

Uses of CmsResource in org.opencms.mail

Constructors in org.opencms.mail with parameters of type CmsResource

Modifier	Constructor	Description
	CmsVfsDataSource(CmsObject cms, CmsResource resource)	Creates a new data source for the given VFS resource.

Uses of CmsResource in org.opencms.main

Methods in org.opencms.main that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsContextInfo.getDetailResource()	Gets the detail content resource.
CmsResource	CmsAliasResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
CmsResource	CmsPermalinkResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
CmsResource	CmsProtectedStaticFileHandler.initResource(CmsResource origRes, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
CmsResource	I_CmsResourceInit.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Possibility to modify or change the CmsFile with the CmsObject.
static CmsResource	OpenCms.initResource(CmsObject cms, String resourceName, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Reads the requested resource from the OpenCms VFS, and in case a directory name is requested, the default files of the directory will be looked up and the first match is returned.
protected CmsResource	OpenCmsCore.initResource(CmsObject cms, String resourceName, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Reads the requested resource from the OpenCms VFS, in case a directory name is requested, the default files of the directory will be looked up and the first match is returned.

Methods in org.opencms.main with parameters of type CmsResource

Modifier and Type	Method	Description
String	CmsProtectedStaticFileHandler.getLink(CmsObject cms, CmsResource resource)
CmsResource	CmsAliasResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
CmsResource	CmsPermalinkResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
CmsResource	CmsProtectedStaticFileHandler.initResource(CmsResource origRes, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
CmsResource	I_CmsResourceInit.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Possibility to modify or change the CmsFile with the CmsObject.
void	CmsContextInfo.setDetailResource(CmsResource detailResource)	Sets the detail content resource.

Uses of CmsResource in org.opencms.module

Methods in org.opencms.module that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsResourceImportData.getImportResource()	Gets the import resource.
CmsResource	CmsResourceImportData.getResource()	Gets the resource.

Methods in org.opencms.module that return types with arguments of type CmsResource

Modifier and Type	Method	Description
static List<CmsResource>	CmsModule.calculateModuleResources(CmsObject cms, CmsModule module)	Calculates and returns the resources belonging to the module, taking excluded resources and readability of resources into account.

Methods in org.opencms.module with parameters of type CmsResource

Modifier and Type	Method	Description
static boolean	CmsModuleUpdater.needToUpdateResourceFields(CmsResource existingRes, CmsResource newRes, boolean reduced)	Check if a resource needs to be updated because of its direct fields.
void	CmsResourceImportData.setImportResource(CmsResource importRes)	Sets the import resource.
boolean	CmsModuleUpdater.updateAcls(CmsObject cms, CmsResourceImportData resData, CmsResource resource)	Updates the access control list fr a resource.

Method parameters in org.opencms.module with type arguments of type CmsResource

Modifier and Type	Method	Description
static void	CmsModule.addCalculatedModuleResources(List<CmsResource> result, CmsObject cms, List<CmsResource> moduleResources, List<String> excludeResources)	Determines the resources that are: accessible with the provided CmsObject, part of the moduleResources (or in a folder of these resources) and not contained in excludedResources (or a folder of these resources). and adds the to result
protected void	CmsModuleUpdater.processDeletions(CmsObject cms, List<CmsResource> toDelete)	Handles the file deletions.

Constructors in org.opencms.module with parameters of type CmsResource

Modifier	Constructor	Description
	CmsResourceImportData(CmsResource resource, String path, byte[] content, List<CmsProperty> properties, List<CmsAccessControlEntry> aces, List<CmsImportVersion10.RelationData> relationData, boolean hasStructureId, boolean hasDateLastModified, String typeName)	Creats a new instance.

Uses of CmsResource in org.opencms.monitor

Methods in org.opencms.monitor that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsMemoryMonitor.getCachedResource(String key)	Returns the resource cached with the given cache key or null if not found.

Methods in org.opencms.monitor that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsMemoryMonitor.getCachedProjectResources(String key)	Returns the project resources list cached with the given cache key or null if not found.
List<CmsResource>	CmsMemoryMonitor.getCachedResourceList(String key)	Returns the resource list cached with the given cache key or null if not found.

Methods in org.opencms.monitor with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsMemoryMonitor.cacheResource(String key, CmsResource resource)	Caches the given resource under the given cache key.

Method parameters in org.opencms.monitor with type arguments of type CmsResource

Modifier and Type	Method	Description
void	CmsMemoryMonitor.cacheProjectResources(String key, List<CmsResource> projectResources)	Caches the given project resource list under the given cache key.
void	CmsMemoryMonitor.cacheResourceList(String key, List<CmsResource> resourceList)	Caches the given resource list under the given cache key.

Uses of CmsResource in org.opencms.newsletter

Methods in org.opencms.newsletter with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsNewsletter.addAttachment(CmsObject cms, CmsResource resource)
void	I_CmsNewsletter.addAttachment(CmsObject cms, CmsResource resource)	Adds a OpenCms resource as an attachment to the newsletter.

Uses of CmsResource in org.opencms.notification

Methods in org.opencms.notification that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsExtendedNotificationCause.getResource()	Returns the resource.

Methods in org.opencms.notification with parameters of type CmsResource

Modifier and Type	Method	Description
static boolean	CmsContentNotification.existsEditor(CmsResource resource)	Returns true, if there exists an editor for a specific resource.
void	CmsExtendedNotificationCause.setResource(CmsResource resource)	Sets the resource.

Constructors in org.opencms.notification with parameters of type CmsResource

Modifier	Constructor	Description
	CmsExtendedNotificationCause(CmsResource resource, int cause, Date date)	Creates a new CmsNotificationResourceInfo.

Uses of CmsResource in org.opencms.pdftools

Methods in org.opencms.pdftools that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsPdfLink.getContent()	Returns the content.
CmsResource	CmsPdfLink.getFormatter()	Gets the formatter resource.
CmsResource	CmsPdfResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods in org.opencms.pdftools with parameters of type CmsResource

Modifier and Type	Method	Description
static byte[]	CmsPdfFormatterUtils.executeJsp(CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, CmsResource jsp, CmsResource content)	Executes a JSP with a given content as input and returns the output of the JSP.
String	CmsPdfCache.getCacheName(CmsResource resource, String parameters)
String	CmsPdfThumbnailCache.getCacheName(CmsResource resource, String parameters)
CmsResource	CmsPdfResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	CmsPdfResourceHandler.logXhtmlOutput(CmsResource formatter, CmsResource content, byte[] xhtmlData)	Logs the XHTML output.

Constructors in org.opencms.pdftools with parameters of type CmsResource

Modifier	Constructor	Description
	CmsPdfLink(CmsObject cms, CmsResource formatter, CmsResource content, String filename)	Creates a new PDF link object based on the formatter and content resources and the locale of the current CMS context.
	CmsPdfThumbnailLink(CmsObject cms, CmsResource pdfResource, int width, int height, String format)	Creates a new thumbnail link for the given resource and options.

Uses of CmsResource in org.opencms.publish

Methods in org.opencms.publish that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsPublishManager.getUsersPubList(CmsObject cms)	Returns the current user's publish list.

Methods in org.opencms.publish with parameters of type CmsResource

Modifier and Type	Method	Description
CmsPublishList	CmsPublishManager.getPublishList(CmsObject cms, CmsResource directPublishResource, boolean directPublishSiblings)	Returns a publish list with all new/changed/deleted resources of the current (offline) project that actually get published for a direct publish of a single resource.
CmsUUID	CmsPublishManager.publishProject(CmsObject cms, I_CmsReport report, CmsResource directPublishResource, boolean directPublishSiblings)	Direct publishes a specified resource.

Method parameters in org.opencms.publish with type arguments of type CmsResource

Modifier and Type	Method	Description
CmsPublishList	CmsPublishManager.getPublishList(CmsObject cms, List<CmsResource> directPublishResources, boolean directPublishSiblings)	Returns a publish list with all new/changed/deleted resources of the current (offline) project that actually get published for a direct publish of a List of resources.
CmsPublishList	CmsPublishManager.getPublishList(CmsObject cms, List<CmsResource> directPublishResources, boolean directPublishSiblings, boolean publishSubResources)	Returns a publish list with all new/changed/deleted resources of the current (offline) project that actually get published for a direct publish of a List of resources.
CmsPublishList	CmsPublishManager.getPublishListAll(CmsObject cms, List<CmsResource> directPublishResources, boolean directPublishSiblings, boolean isUserPublishList)	Returns a publish list with all the given resources, filtered only by state.

Uses of CmsResource in org.opencms.relations

Methods in org.opencms.relations that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsLink.getResource()	Returns the resource this link points to, if it is an internal link and has already been initialized via checkConsistency.
CmsResource	CmsRelation.getSource(CmsObject cms, CmsResourceFilter filter)	Returns the source resource when possible to read with the given filter.
CmsResource	CmsRelation.getTarget(CmsObject cms, CmsResourceFilter filter)	Returns the target resource when possible to read with the given filter.

Methods in org.opencms.relations that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsInternalLinksValidator.getResourcesWithBrokenLinks()	Returns all resources with broken links.
List<CmsResource>	CmsCategoryService.readCategoryResources(CmsObject cms, String categoryPath, boolean recursive, String referencePath)	Reads the resources for a category identified by the given category path.
List<CmsResource>	CmsCategoryService.readCategoryResources(CmsObject cms, String categoryPath, boolean recursive, String referencePath, CmsResourceFilter resFilter)	Reads the resources for a category identified by the given category path.

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

Modifier and Type	Method	Description
protected boolean	CmsRelationSystemValidator.checkLinkForNewOrChangedLinkSource(CmsDbContext dbc, CmsResource resource, CmsRelation relation, String link, CmsProject project, Map<String,CmsResource> fileLookup)	Checks a link from a resource which has changed.
void	CmsCategoryService.copyCategories(CmsObject cms, CmsResource fromResource, String toResourceSitePath)	Adds all categories from one resource to another, skipping categories that are not available for the resource copied to.
CmsRelationFilter	CmsRelationFilter.filterResource(CmsResource resource)	Returns an extended filter with the given resource (path and id) restriction.
CmsCategory	CmsCategoryService.getCategory(CmsObject cms, CmsResource resource)	Creates a category from the given resource.
String	I_CmsCustomLinkRenderer.getLink(CmsObject cms, CmsResource resource)	Returns the link for the given link resource.
List<CmsCategory>	CmsCategoryService.readResourceCategories(CmsObject cms, CmsResource resource)	Reads the categories for a resource.
void	CmsCategoryService.repairRelations(CmsObject cms, CmsResource resource)	Repairs broken category relations.
protected List<CmsRelation>	CmsRelationSystemValidator.validateLinks(CmsDbContext dbc, CmsResource resource, Map<String,CmsResource> fileLookup, CmsProject project, I_CmsReport report)	Validates the links for the specified resource.

Method parameters in org.opencms.relations with type arguments of type CmsResource

Modifier and Type	Method	Description
protected boolean	CmsRelationSystemValidator.checkLinkForDeletedLinkTarget(CmsRelation relation, String link, Map<String,CmsResource> fileLookup)	Checks a link to a resource which has been deleted.
protected boolean	CmsRelationSystemValidator.checkLinkForNewOrChangedLinkSource(CmsDbContext dbc, CmsResource resource, CmsRelation relation, String link, CmsProject project, Map<String,CmsResource> fileLookup)	Checks a link from a resource which has changed.
protected List<CmsRelation>	CmsRelationSystemValidator.validateLinks(CmsDbContext dbc, CmsResource resource, Map<String,CmsResource> fileLookup, CmsProject project, I_CmsReport report)	Validates the links for the specified resource.

Constructors in org.opencms.relations with parameters of type CmsResource

Modifier	Constructor	Description
	CmsRelation(CmsResource source, CmsResource target, CmsRelationType type)	Creates a new relation object of the given type between the given resources.

Uses of CmsResource in org.opencms.repository

Constructors in org.opencms.repository with parameters of type CmsResource

Modifier	Constructor	Description
	CmsRepositoryItem(CmsResource res, CmsObjectWrapper cms)	Construct a new CmsRepositoryItem initialized with the CmsResource to use and the CmsObjectWrapper needed for some operations.

Uses of CmsResource in org.opencms.search

Subclasses of CmsResource in org.opencms.search

Modifier and Type	Class	Description
class	CmsSearchResource	A resource implementation that combines the Solr document together with a OpenCms VFS resource.

Methods in org.opencms.search that return CmsResource

Modifier and Type	Method	Description
protected CmsResource	CmsSearchIndex.getResource(CmsObject cms, I_CmsSearchDocument doc)	Checks if the OpenCms resource referenced by the result document can be read by the user of the given OpenCms context.
protected CmsResource	CmsSearchIndex.getResource(CmsObject cms, I_CmsSearchDocument doc, CmsResourceFilter filter)	Checks if the OpenCms resource referenced by the result document can be read by the user of the given OpenCms context.

Methods in org.opencms.search that return types with arguments of type CmsResource

Modifier and Type	Method	Description
protected Map<String,List<CmsResource>>	CmsDependencyIndexer.createFolderLookupMap(List<CmsResource> resources)	Creates a folder based lookup map for the given resource list.

Methods in org.opencms.search with parameters of type CmsResource

Modifier and Type	Method	Description
I_CmsSearchDocument	CmsSearchIndex.createEmptyDocument(CmsResource resource)	Creates an empty document that can be used by this search field configuration.
I_CmsSearchDocument	I_CmsSearchIndex.createEmptyDocument(CmsResource resource)	Creates an empty document that can be used by this search field configuration.
protected I_CmsSearchDocument	CmsIndexingThread.createIndexDocument(CmsObject cms, CmsResource res, I_CmsSearchIndex index, int count, I_CmsReport report)	Creates the search index document.
void	CmsIndexingThreadManager.createIndexingThread(CmsVfsIndexer indexer, I_CmsIndexWriter writer, CmsResource res)	Creates and starts a new indexing thread for a resource.
boolean	A_CmsSearchIndex.excludeFromIndex(CmsObject cms, CmsResource resource)	Checks if the provided resource should be excluded from this search index.
boolean	I_CmsSearchIndex.excludeFromIndex(CmsObject cms, CmsResource resource)	Checks if the provided resource should be excluded from this search index.
I_CmsExtractionResult	A_CmsSearchIndex.getContentIfUnchanged(CmsResource resource)	We always assume we have no unchanged copy of the content, since it depends on the concrete index.
I_CmsExtractionResult	CmsSearchIndex.getContentIfUnchanged(CmsResource resource)
I_CmsExtractionResult	I_CmsSearchIndex.getContentIfUnchanged(CmsResource resource)	The method should return the extraction result of a content from the index, if sure the content has not changed since last indexing.
I_CmsDocumentFactory	A_CmsSearchIndex.getDocumentFactory(CmsResource res)	Returns the document type factory used for the given resource in this index, or null in case the resource is not indexed by this index.
I_CmsDocumentFactory	I_CmsSearchIndex.getDocumentFactory(CmsResource res)	Returns the document type factory used for the given resource in this index, or null in case the resource is not indexed by this index.
List<String>	CmsSearchManager.getDocumentTypeKeys(CmsResource resource)	Returns the document type keys used to specify the correct document factory.
Locale	A_CmsSearchIndex.getLocaleForResource(CmsObject cms, CmsResource resource, List<Locale> availableLocales)	Returns the language locale for the given resource in this index.
Locale	CmsSearchIndex.getLocaleForResource(CmsObject cms, CmsResource resource, List<Locale> availableLocales)	Returns the language locale for the given resource in this index.
Locale	I_CmsSearchIndex.getLocaleForResource(CmsObject cms, CmsResource resource, List<Locale> availableLocales)	Returns the language locale for the given resource in this index.
protected boolean	A_CmsSearchIndex.isIndexing(CmsResource res)	Checks if the given resource should be indexed by this index or not.
protected void	CmsVfsIndexer.updateResource(I_CmsIndexWriter writer, CmsIndexingThreadManager threadManager, CmsResource resource)	Updates (writes) a single resource in the index.

Method parameters in org.opencms.search with type arguments of type CmsResource

Modifier and Type	Method	Description
protected Map<String,List<CmsResource>>	CmsDependencyIndexer.createFolderLookupMap(List<CmsResource> resources)	Creates a folder based lookup map for the given resource list.
protected void	CmsSearchManager.CmsSearchOfflineHandler.reIndexResources(List<CmsResource> resources)	Updates all offline indexes for the given list of CmsResource objects.

Constructors in org.opencms.search with parameters of type CmsResource

Modifier	Constructor	Description
	CmsIndexingThread(CmsObject cms, CmsResource res, I_CmsSearchIndex index, int count, I_CmsReport report)	Create a new indexing thread.
	CmsSearchResource(CmsResource resource, I_CmsSearchDocument doc)	Constructor, creates a new file Object from the given resource with an empty byte array as file content, if the resource does not implement a file.

Uses of CmsResource in org.opencms.search.documents

Methods in org.opencms.search.documents with parameters of type CmsResource

Modifier and Type	Method	Description
I_CmsSearchDocument	A_CmsVfsDocument.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Creates the Lucene Document for the given VFS resource and the given search index.
I_CmsSearchDocument	CmsDocumentContainerPage.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Generates a new lucene document instance from contents of the given resource for the provided index.
I_CmsSearchDocument	CmsDocumentXmlContent.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)
I_CmsSearchDocument	I_CmsDocumentFactory.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Creates the Lucene Document for the given VFS resource and the given search index.
I_CmsExtractionResult	CmsDocumentContainerPage.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Returns the raw text content of a VFS resource of type CmsResourceTypeContainerPage.
I_CmsExtractionResult	CmsDocumentGeneric.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Just returns an empty extraction result since the content can't be extracted form a generic resource.
I_CmsExtractionResult	CmsDocumentHtml.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Returns the raw text content of a given VFS resource containing HTML data.
I_CmsExtractionResult	CmsDocumentMsOfficeOLE2.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Returns the raw text content of a given vfs resource containing MS Word data.
I_CmsExtractionResult	CmsDocumentMsOfficeOOXML.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Returns the raw text content of a given vfs resource containing MS Word data.
I_CmsExtractionResult	CmsDocumentOpenOffice.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Returns the raw text content of a given vfs resource containing MS Word data.
I_CmsExtractionResult	CmsDocumentPdf.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Returns the raw text content of a given vfs resource containing Adobe PDF data.
I_CmsExtractionResult	CmsDocumentPlainText.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Returns the raw text content of a given vfs resource containing plain text data.
I_CmsExtractionResult	CmsDocumentRtf.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Returns the raw text content of a given vfs resource containing RTF data.
I_CmsExtractionResult	CmsDocumentXmlContent.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Returns the raw text content of a given VFS resource of type CmsResourceTypeXmlContent.
I_CmsExtractionResult	CmsDocumentXmlPage.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Returns the raw text content of a given vfs resource of type CmsResourceTypeXmlPage.
I_CmsExtractionResult	I_CmsSearchExtractor.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Extracts the content of a given index resource according to the resource file type and the configuration of the given index.
String	CmsExtractionResultCache.getCacheName(CmsResource resource, Locale locale, String docTypeName)	Returns the RFS name used for caching an the text extraction result based on the given VFS resource and locale.
static CmsDocumentDependency	CmsDocumentDependency.load(CmsObject cms, CmsResource res)	Loads or creates a dependency object for the given parameters.
static CmsDocumentDependency	CmsDocumentDependency.load(CmsObject cms, CmsResource res, List<CmsResource> resources)	Loads or creates a dependency object for the given parameters.
protected void	A_CmsVfsDocument.logContentExtraction(CmsResource resource, I_CmsSearchIndex index)	Logs content extraction for the specified resource and index.
protected CmsFile	A_CmsVfsDocument.readFile(CmsObject cms, CmsResource resource)	Upgrades the given resource to a CmsFile with content.

Method parameters in org.opencms.search.documents with type arguments of type CmsResource

Modifier and Type	Method	Description
static CmsDocumentDependency	CmsDocumentDependency.load(CmsObject cms, CmsResource res, List<CmsResource> resources)	Loads or creates a dependency object for the given parameters.
void	CmsDocumentDependency.readDependencies(CmsObject cms, List<CmsResource> folderContent)	Reads all dependencies that exist for this main resource in provided list of resources.

Uses of CmsResource in org.opencms.search.fields

Methods in org.opencms.search.fields with parameters of type CmsResource

Modifier and Type	Method	Description
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendAdditionalValuesToDcoument(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Overriding this method allows to append some 'extra' values/fields to a document without overriding the CmsSearchFieldConfiguration.createDocument(org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.I_CmsSearchIndex, org.opencms.search.extractors.I_CmsExtractionResult) method itself.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendCategories(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by resource category information based on properties.
protected I_CmsSearchDocument	CmsSearchFieldConfigurationOldCategories.appendCategories(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by resource category information based on properties.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendContentBlob(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by a field that contains the extracted content blob.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendDates(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by fields for date of creation, content and last modification.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFieldMapping(I_CmsSearchDocument document, CmsSearchField field, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by the mappings for the given field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFieldMappings(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by the configured field mappings.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFileSize(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by the "size" field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendLocales(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by the "res_locales" field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendPath(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by fields for VFS path lookup.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendProperties(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Appends all direct properties, that are not empty or white space only to the document.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendType(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Extends the given document by a field that contains the resource type name.
I_CmsSearchDocument	CmsSearchFieldConfiguration.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, I_CmsExtractionResult extraction)	Creates the Lucene Document with this field configuration for the provided VFS resource, search index and content.
I_CmsSearchDocument	I_CmsSearchFieldConfiguration.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, I_CmsExtractionResult extractionResult)	Creates the document to index.
String	CmsGeoCoordinateFieldMapping.getStringValue(int depth, CmsGeoMappingConfiguration mappingConfig, CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult)	Gets the mapped value.
String	CmsGeoCoordinateFieldMapping.getStringValue(CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
String	CmsMacroResolvingSearchFieldMapping.getStringValue(CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Calls the super method and resolves macros in the returned value.
String	CmsMacroSearchFieldMapping.getStringValue(CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
String	CmsSearchFieldMapping.getStringValue(CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
String	I_CmsSearchFieldMapping.getStringValue(CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Returns the String value extracted form the provided data according to the rules of this mapping type.

Uses of CmsResource in org.opencms.search.galleries

Constructors in org.opencms.search.galleries with parameters of type CmsResource

Modifier	Constructor	Description
	CmsGallerySearchResult(CmsObject cms, CmsResource res, String title)	Creates a fake gallery search result by reading the necessary data from a VFS resource.

Uses of CmsResource in org.opencms.search.solr

Methods in org.opencms.search.solr with parameters of type CmsResource

Modifier and Type	Method	Description
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendAdditionalValuesToDcoument(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendDates(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMapping(I_CmsSearchDocument document, CmsSearchField sfield, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMappings(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMappingsFromElementsOnThePage(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, List<String> systemFields)	Adds search fields from elements on a container page to a container page's document.
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendLocales(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendProperties(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)
I_CmsSearchDocument	CmsSolrIndex.createEmptyDocument(CmsResource resource)
boolean	CmsSolrIndex.excludeFromIndex(CmsObject cms, CmsResource resource)
I_CmsExtractionResult	CmsSolrDocumentContainerPage.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Returns the raw text content of a VFS resource of type CmsResourceTypeContainerPage.
I_CmsExtractionResult	CmsSolrDocumentContainerPage.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, Locale forceLocale)	Extracts the content of a given index resource according to the resource file type and the configuration of the given index.
I_CmsExtractionResult	CmsSolrDocumentXmlContent.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)
static CmsExtractionResult	CmsSolrDocumentXmlContent.extractXmlContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)	Extracts the content of a single XML content resource.
static CmsExtractionResult	CmsSolrDocumentXmlContent.extractXmlContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, Locale forceLocale)	Extracts the content of a single XML content resource.
static CmsExtractionResult	CmsSolrDocumentXmlContent.extractXmlContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, Locale forceLocale, Set<CmsUUID> alreadyExtracted)	Extracts the content of a single XML content resource.
static CmsExtractionResult	CmsSolrDocumentXmlContent.extractXmlContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, Locale forceLocale, Set<CmsUUID> alreadyExtracted, Consumer<A_CmsXmlDocument> contentConsumer)	Extracts the content of a single XML content resource.
protected List<Locale>	CmsSolrFieldConfiguration.getContentLocales(CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction)	Retrieves the locales for an content, that is whether an XML content nor an XML page.
Locale	CmsSolrIndex.getLocaleForResource(CmsObject cms, CmsResource resource, List<Locale> availableLocales)	Returns the language locale for the given resource in this index.
protected Set<CmsSearchField>	CmsSolrFieldConfiguration.getXSDMappings(CmsObject cms, CmsResource resource)	Returns the search field mappings declared within the XSD.
protected Set<CmsSearchField>	CmsSolrFieldConfiguration.getXSDMappingsForPage(CmsObject cms, CmsResource resource)	Returns the search field mappings declared within the XSD that should be applied to the container page.
org.apache.solr.common.SolrDocument	CmsSolrLinkProcessor.process(CmsObject cms, CmsResource resource, org.apache.solr.common.SolrInputDocument document)
org.apache.solr.common.SolrDocument	I_CmsSolrPostSearchProcessor.process(CmsObject searchCms, CmsResource resource, org.apache.solr.common.SolrInputDocument document)	Performs the post processing.

Uses of CmsResource in org.opencms.security

Methods in org.opencms.security that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsRoleManager.getManageableResources(CmsObject cms, CmsRole role)	Returns all resources of organizational units for which the current user has the given role role.
List<CmsResource>	CmsOrgUnitManager.getResourcesForOrganizationalUnit(CmsObject cms, String ouFqn)	Returns all resources of the given organizational unit.

Methods in org.opencms.security with parameters of type CmsResource

Modifier and Type	Method	Description
CmsRoleViolationException	CmsRole.createRoleViolationExceptionForResource(CmsRequestContext requestContext, CmsResource resource)	Returns a role violation exception configured with a localized, role specific message for this role.
List<CmsRole>	CmsRoleManager.getRolesForResource(CmsObject cms, CmsUser user, CmsResource resource)	Returns all roles the given user has over the given resource.
I_CmsPermissionHandler.CmsPermissionCheckResult	CmsDefaultPermissionHandler.hasPermissions(CmsDbContext dbc, CmsResource resource, CmsPermissionSet requiredPermissions, I_CmsPermissionHandler.LockCheck checkLock, CmsResourceFilter filter)
I_CmsPermissionHandler.CmsPermissionCheckResult	I_CmsPermissionHandler.hasPermissions(CmsDbContext dbc, CmsResource resource, CmsPermissionSet requiredPermissions, I_CmsPermissionHandler.LockCheck checkLock, CmsResourceFilter filter)	Performs a non-blocking permission check on a resource.
boolean	CmsRoleManager.hasRoleForResource(CmsObject cms, CmsRole role, CmsResource resource)	Checks if the given context user has the given role for the given resource.

Uses of CmsResource in org.opencms.site

Methods in org.opencms.site with parameters of type CmsResource

Modifier and Type	Method	Description
String	CmsSite.getServerPrefix(CmsObject cms, CmsResource resource)	Returns the server prefix for the given resource in this site, used to distinguish between secure (https) and non-secure (http) sites.
String	CmsSiteManagerImpl.getSiteTitle(CmsObject cms, CmsResource resource)	Returns the site title.

Uses of CmsResource in org.opencms.site.xmlsitemap

Fields in org.opencms.site.xmlsitemap with type parameters of type CmsResource

Modifier and Type	Field	Description
protected Map<String,List<CmsResource>>	CmsXmlSitemapGenerator.m_detailResources	A map from type names to lists of potential detail resources of that type.

Methods in org.opencms.site.xmlsitemap that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsXmlSitemapUrlBean.getDetailPageResource()	Gets the detail page resource in case the link is the link to a detail page, else returns null.
CmsResource	CmsXmlSitemapUrlBean.getOriginalResource()	Gets the original resource belonging to the link.

Methods in org.opencms.site.xmlsitemap that return types with arguments of type CmsResource

Modifier and Type	Method	Description
protected List<CmsResource>	CmsXmlSitemapGenerator.getDirectPages()	Gets the list of pages which should be directly added to the XML sitemap.
protected List<CmsResource>	CmsXmlSitemapGenerator.getNavigationPages()	Gets the list of pages from the navigation which should be directly added to the XML sitemap.

Methods in org.opencms.site.xmlsitemap with parameters of type CmsResource

Modifier and Type	Method	Description
protected void	CmsDetailPageDuplicateEliminatingSitemapGenerator.addDetailLinks(CmsResource containerPage, Locale locale)
protected void	CmsXmlSitemapGenerator.addDetailLinks(CmsResource containerPage, Locale locale)	Adds the detail page links for a given page to the results.
protected long	CmsXmlSitemapGenerator.computeContainerPageModificationDate(CmsResource containerPage)	Computes the container the container page modification date from its referenced contents.
protected String	CmsXmlSitemapGenerator.getDetailLink(CmsResource pageRes, CmsResource detailRes, Locale locale)	Gets the detail link for a given container page and detail content.
protected List<I_CmsResourceType>	CmsXmlSitemapGenerator.getDetailTypesForPage(CmsResource resource)	Gets the types for which a given resource is configured as a detail page.
protected boolean	CmsXmlSitemapGenerator.isValidDetailPageCombination(CmsResource page, Locale locale, CmsResource detailRes)	Checks whether the page/detail content combination is a valid detail page.
void	CmsXmlSeoConfiguration.load(CmsObject cms, CmsResource resource)	Loads the bean data from the given resource.
static CmsXmlSitemapGenerator	CmsXmlSitemapActionElement.prepareSitemapGenerator(CmsResource seoFileRes, CmsXmlSeoConfiguration config)	Constructs an XML sitemap generator given an XML sitemap configuration file.
void	CmsXmlSitemapUrlBean.setDetailPageResource(CmsResource detailPageResource)	Sets the detail page resource.
void	CmsXmlSitemapUrlBean.setOriginalResource(CmsResource resource)	Sets the original resource.

Method parameters in org.opencms.site.xmlsitemap with type arguments of type CmsResource

Modifier and Type	Method	Description
protected static void	CmsXmlSitemapGenerator.removeInternalFiles(List<CmsResource> resources)	Removes files marked as internal from a resource list.

Uses of CmsResource in org.opencms.staticexport

Methods in org.opencms.staticexport that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsStaticExportData.getResource()	Returns the resource to export.

Methods in org.opencms.staticexport with parameters of type CmsResource

Modifier and Type	Method	Description
protected boolean	CmsDefaultLinkSubstitutionHandler.isDetailPageLinkSecure(CmsObject cms, String detailPage, CmsResource detailContent, CmsSite targetSite, boolean secureRequest)	Checks whether a link to a detail page should be secure.
String	CmsLinkManager.substituteLink(CmsObject cms, CmsResource resource)	Returns a link from the URI stored in the provided OpenCms user context to the given VFS resource, for use on web pages.
protected void	CmsStaticExportManager.writeResource(javax.servlet.http.HttpServletRequest req, String exportPath, String rfsName, CmsResource resource, byte[] content)	Writes a resource to the given export path with the given rfs name and the given content.

Constructors in org.opencms.staticexport with parameters of type CmsResource

Modifier	Constructor	Description
	CmsStaticExportData(String vfsName, String rfsName, CmsResource resource, String parameters)	Creates a new static export data object.

Uses of CmsResource in org.opencms.synchronize

Methods in org.opencms.synchronize with parameters of type CmsResource

Modifier and Type	Method	Description
void	I_CmsSynchronizeModification.modifyFs(CmsObject cms, CmsResource vfsRes, File fsFile)	Possibility to modify a resource after it has benn exported or updated to the FS.
void	I_CmsSynchronizeModification.modifyVfs(CmsObject cms, CmsResource vfsRes, File fsFile)	Possibility to modify a resource after it has been imported or updated into the VFS.

Uses of CmsResource in org.opencms.ugc

Methods in org.opencms.ugc that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsUgcSession.createUploadResource(String fieldName, String rawFileName, byte[] content)	Creates a new resource from upload data.
CmsResource	CmsUgcSession.createXmlContent()	Creates a new edit resource.
CmsResource	CmsUgcConfiguration.getContentParentFolder()	Returns the folder for XML contents.
CmsResource	CmsUgcSession.getResource()	Returns the edit resource.
CmsResource	CmsUgcSession.loadXmlContent(String fileName)	Loads the existing edit resource.

Methods in org.opencms.ugc that return types with arguments of type CmsResource

Modifier and Type	Method	Description
com.google.common.base.Optional<CmsResource>	CmsUgcConfiguration.getUploadParentFolder()	Returns the folder for uploads.

Constructors in org.opencms.ugc with parameters of type CmsResource

Modifier	Constructor	Description
	CmsUgcConfiguration(CmsUUID id, com.google.common.base.Optional<CmsUser> userForGuests, CmsGroup projectGroup, String resourceType, CmsResource contentParentFolder, String namePattern, Locale locale, com.google.common.base.Optional<CmsResource> uploadParent, com.google.common.base.Optional<Long> maxUploadSize, com.google.common.base.Optional<Integer> maxContents, com.google.common.base.Optional<Long> queueTimeout, com.google.common.base.Optional<Integer> maxQueueLength, boolean autoPublish, com.google.common.base.Optional<List<String>> validExtensions)	Creates a new form configuration.

Uses of CmsResource in org.opencms.ui

Methods in org.opencms.ui that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	A_CmsDialogContext.getResources()
List<CmsResource>	I_CmsDialogContext.getResources()	Gets the list of resources for which the dialog should be opened.

Constructor parameters in org.opencms.ui with type arguments of type CmsResource

Modifier	Constructor	Description
protected	A_CmsDialogContext(String appId, I_CmsDialogContext.ContextType contextType, List<CmsResource> resources)	Constructor.

Uses of CmsResource in org.opencms.ui.actions

Methods in org.opencms.ui.actions that return CmsResource

Modifier and Type	Method	Description
protected CmsResource	A_CmsGalleryDialogAction.getGallery(I_CmsDialogContext context)	Returns the gallery.

Method parameters in org.opencms.ui.actions with type arguments of type CmsResource

Modifier and Type	Method	Description
protected String	A_CmsJSPAction.getRequestString(List<CmsResource> resources)	Creates string for get—request with given list of resources.
CmsMenuItemVisibilityMode	A_CmsEditFileAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	A_CmsGalleryDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	A_CmsToolbarAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsAvailabilityDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsCategoriesDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsChangeTypeDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsContextMenuActionItem.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsCopyDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsCopyPageDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsCopyToProjectDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsDeleteDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsDirectPublishDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsDisplayAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsEditCodeDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsEditDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsEditPageAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsEditPointerAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsEditPropertyAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsEditSmallElementsAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsEditUserDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsFavoriteDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsFormEditDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsHistoryDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsLinkLocaleVariantAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsLockAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsLockedResourcesAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsLogoutAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsMoveDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsPermissionDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsPrefillPageAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsPreviewAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsPropertiesDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsPublishScheduledDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsReindexDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsRenameAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsReplaceDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsResourceInfoAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsRestoreDeletedAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSecureExportDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSelectElementViewAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSeoAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsShowLocaleAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSitemapAliasAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSitemapAttributeEditorAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSitemapEditConfigAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSitemapOpenParentAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSitemapRefreshAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsStealLockAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsTemplateContextsAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsTouchDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsUndeleteDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsUndoDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsUnlinkLocaleVariantAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsUnlockAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsUnusedContentFinderAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsUserInfoDialogAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsViewInExplorerAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsViewOnlineAction.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsWorkplaceAction.getVisibility(CmsObject cms, List<CmsResource> resources)

Uses of CmsResource in org.opencms.ui.apps

Methods in org.opencms.ui.apps with parameters of type CmsResource

Modifier and Type	Method	Description
I_CmsEditor	CmsWorkplaceAppManager.getEditorForResource(CmsObject cms, CmsResource resource, boolean plainText)	Returns the editor for the given resource.
void	CmsQuickLaunchLocationCache.setPageEditorResource(CmsObject cms, String siteRoot, CmsResource resource)	Sets the latest page editor location for the given site.

Constructor parameters in org.opencms.ui.apps with type arguments of type CmsResource

Modifier	Constructor	Description
	CmsExplorerDialogContext(I_CmsDialogContext.ContextType contextType, CmsFileTable fileTable, CmsFileExplorer explorer, List<CmsResource> resources)	Creates a new instance.

Uses of CmsResource in org.opencms.ui.apps.datesearch

Methods in org.opencms.ui.apps.datesearch with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsDateSearchComposite.addItemProperties(com.vaadin.v7.data.Item resourceItem, CmsObject cms, CmsResource resource, Locale locale)

Uses of CmsResource in org.opencms.ui.apps.dbmanager

Fields in org.opencms.ui.apps.dbmanager with type parameters of type CmsResource

Modifier and Type	Field	Description
protected List<CmsResource>	CmsPropertyDeleteDialog.m_resources	List of resources having the property to be deleted.

Constructors in org.opencms.ui.apps.dbmanager with parameters of type CmsResource

Modifier	Constructor	Description
	CmsSelectResourceTypeDialog(CmsResource folderResource, I_CmsDialogContext context)	public constructor.

Uses of CmsResource in org.opencms.ui.apps.linkvalidation

Methods in org.opencms.ui.apps.linkvalidation that return types with arguments of type CmsResource

Modifier and Type	Method	Description
abstract List<CmsResource>	A_CmsLinkValidator.failedResources(List<String> resources)	Returns resources which fail the validations.
List<CmsResource>	CmsLinkInFolderValidationApp.InFolderValidator.failedResources(List<String> resources)
List<CmsResource>	CmsLinkValidationApp.InternalValidator.failedResources(List<String> resources)

Methods in org.opencms.ui.apps.linkvalidation with parameters of type CmsResource

Modifier and Type	Method	Description
void	A_CmsLinkValidator.addItemProperties(com.vaadin.v7.data.Item resourceItem, CmsObject cms, CmsResource resource, Locale locale)
abstract String	A_CmsLinkValidator.failMessage(CmsResource resource)	Get fail message for resource.
String	CmsLinkInFolderValidationApp.InFolderValidator.failMessage(CmsResource resource)
String	CmsLinkValidationApp.InternalValidator.failMessage(CmsResource resource)

Constructor parameters in org.opencms.ui.apps.linkvalidation with type arguments of type CmsResource

Modifier	Constructor	Description
	CmsResourceListDialog(List<CmsResource> resources)	Public constructor.

Uses of CmsResource in org.opencms.ui.apps.lists

Methods in org.opencms.ui.apps.lists with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsListManager.addItemProperties(com.vaadin.v7.data.Item resourceItem, CmsObject cms, CmsResource resource, Locale locale)
protected void	CmsResultTable.fillItem(CmsObject cms, CmsResource resource, Locale locale)
void	CmsListManager.search(CmsSimpleSearchConfigurationParser configParser, CmsResource resource)	Execute a search with the given search configuration parser.

Constructors in org.opencms.ui.apps.lists with parameters of type CmsResource

Modifier	Constructor	Description
	CmsOptionDialog(CmsResource resource, CmsDialogOptions options, CmsOptionDialog.I_OptionHandler handler, Runnable onClose, com.vaadin.ui.Window window)	Constructor.

Constructor parameters in org.opencms.ui.apps.lists with type arguments of type CmsResource

Modifier	Constructor	Description
	DialogContext(String appId, I_CmsDialogContext.ContextType contextType, CmsFileTable fileTable, List<CmsResource> resources)	Constructor.

Uses of CmsResource in org.opencms.ui.apps.search

Methods in org.opencms.ui.apps.search that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsSearchReplaceSettings.getElementResource()	Get element to search for.

Methods in org.opencms.ui.apps.search that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsSearchReplaceThread.getMatchedResources()	Returns the matched resources.

Methods in org.opencms.ui.apps.search with parameters of type CmsResource

Modifier and Type	Method	Description
static String	CmsSearchReplaceSettings.replaceElementInPagePattern(CmsResource resource)	Replace element pattern.
static String	CmsSearchReplaceSettings.searchElementInPagePattern(CmsResource resource)	Search element in xml page pattern.
void	CmsSearchReplaceSettings.setElementResource(CmsResource resource)	Set Element to search for.

Method parameters in org.opencms.ui.apps.search with type arguments of type CmsResource

Modifier and Type	Method	Description
protected void	CmsSearchReplaceThread.searchAndReplace(List<CmsResource> resources)	Search the resources.

Uses of CmsResource in org.opencms.ui.apps.user

Constructor parameters in org.opencms.ui.apps.user with type arguments of type CmsResource

Modifier	Constructor	Description
	CmsResourceInfoTable(Set<CmsResource> resources, List<CmsUser> user)	public constructor.

Uses of CmsResource in org.opencms.ui.components

Fields in org.opencms.ui.components with type parameters of type CmsResource

Modifier and Type	Field	Description
protected List<CmsResource>	CmsFileTable.m_currentResources	The selected resources.

Methods in org.opencms.ui.components that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsBasicDialog.getInfoResources()	Gets the resources for which the resource info boxes should be displayed.
List<CmsResource>	CmsFileTable.getSelectedResources()	Gets the list of selected resources.

Methods in org.opencms.ui.components with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsResourceTable.I_ResourcePropertyProvider.addItemProperties(com.vaadin.v7.data.Item resourceItem, CmsObject cms, CmsResource resource, Locale locale)	Adds the property values to the given item.
static CmsResourceInfo	CmsResourceInfo.createSitemapResourceInfo(CmsResource resource, CmsSite baseSite)	Creates a resource info widget for a resource that looks like the sitemap entry for that resource.
void	CmsBasicDialog.displayResourceInfo(CmsResource resource)	For a given resource, display the resource info panel.
protected void	CmsResourceTable.fillItem(CmsObject cms, CmsResource resource, Locale locale)	Fills the file item data.
static void	CmsResourceTable.fillItemDefault(com.vaadin.v7.data.Item resourceItem, CmsObject cms, CmsResource resource, Locale locale)	Static helper method to initialize the 'standard' properties of a data item from a given resource.
static String	CmsResourceIcon.getDefaultFileOrDetailType(CmsObject cms, CmsResource resource)	Returns the default file type or detail type for the given resource.
static String	CmsResourceIcon.getDetailType(CmsObject cms, CmsResource detailPage, CmsResource parentFolder)	Returns the detail content type for container pages that may be detail pages.
static com.vaadin.server.Resource	CmsResourceIcon.getSitemapResourceIcon(CmsObject cms, CmsResource resource, CmsResourceIcon.IconMode iconMode)	Gets the resource icon for a resource for use in a CmsResourceInfo widget when used in a sitemap context.

Method parameters in org.opencms.ui.components with type arguments of type CmsResource

Modifier and Type	Method	Description
com.vaadin.ui.Panel	CmsBasicDialog.createResourceListPanel(String caption, List<CmsResource> resources)	Creates a resource list panel.
void	CmsBasicDialog.displayResourceInfo(List<CmsResource> resources)	For a given list of resources, displays the resource info panels.
void	CmsBasicDialog.displayResourceInfo(List<CmsResource> resources, String messageKey)	For a given list of resources, displays the resource info panels with panel messages.
void	CmsResourceTable.fillTable(CmsObject cms, List<CmsResource> resources)	Fills the resource table.
void	CmsResourceTable.fillTable(CmsObject cms, List<CmsResource> resources, boolean clearFilter)	Fills the resource table.
void	CmsResourceTable.fillTable(CmsObject cms, List<CmsResource> resources, boolean clearFilter, boolean sort)	Fills the resource table.
void	CmsResourceTable.fillTable(CmsObject cms, List<CmsResource> resources, boolean clearFilter, boolean sort, boolean distinctResources)	Fills the resource table.

Constructors in org.opencms.ui.components with parameters of type CmsResource

Modifier	Constructor	Description
	CmsMacroResolverDialog(Runnable okAction, Runnable cancelAction, CmsResource resource)	Public constructor.
	CmsResourceInfo(CmsResource resource)	Constructor.
	CmsResourceInfo(CmsResource resource, boolean useState)	Constructor.

Constructor parameters in org.opencms.ui.components with type arguments of type CmsResource

Modifier	Constructor	Description
	CmsFileTableDialogContext(String appId, I_CmsDialogContext.ContextType contextType, CmsFileTable fileTable, List<CmsResource> resources)	Creates a new instance.
	CmsLockedResourcesList(CmsObject cms, List<CmsResource> resources, String message, Runnable nextAction, Runnable cancelAction)	Creates a new instance.

Uses of CmsResource in org.opencms.ui.components.extensions

Methods in org.opencms.ui.components.extensions with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsGwtDialogExtension.editPointer(CmsResource resource)	Opens the dialog for editing pointer resources.
void	CmsGwtDialogExtension.openCategories(CmsResource resource)	Opens the categories dialog for the given resource.
void	CmsGwtDialogExtension.openGalleryDialog(CmsResource resource)	Opens the gallery dialog for the given gallery folder.
void	CmsGwtDialogExtension.openInfoDialog(CmsResource resource, String startTab)	Opens the resource info dialog.
void	CmsGwtDialogExtension.openLockReport(CmsResource resource)	Opens the lock report for the given resource.

Method parameters in org.opencms.ui.components.extensions with type arguments of type CmsResource

Modifier and Type	Method	Description
protected CmsPublishData	CmsGwtDialogExtension.getPublishData(CmsProject project, List<CmsResource> directPublishResources)	Gets the publish data for the given resources.
protected void	CmsGwtDialogExtension.openPublishDailog(CmsProject project, List<CmsResource> directPublishResources)	Opens the publish dialog for the given project.
void	CmsGwtDialogExtension.openPublishDialog(List<CmsResource> resources)	Tells the client to open the publish dialog for the given resources.

Uses of CmsResource in org.opencms.ui.components.fileselect

Fields in org.opencms.ui.components.fileselect declared as CmsResource

Modifier and Type	Field	Description
protected CmsResource	CmsResourceSelectDialog.m_root	The resource initially displayed at the root of the tree.

Methods in org.opencms.ui.components.fileselect with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsResourceTreeContainer.addTreeItem(CmsObject cms, CmsResource resource, CmsUUID parentId)	Adds an item to the folder tree.
protected CmsResourceTreeTable	CmsResourceSelectDialog.createTree(CmsObject cms, CmsResource root)	Creates the resource tree for the given root.
protected void	CmsResourceTreeContainer.fillProperties(CmsObject cms, com.vaadin.v7.data.Item resourceItem, CmsResource resource, CmsUUID parentId)	Fills the properties of a tree item.
protected String	CmsResourceTreeContainer.getName(CmsObject cms, CmsResource resource, CmsUUID parentId)	Gets the name to display for the given resource.
void	CmsResourceTreeContainer.initRoot(CmsObject cms, CmsResource root)	Initializes the root level of the tree.
protected boolean	A_CmsFileSelectField.resourceIsValid(CmsResource resource)	Checks if the given resource is valid according to require Folder or File.
protected abstract void	A_CmsFileSelectField.setResourceValue(CmsResource resource)	Sets the field value.
protected void	CmsPathSelectField.setResourceValue(CmsResource resource)
void	CmsResourceSelectDialog.showStartResource(CmsResource startResource)	Displays the start resource by opening all nodes in the tree leading to it.
protected void	CmsResourceSelectDialog.updateRoot(CmsObject rootCms, CmsResource siteRootResource)	Updates the current site root resource.

Method parameters in org.opencms.ui.components.fileselect with type arguments of type CmsResource

Modifier and Type	Method	Description
void	CmsResourceTreeTable.addResourceSelectionHandler(I_CmsSelectionHandler<CmsResource> handler)	Adds a resource selection handler.
void	CmsResourceSelectDialog.addSelectionHandler(I_CmsSelectionHandler<CmsResource> handler)	Adds a resource selection handler.
void	CmsResourceTreeTable.removeResourceSelectionHandler(I_CmsSelectionHandler<CmsResource> handler)	Removes the given resource selection handler.

Constructors in org.opencms.ui.components.fileselect with parameters of type CmsResource

Modifier	Constructor	Description
	CmsNavigationFilter(CmsObject cms, CmsResource root)	Creates a new instance.
	CmsResourceTreeTable(CmsObject cms, CmsResource root, CmsResourceFilter filter)	Creates a new instance.
	CmsResourceTreeTable(CmsObject cms, CmsResource root, CmsResourceTreeContainer container)	Creates a new instance.

Uses of CmsResource in org.opencms.ui.contextmenu

Methods in org.opencms.ui.contextmenu with parameters of type CmsResource

Modifier and Type	Method	Description
abstract CmsMenuItemVisibilityMode	A_CmsSimpleVisibilityCheck.getSingleVisibility(CmsObject cms, CmsResource resource)	Computes visibility of the menu item for a single resource.
CmsMenuItemVisibilityMode	CmsStandardVisibilityCheck.getSingleVisibility(CmsObject cms, CmsResource resource)

Method parameters in org.opencms.ui.contextmenu with type arguments of type CmsResource

Modifier and Type	Method	Description
CmsMenuItemVisibilityMode	A_CmsSimpleVisibilityCheck.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsMenuItemVisibilitySingleOnly.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSubmenu.getVisibility(CmsObject cms, List<CmsResource> resources)
CmsMenuItemVisibilityMode	I_CmsContextMenuItem.getVisibility(CmsObject cms, List<CmsResource> resources)	Computes the visibility for this context menu items with the given CMS context and resources.
CmsMenuItemVisibilityMode	I_CmsHasMenuItemVisibility.getVisibility(CmsObject cms, List<CmsResource> resources)	Gets the visibility for the current resource and CMS context.

Uses of CmsResource in org.opencms.ui.dialogs

Fields in org.opencms.ui.dialogs declared as CmsResource

Modifier and Type	Field	Description
protected CmsResource	A_CmsSelectResourceTypeDialog.m_createdResource	The created resource.
protected CmsResource	A_CmsSelectResourceTypeDialog.m_folderResource	The current folder.
protected CmsResource	CmsSecureExportDialog.m_resource	The current resource.

Methods in org.opencms.ui.dialogs that return types with arguments of type CmsResource

Modifier and Type	Method	Description
static com.google.common.collect.Multimap<CmsResource,CmsResource>	CmsDeleteDialog.getBrokenLinks(CmsObject cms, List<CmsResource> selectedResources, boolean includeSiblings)	Gets the broken links.
static com.google.common.collect.Multimap<CmsResource,CmsResource>	CmsDeleteDialog.getBrokenLinks(CmsObject cms, List<CmsResource> selectedResources, boolean includeSiblings)	Gets the broken links.
static com.google.common.collect.Multimap<CmsResource,CmsResource>	CmsDeleteDialog.getBrokenLinks(CmsObject cms, List<CmsResource> selectedResources, boolean includeSiblings, boolean reverse)	Gets the broken links.
static com.google.common.collect.Multimap<CmsResource,CmsResource>	CmsDeleteDialog.getBrokenLinks(CmsObject cms, List<CmsResource> selectedResources, boolean includeSiblings, boolean reverse)	Gets the broken links.
List<CmsResource>	CmsEmbeddedDialogContext.getResources()

Methods in org.opencms.ui.dialogs with parameters of type CmsResource

Modifier and Type	Method	Description
protected void	CmsCopyMoveDialog.performSingleOperation(CmsResource source, CmsResource target, String name, CmsCopyMoveDialog.Action action, boolean overwrite, Map<String,String> macroMap)	Performs the single resource operation.
protected void	CmsCopyMoveDialog.performSingleOperation(CmsResource source, CmsResource target, CmsCopyMoveDialog.Action action, boolean overwrite, Map<String,String> makroMap)	Performs the single resource operation.
void	CmsCopyMoveDialog.setTargetForlder(CmsResource resource)	Preselects the target folder.

Method parameters in org.opencms.ui.dialogs with type arguments of type CmsResource

Modifier and Type	Method	Description
static com.google.common.collect.Multimap<CmsResource,CmsResource>	CmsDeleteDialog.getBrokenLinks(CmsObject cms, List<CmsResource> selectedResources, boolean includeSiblings)	Gets the broken links.
static com.google.common.collect.Multimap<CmsResource,CmsResource>	CmsDeleteDialog.getBrokenLinks(CmsObject cms, List<CmsResource> selectedResources, boolean includeSiblings, boolean reverse)	Gets the broken links.

Constructors in org.opencms.ui.dialogs with parameters of type CmsResource

Modifier	Constructor	Description
	A_CmsSelectResourceTypeDialog(CmsResource folderResource, I_CmsDialogContext context)	Creates a new instance.
	CmsGalleryOptimizeDialog(I_CmsDialogContext context, CmsResource gallery)	Creates a new instance of a gallery optimize dialog.
	CmsNewDialog(CmsResource folderResource, I_CmsDialogContext context)	Creates a new instance.

Constructor parameters in org.opencms.ui.dialogs with type arguments of type CmsResource

Modifier	Constructor	Description
	CmsEmbeddedDialogContext(String appId, CmsEmbeddedDialogExtension extension, I_CmsDialogContext.ContextType contextType, List<CmsResource> resources, Map<String,String> parameters)	Constructor.

Uses of CmsResource in org.opencms.ui.dialogs.embedded

Method parameters in org.opencms.ui.dialogs.embedded with type arguments of type CmsResource

Modifier and Type	Method	Description
CmsMenuItemVisibilityMode	CmsDataViewAction.getVisibility(CmsObject cms, List<CmsResource> resources)

Uses of CmsResource in org.opencms.ui.dialogs.history.diff

Methods in org.opencms.ui.dialogs.history.diff that return CmsResource

Modifier and Type	Method	Description
static CmsResource	A_CmsAttributeDiff.readResource(CmsObject cms, CmsHistoryResourceBean bean)	Reads a historical resource for a history resource bean.

Uses of CmsResource in org.opencms.ui.editors

Methods in org.opencms.ui.editors with parameters of type CmsResource

Modifier and Type	Method	Description
CmsCodeMirror.CodeMirrorLanguage	CmsSourceEditor.getHighlightMode(CmsResource resource)	Returns the syntax highlighting type for the currently edited resource.
void	A_CmsFrameEditor.initUI(I_CmsAppUIContext context, CmsResource resource, String backLink, Map<String,String> params)
void	CmsSourceEditor.initUI(I_CmsAppUIContext context, CmsResource resource, String backLink, Map<String,String> params)
void	I_CmsEditor.initUI(I_CmsAppUIContext context, CmsResource resource, String backLink, Map<String,String> params)	Within this method the editor UI should be initialized.
boolean	A_CmsFrameEditor.matchesResource(CmsObject cms, CmsResource resource, boolean plainText)
boolean	CmsAcaciaEditor.matchesResource(CmsObject cms, CmsResource resource, boolean plainText)
boolean	CmsSourceEditor.matchesResource(CmsObject cms, CmsResource resource, boolean plainText)
boolean	I_CmsEditor.matchesResource(CmsObject cms, CmsResource resource, boolean plainText)	Checks whether the editor is available for the given resource.

Uses of CmsResource in org.opencms.ui.editors.messagebundle

Methods in org.opencms.ui.editors.messagebundle that return CmsResource

Modifier and Type	Method	Description
static CmsResource	CmsMessageBundleEditorTypes.getDescriptor(CmsObject cms, String basename)	Returns the bundle descriptor for the bundle with the provided base name.

Methods in org.opencms.ui.editors.messagebundle with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsMessageBundleEditor.initUI(I_CmsAppUIContext context, CmsResource resource, String backLink, Map<String,String> params)
boolean	CmsMessageBundleEditor.matchesResource(CmsObject cms, CmsResource resource, boolean plainText)

Constructors in org.opencms.ui.editors.messagebundle with parameters of type CmsResource

Modifier	Constructor	Description
	CmsMessageBundleEditorModel(CmsObject cms, CmsResource resource)

Uses of CmsResource in org.opencms.ui.favorites

Methods in org.opencms.ui.favorites that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsFavInfo.getResource()	Gets the resource.

Methods in org.opencms.ui.favorites with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsFavInfo.setResource(CmsResource resource)	Sets the resource

Uses of CmsResource in org.opencms.ui.sitemap

Fields in org.opencms.ui.sitemap declared as CmsResource

Modifier and Type	Field	Description
protected CmsResource	CmsUnlinkDialog.m_otherResource	The other resource.

Methods in org.opencms.ui.sitemap that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsSitemapTreeNodeData.getLinkedResource()	Gets the linked resource.
CmsResource	CmsSitemapTreeNodeData.getResource()	Gets the sitemap entry resource.
CmsResource	CmsLocaleComparePanel.getRoot()
CmsResource	CmsSitemapTreeController.getRoot()	Gets the resource corresponding to the tree's root.
CmsResource	I_CmsLocaleCompareContext.getRoot()	Gets the root resource.
CmsResource	CmsCopyPageDialog.TargetInfo.getTargetFolder()	Gets the target folder resource, or null if no target folder could be determined.
protected CmsResource	CmsSitemapTreeController.readSitemapEntryFolderIfPossible(CmsResource resource)	If the given resource is the default file of a sitmeap entry folder, then returns that folder, else the original file.

Methods in org.opencms.ui.sitemap that return types with arguments of type CmsResource

Modifier and Type	Method	Description
List<CmsResource>	CmsSitemapTreeController.DialogContext.getResources()

Methods in org.opencms.ui.sitemap with parameters of type CmsResource

Modifier and Type	Method	Description
CmsSitemapTreeNodeData	CmsSitemapTreeDataProvider.getData(CmsResource resource)	Gets the tree data for a resource.
protected void	CmsLocaleComparePanel.initTree(CmsResource rootRes)	Initializes the tree with the given resource as a root.
void	CmsLocaleLinkTargetSelectionDialog.onClickOk(CmsResource selected)	Executed when the 'OK' button is clicked.
protected CmsResource	CmsSitemapTreeController.readSitemapEntryFolderIfPossible(CmsResource resource)	If the given resource is the default file of a sitmeap entry folder, then returns that folder, else the original file.

Constructors in org.opencms.ui.sitemap with parameters of type CmsResource

Modifier	Constructor	Description
	CmsSitemapTreeController(CmsObject cms, CmsResource root, I_CmsLocaleCompareContext context, com.vaadin.ui.Component parent)	Creates a new instance.
	CmsSitemapTreeDataProvider(CmsObject cms, CmsResource root, I_CmsLocaleCompareContext context)	Creates a new instance.
	CmsUnlinkDialog(I_CmsDialogContext context, CmsResource otherResource)	Creates a new instance.
	DialogContext(CmsResource resource, CmsSitemapTreeNode node)	Creates a new instance.

Uses of CmsResource in org.opencms.ui.util

Methods in org.opencms.ui.util that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsNewResourceBuilder.createResource()	Triggers the resource creation.
CmsResource	CmsNewResourceBuilder.getCreatedResource()	Gets the created resource.
CmsResource	CmsNewResourceBuilder.safeCreateResource()	Creates a resource, but doesn't throw any exceptions.

Methods in org.opencms.ui.util with parameters of type CmsResource

Modifier and Type	Method	Description
void	CmsNewResourceBuilder.setModel(CmsResource modelResource)	Sets the model resource.

Uses of CmsResource in org.opencms.util

Methods in org.opencms.util that return types with arguments of type CmsResource

Modifier and Type	Method	Description
static List<CmsResource>	CmsFileUtil.removeRedundantResources(List<CmsResource> resources)	Removes all resources in the given List that are "redundant" because the parent folder is also contained in the List.

Methods in org.opencms.util with parameters of type CmsResource

Modifier and Type	Method	Description
static Map<String,String[]>	CmsMacroResolver.getBundleMapFromResources(Properties resourceBundle, CmsResource descriptor, CmsObject clonedCms)	Reads a bundle (key, value, descriptor) from Descriptor Resource and property resource.
static String	CmsHtmlConverter.getConversionSettings(CmsObject cms, CmsResource resource)	Reads the content conversion property of a given resource and returns its value.
static String	CmsFileUtil.getEncoding(CmsObject cms, CmsResource file)	Returns the encoding of the file.
static boolean	CmsVfsUtil.isDefaultFile(CmsObject cms, CmsResource resource)	Checks if the provided resource is a default file.
static String	CmsVfsUtil.readPropertyValueWithFolderFallbackForDefaultFiles(CmsObject cms, CmsResource resource, String propertyName, Locale locale)	Reads the property value for the provided name and resource.

Method parameters in org.opencms.util with type arguments of type CmsResource

Modifier and Type	Method	Description
static String	CmsFileUtil.formatResourceNames(CmsRequestContext context, List<CmsResource> resources)	Returns a comma separated list of resource paths names, with the site root from the given OpenCms user context removed.
static List<CmsResource>	CmsFileUtil.removeRedundantResources(List<CmsResource> resources)	Removes all resources in the given List that are "redundant" because the parent folder is also contained in the List.

Uses of CmsResource in org.opencms.widgets

Methods in org.opencms.widgets that return CmsResource

Modifier and Type	Method	Description
CmsResource	A_CmsWidget.CmsDummyWidgetDialog.getResource()	Gets the resource being edited.
protected CmsResource	CmsCategoryWidget.getResource(CmsObject cms, I_CmsWidgetParameter param)	Returns the right resource, depending on the locale.

Methods in org.opencms.widgets with parameters of type CmsResource

Modifier and Type	Method	Description
protected void	CmsHtmlWidget.addEmbeddedGalleryOptions(JSONObject result, CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)	Adds the configuration for embedded gallery widgets the the JSON object.
String	A_CmsAdeGalleryWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	A_CmsCategorizedSelectWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue contentValue, CmsMessages messages, CmsResource resource, Locale contentLocale)	Gets the configuration.
String	A_CmsFormatterWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	A_CmsGalleryWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	A_CmsSelectWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsAccessRestrictionWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsCalendarWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsCategoryWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsCheckboxWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsCodeWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue contentValue, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsColorpickerWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsDependentSelectWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsDisplayTypeSelectWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsDisplayWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsGroupWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsHtmlWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsInputWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsLocalizationWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsLocationPickerWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsMultiSelectGroupWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsPasswordWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsPrincipalWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsSelectGroupWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsSerialDateWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue contentValue, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsTextareaWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsTypeComboWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsTypeFilterWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	CmsVfsFileWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)
String	I_CmsADEWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue contentValue, CmsMessages messages, CmsResource resource, Locale contentLocale)	Returns the configuration string for the ADE content editor widget.
protected abstract com.google.web.bindery.autobean.shared.AutoBean<I_CmsCategorizedSelectData>	A_CmsCategorizedSelectWidget.getData(CmsObject cms, A_CmsXmlContentValue contentValue, CmsMessages messages, CmsResource resource, Locale contentLocale)	Gets the select option data for the widget.
static String	CmsVfsFileWidget.getDefaultSearchTypes(CmsObject cms, CmsResource resource)	Returns a comma separated list of the default search type names.
protected JSONObject	CmsVfsFileWidget.getJsonConfig(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)	Gets the JSON configuration.
protected JSONObject	A_CmsAdeGalleryWidget.getJSONConfig(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, Locale contentLocale)	Returns the gallery widget configuration as a JSON object.
protected JSONObject	CmsHtmlWidget.getJSONConfiguration(CmsObject cms, CmsResource resource, Locale contentLocale)	Returns the WYSIWYG editor configuration as a JSON object.
static JSONObject	CmsHtmlWidget.getJSONConfiguration(CmsHtmlWidgetOption widgetOptions, CmsObject cms, CmsResource resource, Locale contentLocale)	Returns the WYSIWYG editor configuration as a JSON object.
protected String	CmsVfsFileWidget.getTreeToken(CmsObject cms, A_CmsXmlContentValue value, CmsResource resource, Locale contentLocale)	Computes the tree token, which is used to decide which preloaded tree, if any, to load for the VFS/sitemap tabs.
void	A_CmsWidget.CmsDummyWidgetDialog.setResource(CmsResource resource)	Sets the resource being edited.

Constructors in org.opencms.widgets with parameters of type CmsResource

Modifier	Constructor	Description
	SearchTypesFactory(CmsObject cms, CmsResource resource)	Constructor.

Uses of CmsResource in org.opencms.workflow

Methods in org.opencms.workflow that return types with arguments of type CmsResource

Modifier and Type	Method	Description
protected List<CmsResource>	CmsDefaultWorkflowManager.cleanUpInvalidResourcesFromUserPublishList(CmsObject cms, List<CmsResource> resources)	Removes invalid publish resources (those that are unchanged, or can't be found) from the user's publish list, and only returns those which are not invalid.
Set<CmsResource>	CmsDefaultPublishResourceFormatter.AlreadyPublishedValidator.findInvalidResources(Set<CmsResource> resources)
Set<CmsResource>	CmsDefaultPublishResourceFormatter.BlockingLockedValidator.findInvalidResources(Set<CmsResource> resources)
Set<CmsResource>	CmsDefaultPublishResourceFormatter.I_PublishResourceValidator.findInvalidResources(Set<CmsResource> input)	Finds the resources which should be excluded.
Set<CmsResource>	CmsDefaultPublishResourceFormatter.NoPermissionsValidator.findInvalidResources(Set<CmsResource> resources)
protected com.google.common.base.Predicate<CmsResource>	CmsDefaultPublishResourceFormatter.getResourceMapFilter()	Gets the resource map filter.
protected com.google.common.base.Predicate<CmsResource>	CmsExtendedPublishResourceFormatter.getResourceMapFilter()
List<CmsResource>	CmsExtendedRealProjectWrapper.getResources(CmsObject cms, Map<String,String> params, String workflowId)
List<CmsResource>	CmsWorkflowResources.getWorkflowResources()	Returns the workflowResources.

Methods in org.opencms.workflow with parameters of type CmsResource

Modifier and Type	Method	Description
boolean	CmsDefaultPublishResourceFormatter.PublishPermissionFilter.apply(CmsResource input)
protected CmsPublishResource	CmsDefaultPublishResourceFormatter.createPublishResource(CmsResource resource)	Creates a publish resource bean from a resource.
CmsPublishResourceInfo	CmsDefaultPublishResourceFormatter.AlreadyPublishedValidator.getInfoForResource(CmsResource resource)
CmsPublishResourceInfo	CmsDefaultPublishResourceFormatter.BlockingLockedValidator.getInfoForResource(CmsResource resource)
CmsPublishResourceInfo	CmsDefaultPublishResourceFormatter.I_PublishResourceValidator.getInfoForResource(CmsResource resource)	Gets the status information for an excluded resource.
CmsPublishResourceInfo	CmsDefaultPublishResourceFormatter.NoPermissionsValidator.getInfoForResource(CmsResource resource)
String[]	CmsWorkflowNotification.getResourceInfo(CmsResource resource)	Gets the fields which should be displayed for a single resource.

Method parameters in org.opencms.workflow with type arguments of type CmsResource

Modifier and Type	Method	Description
protected CmsWorkflowResponse	CmsDefaultWorkflowManager.actionForcePublish(CmsObject userCms, CmsPublishOptions options, List<CmsResource> resources)	The implementation of the "forcepublish" workflow action.
protected CmsWorkflowResponse	CmsDefaultWorkflowManager.actionPublish(CmsObject userCms, CmsPublishOptions options, List<CmsResource> resources)	The implementation of the "publish" workflow action.
protected CmsWorkflowResponse	CmsExtendedWorkflowManager.actionRelease(CmsObject userCms, List<CmsResource> resources)	Implementation of the 'release' workflow action.
protected void	CmsExtendedWorkflowManager.checkNewParentsInList(CmsObject userCms, List<CmsResource> resources)	Checks that the parent folders of new resources which are released are either not new or are also released.
protected List<CmsResource>	CmsDefaultWorkflowManager.cleanUpInvalidResourcesFromUserPublishList(CmsObject cms, List<CmsResource> resources)	Removes invalid publish resources (those that are unchanged, or can't be found) from the user's publish list, and only returns those which are not invalid.
protected void	CmsExtendedWorkflowManager.clearLocks(CmsProject project, List<CmsResource> resources)	Ensures that the resources to be released are unlocked.
CmsWorkflowResponse	CmsDefaultWorkflowManager.executeAction(CmsObject userCms, CmsWorkflowAction action, CmsPublishOptions options, List<CmsResource> resources)
CmsWorkflowResponse	CmsExtendedWorkflowManager.executeAction(CmsObject userCms, CmsWorkflowAction action, CmsPublishOptions options, List<CmsResource> resources)
CmsWorkflowResponse	I_CmsWorkflowManager.executeAction(CmsObject userCms, CmsWorkflowAction action, CmsPublishOptions options, List<CmsResource> resources)	Executes a workflow action in the context of the current user.
Set<CmsResource>	CmsDefaultPublishResourceFormatter.AlreadyPublishedValidator.findInvalidResources(Set<CmsResource> resources)
Set<CmsResource>	CmsDefaultPublishResourceFormatter.BlockingLockedValidator.findInvalidResources(Set<CmsResource> resources)
Set<CmsResource>	CmsDefaultPublishResourceFormatter.I_PublishResourceValidator.findInvalidResources(Set<CmsResource> input)	Finds the resources which should be excluded.
Set<CmsResource>	CmsDefaultPublishResourceFormatter.NoPermissionsValidator.findInvalidResources(Set<CmsResource> resources)
protected void	CmsExtendedWorkflowManager.sendNotification(CmsObject userCms, CmsUser recipient, CmsProject workflowProject, List<CmsResource> resources)	Sends the notification for released resources.

Constructor parameters in org.opencms.workflow with type arguments of type CmsResource

Modifier	Constructor	Description
	CmsWorkflowNotification(CmsObject adminCms, CmsObject userCms, CmsUser receiver, String notificationContent, CmsProject project, List<CmsResource> resources, String link)	Creates a new workflow notification mail object.
	CmsWorkflowResources(List<CmsResource> workflowResources, CmsWorkflow overrideWorkflow, Integer tooManyCount)	Creates new instance.

Uses of CmsResource in org.opencms.workplace

Methods in org.opencms.workplace that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsWorkplaceLoginHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)

Methods in org.opencms.workplace with parameters of type CmsResource

Modifier and Type	Method	Description
CmsResource	CmsWorkplaceLoginHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
static boolean	CmsWorkplace.isTemporaryFile(CmsResource resource)	Returns true if the given resource is a temporary file.

Uses of CmsResource in org.opencms.workplace.comparison

Methods in org.opencms.workplace.comparison with parameters of type CmsResource

Modifier and Type	Method	Description
static List<CmsAttributeComparison>	CmsResourceComparison.compareAttributes(CmsObject cms, CmsResource resource1, CmsResource resource2)	Helper method that collects all meta attributes of the two file versions and finds out, which of the attributes were added, removed, modified or remain unchanged.
static List<CmsAttributeComparison>	CmsResourceComparison.compareProperties(CmsObject cms, CmsResource resource1, String version1, CmsResource resource2, String version2)	Helper method that finds out, which of the properties were added, removed, modified or remain unchanged.

Uses of CmsResource in org.opencms.workplace.editors

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

Modifier and Type	Method	Description
static boolean	CmsWorkplaceEditorManager.checkAcaciaEditorAvailable(CmsObject cms, CmsResource resource)	Checks whether GWT widgets are available for all fields of a content.
abstract boolean	A_CmsPreEditorActionDefinition.doPreAction(CmsResource resource, CmsDialog dialog, String originalParams)
boolean	CmsPreEditorActionDefinitionXmlContent.doPreAction(CmsResource resource, CmsDialog dialog, String originalParams)
boolean	I_CmsPreEditorActionDefinition.doPreAction(CmsResource resource, CmsDialog dialog, String originalParams)	Returns if an action has to be performed before opening the editor depending on the resource to edit and eventual request parameter values.
protected static String	CmsEditorSessionInfo.getEditorSessionInfoKey(CmsResource editedResource)	Returns the session info key for the bean.
boolean	CmsWorkplaceEditorManager.isEditorAvailableForResource(CmsResource res)	Checks if there is an editor which can process the given resource.

Uses of CmsResource in org.opencms.workplace.editors.directedit

Methods in org.opencms.workplace.editors.directedit that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsDirectEditResourceInfo.getResource()	Returns the resource that is to be direct edited.

Constructors in org.opencms.workplace.editors.directedit with parameters of type CmsResource

Modifier	Constructor	Description
	CmsDirectEditResourceInfo(CmsDirectEditPermissions permissions, CmsResource resource, CmsLock lock)	Creates a new direct edit resource info container.

Uses of CmsResource in org.opencms.workplace.explorer

Methods in org.opencms.workplace.explorer that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsResourceUtil.getResource()	Returns the resource.

Methods in org.opencms.workplace.explorer with parameters of type CmsResource

Modifier and Type	Method	Description
CmsPermissionSet	CmsExplorerTypeAccess.getPermissions(CmsObject cms, CmsResource resource)	Calculates the permissions for this explorer type settings for the user in the given OpenCms user context.
boolean	CmsExplorerTypeSettings.isEditable(CmsObject cms, CmsResource resource)	Checks if the current user has write permissions on the given resource.
void	CmsResourceUtil.setResource(CmsResource resource)	Sets the resource.

Constructors in org.opencms.workplace.explorer with parameters of type CmsResource

Modifier	Constructor	Description
	CmsResourceUtil(CmsObject cms, CmsResource resource)	Creates a new CmsResourceUtil object.
	CmsResourceUtil(CmsResource resource)	Creates a new CmsResourceUtil object.

Uses of CmsResource in org.opencms.workplace.galleries

Methods in org.opencms.workplace.galleries that return types with arguments of type CmsResource

Modifier and Type	Method	Description
protected List<CmsResource>	A_CmsAjaxGallery.getCategoryItems()	Returns the resource items for the selected category.
List<CmsResource>	A_CmsAjaxGallery.getGalleries()	Returns a list of galleries which have the required gallery type id.
static List<CmsResource>	A_CmsAjaxGallery.getGalleries(int galleryTypeId, CmsObject cms)	Returns a list of galleries which have the required gallery type id.
List<CmsResource>	A_CmsAjaxGallery.getGalleryItems()	Returns a list of gallery items (resources) for the currently selected gallery and resource type id.

Methods in org.opencms.workplace.galleries with parameters of type CmsResource

Modifier and Type	Method	Description
protected void	A_CmsAjaxGallery.buildJsonItemCommonPart(JSONObject jsonObj, CmsResource res, String sitePath)	Fills the JSON object with the information used for all resource types.
protected JSONObject	A_CmsAjaxGallery.buildJsonItemObject(CmsResource res)	Returns a JSON object containing information of the given resource for usage in the gallery.
protected abstract void	A_CmsAjaxGallery.buildJsonItemSpecificPart(JSONObject jsonObj, CmsResource res, String sitePath)	Fills the JSON object with the specific information used for this resource type.
protected void	CmsAjaxDownloadGallery.buildJsonItemSpecificPart(JSONObject jsonObj, CmsResource res, String sitePath)	Fills the JSON object with the specific information used for download file resource type.
protected void	CmsAjaxImageGallery.buildJsonItemSpecificPart(JSONObject jsonObj, CmsResource res, String sitePath)	Fills the JSON object with the specific information used for image resource type.
protected void	CmsAjaxLinkGallery.buildJsonItemSpecificPart(JSONObject jsonObj, CmsResource res, String sitePath)	Fills the JSON object with the specific information used for pointer file resource type.
protected void	A_CmsAjaxGallery.writeTitleProperty(CmsResource res)	Changes the value of the property title for the specified resource.

Method parameters in org.opencms.workplace.galleries with type arguments of type CmsResource

Modifier and Type	Method	Description
protected void	A_CmsAjaxGallery.buildJsonResourceItems(List<CmsResource> resourceitems, String parentFolder)	Builds the JSON code to create items for the folder.

Uses of CmsResource in org.opencms.xml

Methods in org.opencms.xml with parameters of type CmsResource

Modifier and Type	Method	Description
static CmsXmlContentDefinition	CmsXmlContentDefinition.getContentDefinitionForResource(CmsObject cms, CmsResource resource)	Factory method that returns the XML content definition instance for a given resource.
static I_CmsXmlContentHandler	CmsXmlContentDefinition.getContentHandlerForResource(CmsObject cms, CmsResource resource)	Returns a content handler instance for the given resource.

Uses of CmsResource in org.opencms.xml.containerpage

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

Modifier and Type	Method	Description
CmsResource	CmsLazyFolder.createFolder(CmsObject cms)	Creates the folder with the given name if it doesn't already exist, and returns it.
CmsResource	I_CmsADEConfiguration.createNewElement(CmsObject cms, String cntPageUri, javax.servlet.ServletRequest request, String type, Locale locale)	Creates a new element of a given type at the configured location.
protected CmsResource	CmsXmlContainerPage.fillResource(CmsObject cms, org.dom4j.Element element, CmsUUID resourceId)	Fills a CmsXmlVfsFileValue with the resource identified by the given id.
CmsResource	CmsConfigurationFileFinder.getConfigurationFile(CmsObject cms, String containerPageUri)	Returns the configuration file to use.
CmsResource	CmsConfigurationItem.getFolder()	Returns the destination folder uri.
CmsResource	CmsLazyFolder.getFolder(CmsObject cms)	Returns the folder if it already exists, or null if it doesn't.
CmsResource	CmsDynamicFunctionBean.getFunctionFormatter()	Gets the generic function formatter resource.
protected CmsResource	CmsDynamicFunctionParser.getFunctionFormatter(CmsObject cms)	Gets the function formatter resource, possibly from the cache.
CmsResource	CmsLazyFolder.getOrCreateFolder(CmsObject cms)	Returns the folder if it already exists, or creates and returns it if it doesn't.
CmsResource	CmsLazyFolder.getPermissionCheckFolder(CmsObject cms)	Returns the folder to check for permissions, which is either the folder itself if it already exists, or the parent folder if it doesn't.
CmsResource	CmsContainerElementBean.getResource()	Returns the resource of this element.
CmsResource	CmsConfigurationItem.getSourceFile()	Gets the source file uri.

Methods in org.opencms.xml.containerpage that return types with arguments of type CmsResource

Modifier and Type	Method	Description
Collection<CmsResource>	I_CmsADEConfiguration.getCreatableElements(CmsObject cms, String cntPageUri, javax.servlet.ServletRequest request)	Returns the list of creatable elements.
Collection<CmsResource>	I_CmsADEConfiguration.getSearchableResourceTypes(CmsObject cms, String cntPageUri, javax.servlet.ServletRequest request)	Returns the list of searchable resource types.

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

Modifier and Type	Method	Description
protected void	CmsXmlGroupContainer.fillResource(CmsObject cms, org.dom4j.Element element, CmsResource res)	Fills a CmsXmlVfsFileValue with the resource identified by the given id.
protected List<CmsDynamicFunctionBean.Format>	CmsDynamicFunctionParser.getAdditionalFormats(CmsObject cms, I_CmsXmlContentLocation location, CmsResource functionRes)	Parses all the additional formats from the XML content.
Set<String>	CmsXmlGroupContainerHandler.getCSSHeadIncludes(CmsObject cms, CmsResource resource)
Set<String>	CmsXmlInheritGroupContainerHandler.getCSSHeadIncludes(CmsObject cms, CmsResource resource)
CmsFormatterConfiguration	CmsXmlDynamicFunctionHandler.getFormatterConfiguration(CmsObject cms, CmsResource resource)
CmsFormatterConfiguration	I_CmsADEConfiguration.getFormattersForResource(CmsObject cms, String containerPageRootPath, CmsResource res)	Returns the formatter configuration for a given resource.
Set<String>	CmsXmlGroupContainerHandler.getJSHeadIncludes(CmsObject cms, CmsResource resource)
Set<String>	CmsXmlInheritGroupContainerHandler.getJSHeadIncludes(CmsObject cms, CmsResource resource)
protected CmsDynamicFunctionBean.Format	CmsDynamicFunctionParser.getMainFormat(CmsObject cms, I_CmsXmlContentLocation location, CmsResource functionRes)	Parses the main format from the XML content.
Map<String,CmsXmlContentProperty>	CmsXmlDynamicFunctionHandler.getSettings(CmsObject cms, CmsResource res)
protected static List<CmsContainerElementBean>	CmsXmlGroupContainerHandler.loadGroupContainerElements(CmsObject cms, CmsResource resource)	Helper method to load and prepare the elements of a group container.
static List<CmsContainerElementBean>	CmsXmlInheritGroupContainerHandler.loadInheritContainerElements(CmsObject cms, CmsResource resource)	Returns the elements of the given inheritance group for the request context URI.
protected CmsDynamicFunctionBean.Format	CmsDynamicFunctionParser.parseAdditionalFormat(CmsObject cms, I_CmsXmlContentValueLocation location, CmsResource functionRes)	Parses an additional format from the XML content.
CmsDynamicFunctionBean	CmsDynamicFunctionParser.parseFunctionBean(CmsObject cms, CmsResource res)	Parses a dynamic function bean given a resource.
protected CmsDynamicFunctionBean	CmsDynamicFunctionParser.parseFunctionBean(CmsObject cms, I_CmsXmlContentLocation location, CmsResource functionRes, CmsResource functionFormatter)	Parses a dynamic function bean.
protected Map<String,CmsXmlContentProperty>	CmsDynamicFunctionParser.parseSettings(CmsObject cms, I_CmsXmlContentLocation location, CmsResource functionResource)	Parses the settings for the dynamic function from the XML content.
protected void	CmsADECache.uncacheResource(CmsResource resource)
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsResource resource)	Factory method to unmarshal (read) a container page instance from a OpenCms VFS resource that contains XML data.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)	Factory method to unmarshal (read) a container page instance from a resource, using the request attributes as cache.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, CmsResource resource)	Factory method to unmarshal (read) a group container instance from a OpenCms VFS resource that contains XML data.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)	Factory method to unmarshal (read) a group container instance from a resource, using the request attributes as cache.

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

Modifier	Constructor	Description
	CmsConfigurationItem(CmsResource sourceFile, CmsResource destinationFolder, CmsLazyFolder lazyFolder, String pattern, boolean isDefault)	Creates a new type configuration item.
	CmsDynamicFunctionBean(CmsDynamicFunctionBean.Format mainFormat, List<CmsDynamicFunctionBean.Format> otherFormats, Map<String,CmsXmlContentProperty> settingConfig, CmsResource resource, CmsResource functionFormatter)	Creates a new dynamic function bean.
	CmsLazyFolder(CmsResource folder)	Initializes this object with an existing folder.
	CmsSchemaFormatterBeanWrapper(CmsObject cms, I_CmsFormatterBean wrappedBean, I_CmsXmlContentHandler contentHandler, CmsResource resource)	Creates a new wrapper instance.

Uses of CmsResource in org.opencms.xml.containerpage.mutable

Constructors in org.opencms.xml.containerpage.mutable with parameters of type CmsResource

Modifier	Constructor	Description
	CmsContainerPageWrapper(CmsObject cms, CmsResource res)	Creates a new instance by reading the container page from a file.

Uses of CmsResource in org.opencms.xml.content

Methods in org.opencms.xml.content with parameters of type CmsResource

Modifier and Type	Method	Description
Set<String>	CmsDefaultXmlContentHandler.getCSSHeadIncludes(CmsObject cms, CmsResource resource)
Set<String>	I_CmsXmlContentHandler.getCSSHeadIncludes(CmsObject cms, CmsResource resource)	Returns all the CSS resources to include into the html-page head.
String	CmsDefaultXmlContentHandler.getDefault(CmsObject cms, CmsResource resource, I_CmsXmlSchemaType type, String path, Locale locale)
String	I_CmsXmlContentHandler.getDefault(CmsObject cms, CmsResource resource, I_CmsXmlSchemaType type, String path, Locale locale)	Returns the default String value for the given XML content schema type object in the given XML content.
CmsFormatterConfiguration	CmsDefaultXmlContentHandler.getFormatterConfiguration(CmsObject cms, CmsResource resource)
CmsFormatterConfiguration	I_CmsXmlContentHandler.getFormatterConfiguration(CmsObject cms, CmsResource res)	Returns the container page element formatter configuration for a given resource.
Set<String>	CmsDefaultXmlContentHandler.getJSHeadIncludes(CmsObject cms, CmsResource resource)
Set<String>	I_CmsXmlContentHandler.getJSHeadIncludes(CmsObject cms, CmsResource resource)	Returns all the javascript resources to include into the html-page head.
static CmsMacroResolver	CmsXmlContentPropertyHelper.getMacroResolverForProperties(CmsObject cms, I_CmsXmlContentHandler contentHandler, CmsXmlContent content, Function<String,String> stringtemplateSource, CmsResource containerPage)	Creates and configures a new macro resolver for resolving macros which occur in property definitions.
List<String>	CmsDefaultXmlContentHandler.getNestedFormatters(CmsObject cms, CmsResource res, Locale locale, javax.servlet.ServletRequest req)
List<String>	I_CmsXmlContentHandler.getNestedFormatters(CmsObject cms, CmsResource res, Locale locale, javax.servlet.ServletRequest req)	Returns the nested formatters for the given resource.
static Map<String,CmsXmlContentProperty>	CmsXmlContentPropertyHelper.getPropertyInfo(CmsObject cms, CmsResource page, CmsResource resource)	Returns the property information for the given resource (type) AND the current user.
Map<String,CmsXmlContentProperty>	CmsDefaultXmlContentHandler.getSettings(CmsObject cms, CmsResource resource)
Map<String,CmsXmlContentProperty>	I_CmsXmlContentHandler.getSettings(CmsObject cms, CmsResource resource)	Returns the element settings defined for the container page formatters.
boolean	CmsDefaultXmlContentHandler.isValueVisible(CmsObject cms, I_CmsXmlSchemaType value, String elementName, String params, CmsResource resource, Locale contentLocale)	Returns the content field visibilty.
boolean	I_CmsXmlContentVisibilityHandler.isValueVisible(CmsObject cms, I_CmsXmlSchemaType value, String elementPath, String params, CmsResource resource, Locale contentLocale)	Returns if the given content value field should be visible to the current user.
boolean	CmsDefaultXmlContentHandler.isVisible(CmsObject cms, I_CmsXmlSchemaType contentValue, String valuePath, CmsResource resource, Locale contentLocale)
boolean	I_CmsXmlContentHandler.isVisible(CmsObject cms, I_CmsXmlSchemaType schemaType, String valuePath, CmsResource resource, Locale contentLocale)	Returns if the given content field should be visible to the current user.
static Map<String,String>	CmsXmlContentPropertyHelper.mergeDefaults(CmsObject cms, CmsADEConfigData config, CmsResource resource, Map<String,String> properties, Locale locale, javax.servlet.ServletRequest request)	Extends the given properties with the default values from the resource's property configuration.
static Map<String,CmsXmlContentProperty>	CmsXmlContentPropertyHelper.resolveMacrosForPropertyInfo(CmsObject cms, CmsResource page, CmsResource resource, com.google.common.base.Supplier<CmsXmlContent> contentGetter, Function<String,String> stringtemplateSource, Map<String,CmsXmlContentProperty> propertiesConf)	Resolves macros in the given property information for the given resource (type) AND the current user.
void	CmsMappingResolutionContext.setAttribute(CmsResource res, CmsMappingResolutionContext.AttributeType type, Long value)	Helper method for setting release/expiration date.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)	Factory method to unmarshal (read) a XML content instance from a resource, using the request attributes as cache.

Uses of CmsResource in org.opencms.xml.page

Methods in org.opencms.xml.page with parameters of type CmsResource

Modifier and Type	Method	Description
static CmsXmlPage	CmsXmlPageFactory.unmarshal(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)	Factory method to unmarshal (read) a XML page instance from a resource, using the request attributes as cache.

Uses of CmsResource in org.opencms.xml.templatemapper

Method parameters in org.opencms.xml.templatemapper with type arguments of type CmsResource

Modifier and Type	Method	Description
CmsMenuItemVisibilityMode	CmsTemplateMapperAction.getVisibility(CmsObject cms, List<CmsResource> resources)

Constructors in org.opencms.xml.templatemapper with parameters of type CmsResource

Modifier	Constructor	Description
protected	CmsTemplateMappingContentRewriter(CmsObject cms, CmsResource folder)	Creates a new instance.

Uses of CmsResource in org.opencms.xml.xml2json

Methods in org.opencms.xml.xml2json that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsJsonResult.getNextResource()	Gets the next resource which should be loaded.
CmsResource	CmsJsonResourceHandler.initResource(CmsResource origRes, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)

Methods in org.opencms.xml.xml2json with parameters of type CmsResource

Modifier and Type	Method	Description
CmsResource	CmsJsonResourceHandler.initResource(CmsResource origRes, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
static String	CmsJsonResourceHandler.link(CmsObject cms, CmsResource res)	Produces a link to the given resource, using the link renderer from the current CMS context if it is set.

Constructors in org.opencms.xml.xml2json with parameters of type CmsResource

Modifier	Constructor	Description
	CmsJsonResult(CmsResource resource)	Creates a result which indicates that a different resource should be loaded instead.
	CmsResourceDataJsonHelper(CmsObject cms, CmsResource resource, Predicate<String> propertyFilter)	Creates a new instance.

Uses of CmsResource in org.opencms.xml.xml2json.document

Fields in org.opencms.xml.xml2json.document declared as CmsResource

Modifier and Type	Field	Description
protected CmsResource	CmsJsonDocumentResource.m_resource	The resource.

Methods in org.opencms.xml.xml2json.document with parameters of type CmsResource

Modifier and Type	Method	Description
protected JSONObject	CmsJsonDocumentFolder.folderListingJson(CmsResource target, int levelsLeft)	Formats folder listing as a JSON object, with the individual file names in the folder as keys.
protected void	CmsJsonDocumentXmlContent.insertJsonLinkedContent(CmsResource resource)	Inserts a JSON representation of a linked content into this JSON document.

Constructors in org.opencms.xml.xml2json.document with parameters of type CmsResource

Modifier	Constructor	Description
	CmsJsonDocumentResource(CmsJsonRequest jsonRequest, CmsResource resource)	Creates a new JSON document.

Uses of CmsResource in org.opencms.xml.xml2json.handler

Methods in org.opencms.xml.xml2json.handler that return CmsResource

Modifier and Type	Method	Description
CmsResource	CmsJsonHandlerContext.getResource()	Gets the resource (may be null if there is no resource).

Constructors in org.opencms.xml.xml2json.handler with parameters of type CmsResource

Modifier	Constructor	Description
	CmsJsonHandlerContext(CmsObject cms, CmsObject rootCms, String path, CmsResource resource, Map<String,String> params, CmsParameterConfiguration handlerConfig, CmsJsonAccessPolicy policy)	Creates a new instance.

Uses of CmsResource in org.opencms.xml.xml2json.renderer

Constructors in org.opencms.xml.xml2json.renderer with parameters of type CmsResource

Modifier	Constructor	Description
	CmsJsonRendererContainerPage(CmsObject cms, CmsResource page, Predicate<String> propertyFilter)	Creates a new renderer instance.