Uses of Class
org.opencms.file.CmsResourceFilter
Packages that use CmsResourceFilter
Package
Description
Contains server side classes for the gallery dialogs.
Low-level database connection and access functionality.
This important package provides the methods to access the OpenCms VFS repository with the permissions
of an authenticated user.
This package contains classes and interfaces used to access OpenCms through a wrapped
CmsObject.The implementation of the OpenCms JSP tag library, with some additional utility classes to
help in JSP scriplet code and navigation building.
Classes to represent and validate the internal and external links/relations of resources in the OpenCms VFS.
Implements the main full text search and indexing functions available in OpenCms.
The package contains the Solr search integration.
Access control and security classes for the OpenCms ACL permission system.
Contains components for selecting resources.
-
Uses of CmsResourceFilter in org.opencms.ade.galleries
Methods in org.opencms.ade.galleries with parameters of type CmsResourceFilterModifier and TypeMethodDescriptionprotected 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. -
Uses of CmsResourceFilter in org.opencms.db
Methods in org.opencms.db with parameters of type CmsResourceFilterModifier and TypeMethodDescriptionprotected voidCmsSecurityManager.checkPermissions(CmsDbContext dbc, CmsResource resource, CmsPermissionSet requiredPermissions, boolean checkLock, CmsResourceFilter filter) Performs a blocking permission check on a resource.protected voidCmsSecurityManager.checkPermissions(CmsDbContext dbc, CmsResource resource, CmsPermissionSet requiredPermissions, I_CmsPermissionHandler.LockCheck checkLock, CmsResourceFilter filter) Performs a blocking permission check on a resource.voidCmsSecurityManager.checkPermissions(CmsRequestContext context, CmsResource resource, CmsPermissionSet requiredPermissions, boolean checkLock, CmsResourceFilter filter) Performs a blocking permission check on a resource.booleanCmsSecurityManager.existsResource(CmsRequestContext context, String resourcePath, CmsResourceFilter filter) Checks the availability of a resource in the VFS, using thefilter.DEFAULTbooleanCmsSecurityManager.existsResource(CmsRequestContext context, CmsUUID structureId, CmsResourceFilter filter) Checks the availability of a resource in the VFS, using thefilter.DEFAULTCmsSecurityManager.hasPermissions(CmsDbContext dbc, CmsResource resource, CmsPermissionSet requiredPermissions, I_CmsPermissionHandler.LockCheck checkLock, CmsResourceFilter filter) Performs a non-blocking permission check on a resource.CmsSecurityManager.hasPermissions(CmsRequestContext context, CmsResource resource, CmsPermissionSet requiredPermissions, boolean checkLock, CmsResourceFilter filter) Performs a non-blocking permission check on a resource.CmsSecurityManager.hasPermissions(CmsRequestContext context, CmsResource resource, CmsPermissionSet requiredPermissions, I_CmsPermissionHandler.LockCheck checkLock, CmsResourceFilter filter) Performs a non-blocking permission check on a resource.CmsSecurityManager.readAncestor(CmsRequestContext context, CmsResource resource, CmsResourceFilter filter) Returns the first ancestor folder matching the filter criteria.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.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.CmsDriverManager.readDefaultFile(CmsDbContext dbc, CmsResource resource, CmsResourceFilter resourceFilter) Returns the default file for the given folder.CmsSecurityManager.readDefaultFile(CmsRequestContext context, CmsResource resource, CmsResourceFilter resourceFilter) Returns the default file for the given folder.CmsDriverManager.readFolder(CmsDbContext dbc, String resourcename, CmsResourceFilter filter) Reads a folder from the VFS, using the specified resource filter.protected CmsFolderCmsSecurityManager.readFolder(CmsDbContext dbc, String resourcename, CmsResourceFilter filter) Reads a folder from the VFS, using the specified resource filter.CmsSecurityManager.readFolder(CmsRequestContext context, String resourcename, CmsResourceFilter filter) Reads a folder resource from the VFS, using the specified resource filter.CmsDriverManager.readPath(CmsDbContext dbc, String path, CmsResourceFilter filter) Builds a list of resources for a given path.CmsSecurityManager.readPath(CmsRequestContext context, String path, CmsResourceFilter filter) Builds a list of resources for a given path.CmsDriverManager.readResource(CmsDbContext dbc, String resourcePath, CmsResourceFilter filter) Reads a resource from the VFS, using the specified resource filter.CmsDriverManager.readResource(CmsDbContext dbc, CmsUUID structureID, CmsResourceFilter filter) Reads a resource from the VFS, using the specified resource filter.protected CmsResourceCmsSecurityManager.readResource(CmsDbContext dbc, String resourcePath, CmsResourceFilter filter) Reads a resource from the OpenCms VFS, using the specified resource filter.protected CmsResourceCmsSecurityManager.readResource(CmsDbContext dbc, CmsUUID structureID, CmsResourceFilter filter) Reads a resource from the OpenCms VFS, using the specified resource filter.CmsSecurityManager.readResource(CmsRequestContext context, String resourcePath, CmsResourceFilter filter) Reads a resource from the VFS, using the specified resource filter.CmsSecurityManager.readResource(CmsRequestContext context, CmsUUID structureID, CmsResourceFilter filter) Reads a resource from the VFS, using the specified resource filter.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 thereadTreeparameter istrue.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 thereadTreeparameter istrue.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.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.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.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. -
Uses of CmsResourceFilter in org.opencms.file
Fields in org.opencms.file declared as CmsResourceFilterModifier and TypeFieldDescriptionstatic final CmsResourceFilterCmsResourceFilter.ALLFilter to display all resources.static final CmsResourceFilterCmsResourceFilter.ALL_MODIFIEDFilter to display all modified (new/changed/deleted) resources.static final CmsResourceFilterCmsResourceFilter.DEFAULTDefault filter to display resources for the online project.static final CmsResourceFilterCmsResourceFilter.DEFAULT_FILESDefault filter to display files for the online project.static final CmsResourceFilterCmsResourceFilter.DEFAULT_FOLDERSDefault filter to display folders for the online project.static final CmsResourceFilterCmsResourceFilter.DEFAULT_ONLY_VISIBLEDefault filter to display resources for the online project.static final CmsResourceFilterCmsResourceFilter.IGNORE_EXPIRATIONFilter to display resources ignoring the release and expiration dates.static final CmsResourceFilterCmsResourceFilter.ONLY_VISIBLEFilter to display only visible resources.static final CmsResourceFilterCmsResourceFilter.ONLY_VISIBLE_NO_DELETEDFilter to display only visible and not deleted resources.Methods in org.opencms.file that return CmsResourceFilterModifier and TypeMethodDescriptionCmsResourceFilter.addExcludeFlags(int flags) Returns an extended filter in order to avoid the given flags in the filtered resources.CmsResourceFilter.addExcludeState(CmsResourceState state) Returns an extended filter in order to avoid the given type in the filtered resources.CmsResourceFilter.addExcludeTimerange()Returns an extended filter to guarantee all filtered resources ignoring the time range (released and not expired) window.CmsResourceFilter.addExcludeType(int type) Deprecated.CmsResourceFilter.addExcludeType(I_CmsResourceType type) Returns an extended filter in order to avoid the given type in the filtered resources.CmsResourceFilter.addRequireExpireAfter(long time) Returns an extended filter to restrict the results to resources that expire in the given timerange.CmsResourceFilter.addRequireExpireBefore(long time) Returns an extended filter to restrict the results to resources that expire in the given timerange.CmsResourceFilter.addRequireFile()Returns an extended filter that requires all returned resources to be files.CmsResourceFilter.addRequireFlags(int flags) Returns an extended filter to guarantee a distinct resource flags of the filtered resources.CmsResourceFilter.addRequireFolder()Returns an extended filter that requires all returned resources to be folders.CmsResourceFilter.addRequireLastModifiedAfter(long time) Returns an extended filter to restrict the results to resources modified in the given timerange.CmsResourceFilter.addRequireLastModifiedBefore(long time) Returns an extended filter to restrict the results to resources modified in the given timerange.CmsResourceFilter.addRequireReleaseAfter(long time) Returns an extended filter to restrict the results to resources that are released in the given timerange.CmsResourceFilter.addRequireReleaseBefore(long time) Returns an extended filter to restrict the results to resources that are released in the given timerange.CmsResourceFilter.addRequireState(CmsResourceState state) Returns an extended filter to guarantee a distinct resource state of the filtered resources.CmsResourceFilter.addRequireTimerange()Returns an extended filter to guarantee all filtered resources are valid (released and not expired).CmsResourceFilter.addRequireType(int type) Deprecated.UseaddRequireType(I_CmsResourceType)instead.CmsResourceFilter.addRequireType(I_CmsResourceType type) Returns an extended filter to guarantee a distinct resource type of the filtered resources.CmsResourceFilter.addRequireVisible()Returns an extended filter to guarantee all filtered resources are visible.static CmsResourceFilterCmsResourceFilter.ignoreExpirationOffline(CmsObject cms) Returns the DEFAULT filter in the Online project, and IGNORE_EXPIRATION otherwise.static CmsResourceFilterCmsResourceFilter.requireType(int type) Deprecated.UserequireType(I_CmsResourceType)instead.static CmsResourceFilterCmsResourceFilter.requireType(I_CmsResourceType type) Returns a new CmsResourceFilter requiring the given type.Methods in org.opencms.file with parameters of type CmsResourceFilterModifier and TypeMethodDescriptionbooleanCmsObject.existsResource(String resourcename, CmsResourceFilter filter) Checks the availability of a resource in the VFS, using the provided filter.booleanCmsObject.existsResource(CmsUUID structureId, CmsResourceFilter filter) Checks the availability of a resource in the VFS, using thefilter.DEFAULTCmsObject.getFilesInFolder(String resourcename, CmsResourceFilter filter) Returns all file resources contained in a folder.CmsObject.getResourcesInFolder(String resourcename, CmsResourceFilter filter) Returns all child resources of a resource, that is the resources contained in a folder.CmsObject.getSubFolders(String resourcename, CmsResourceFilter filter) Returns all folder resources contained in a folder.booleanCmsObject.hasPermissions(CmsResource resource, CmsPermissionSet requiredPermissions, boolean checkLock, CmsResourceFilter filter) Checks if the current user has required permissions to access a given resource.CmsObject.readAncestor(String resourcename, CmsResourceFilter filter) Returns the first ancestor folder matching the filter criteria.CmsObject.readDefaultFile(String resourceNameOrID, CmsResourceFilter filter) Returns the default resource for the given folder.CmsObject.readDefaultFile(CmsResource folderResource, CmsResourceFilter resourceFilter) Returns the default resource for the given folder.CmsObject.readFile(String resourcename, CmsResourceFilter filter) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.CmsObject.readFolder(String resourcename, CmsResourceFilter filter) Reads a folder resource from the VFS, using the specified resource filter.CmsObject.readPath(String path, CmsResourceFilter filter) Builds a list of resources for a given path.CmsObject.readPath(CmsResource resource, CmsResourceFilter filter) Builds a list of resources for a given path.CmsObject.readResource(String resourcename, CmsResourceFilter filter) Reads a resource from the VFS, using the specified resource filter.CmsObject.readResource(CmsUUID structureID, CmsResourceFilter filter) Reads a resource from the VFS, using the specified resource filter.CmsObject.readResources(String resourcename, CmsResourceFilter filter) Reads all resources below the given path matching the filter criteria, including the full tree below the path.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 thereadTreeparameter istrue.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 thereadTreeparameter istrue.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.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.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.CmsObject.readSiblingsForResourceId(CmsUUID resourceId, CmsResourceFilter filter) Reads all resources with the given resource id. -
Uses of CmsResourceFilter in org.opencms.file.wrapper
Methods in org.opencms.file.wrapper with parameters of type CmsResourceFilterModifier and TypeMethodDescriptionA_CmsResourceWrapper.addResourcesToFolder(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsResourceWrapperModules.addResourcesToFolder(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsResourceWrapperModulesNonLazy.addResourcesToFolder(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsResourceWrapperPropertyFile.addResourcesToFolder(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsResourceWrapperSystemFolder.addResourcesToFolder(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsResourceWrapperXmlPage.addResourcesToFolder(CmsObject cms, String resourcename, CmsResourceFilter filter) 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.CmsObjectWrapper.getResourcesInFolder(String resourcename, CmsResourceFilter filter) Returns all child resources of a resource, that is the resources contained in a folder.A_CmsResourceExtensionWrapper.readFile(CmsObject cms, String resourcename, CmsResourceFilter filter) A_CmsResourceWrapper.readFile(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsObjectWrapper.readFile(String resourcename, CmsResourceFilter filter) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.CmsResourceWrapperModules.readFile(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsResourceWrapperModulesNonLazy.readFile(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsResourceWrapperPropertyFile.readFile(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsResourceWrapperXmlPage.readFile(CmsObject cms, String resourcename, CmsResourceFilter filter) I_CmsResourceWrapper.readFile(CmsObject cms, String resourcename, CmsResourceFilter filter) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.A_CmsResourceExtensionWrapper.readResource(CmsObject cms, String resourcename, CmsResourceFilter filter) A_CmsResourceWrapper.readResource(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsObjectWrapper.readResource(String resourcename, CmsResourceFilter filter) Reads a resource from the VFS, using thefilter.DEFAULTCmsObjectWrapper.readResource(CmsUUID structureID, CmsResourceFilter filter) Delegate method forCmsObject.readResource(CmsUUID, CmsResourceFilter).CmsResourceWrapperModules.readResource(CmsObject cms, String resourcepath, CmsResourceFilter filter) CmsResourceWrapperModulesNonLazy.readResource(CmsObject cms, String resourcepath, CmsResourceFilter filter) CmsResourceWrapperPropertyFile.readResource(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsResourceWrapperSystemFolder.readResource(CmsObject cms, String resourcename, CmsResourceFilter filter) CmsResourceWrapperXmlPage.readResource(CmsObject cms, String resourcename, CmsResourceFilter filter) I_CmsResourceWrapper.readResource(CmsObject cms, String resourcename, CmsResourceFilter filter) Reads a resource from the VFS, using the specified resource filter. -
Uses of CmsResourceFilter in org.opencms.jlan
Fields in org.opencms.jlan declared as CmsResourceFilterModifier and TypeFieldDescriptionstatic final CmsResourceFilterCmsJlanDiskInterface.STANDARD_FILTERThe standard resource filter used for reading resources. -
Uses of CmsResourceFilter in org.opencms.jsp
Methods in org.opencms.jsp that return CmsResourceFilterModifier and TypeMethodDescriptionCmsJspNavBuilder.NavContext.getFilter()Gets the resource filter.Methods in org.opencms.jsp with parameters of type CmsResourceFilterModifier and TypeMethodDescriptionCmsJspNavBuilder.getNavigationForFolder(String folder, CmsJspNavBuilder.Visibility visibility, CmsResourceFilter resourceFilter) Collect all navigation elements from the files in the given folder.CmsJspNavBuilder.getNavigationForResource(String sitePath, CmsResourceFilter reourceFilter) Returns a navigation element for the named resource.Constructors in org.opencms.jsp with parameters of type CmsResourceFilterModifierConstructorDescriptionNavContext(CmsJspNavBuilder navBuilder, CmsJspNavBuilder.Visibility visibility, CmsResourceFilter filter) Creates a new instance. -
Uses of CmsResourceFilter in org.opencms.relations
Methods in org.opencms.relations with parameters of type CmsResourceFilterModifier and TypeMethodDescriptionCmsRelation.getSource(CmsObject cms, CmsResourceFilter filter) Returns the source resource when possible to read with the given filter.CmsRelation.getTarget(CmsObject cms, CmsResourceFilter filter) Returns the target resource when possible to read with the given filter.CmsCategoryService.readCategoryResources(CmsObject cms, String categoryPath, boolean recursive, String referencePath, CmsResourceFilter resFilter) Reads the resources for a category identified by the given category path. -
Uses of CmsResourceFilter in org.opencms.search
Methods in org.opencms.search with parameters of type CmsResourceFilterModifier and TypeMethodDescriptionprotected CmsResourceCmsSearchIndex.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. -
Uses of CmsResourceFilter in org.opencms.search.solr
Methods in org.opencms.search.solr with parameters of type CmsResourceFilterModifier and TypeMethodDescriptionprotected booleanCmsSolrIndex.hasPermissions(CmsObject cms, CmsSolrDocument doc, CmsResourceFilter filter) Check, if the current user has permissions on the document's resource.CmsSolrIndex.search(CmsObject cms, CmsSolrQuery query, boolean ignoreMaxRows, jakarta.servlet.ServletResponse response, boolean ignoreSearchExclude, CmsResourceFilter filter) Performs the actual search.CmsSolrIndex.search(CmsObject cms, CmsSolrQuery query, boolean ignoreMaxRows, jakarta.servlet.ServletResponse response, boolean ignoreSearchExclude, CmsResourceFilter filter, int maxNumResults) Performs the actual search.CmsSolrIndex.search(CmsObject cms, CmsSolrQuery query, boolean ignoreMaxRows, CmsResourceFilter filter) LikeCmsSolrIndex.search(CmsObject, CmsSolrQuery, boolean), but additionally a resource filter can be specified. -
Uses of CmsResourceFilter in org.opencms.security
Methods in org.opencms.security with parameters of type CmsResourceFilterModifier and TypeMethodDescriptionCmsDefaultPermissionHandler.hasPermissions(CmsDbContext dbc, CmsResource resource, CmsPermissionSet requiredPermissions, I_CmsPermissionHandler.LockCheck checkLock, CmsResourceFilter filter) I_CmsPermissionHandler.hasPermissions(CmsDbContext dbc, CmsResource resource, CmsPermissionSet requiredPermissions, I_CmsPermissionHandler.LockCheck checkLock, CmsResourceFilter filter) Performs a non-blocking permission check on a resource. -
Uses of CmsResourceFilter in org.opencms.ui.components.fileselect
Fields in org.opencms.ui.components.fileselect declared as CmsResourceFilterModifier and TypeFieldDescriptionprotected CmsResourceFilterA_CmsFileSelectField.m_filterThe filter used for reading resources.protected CmsResourceFilterCmsResourceSelectDialog.m_resourceFilterThe resource filter.Methods in org.opencms.ui.components.fileselect with parameters of type CmsResourceFilterModifier and TypeMethodDescriptionvoidA_CmsFileSelectField.setResourceFilter(CmsResourceFilter filter) Sets the filter to use for reading resources.voidCmsResourceTreeContainer.update(CmsObject cms, CmsUUID id, CmsResourceFilter filter) Updates the item for the given structure id.Constructors in org.opencms.ui.components.fileselect with parameters of type CmsResourceFilterModifierConstructorDescriptionCreates a new instance.CmsResourceSelectDialog(CmsResourceFilter filter, CmsObject cms) public constructor with given CmsObject.CmsResourceSelectDialog(CmsResourceFilter filter, CmsObject _cms, CmsResourceSelectDialog.Options options) public constructor.Default constructor.CmsResourceTreeTable(CmsObject cms, CmsResource root, CmsResourceFilter filter) Creates a new instance.
addExcludeType(I_CmsResourceType)instead.