Package org.opencms.file
This important package provides the methods to access the OpenCms VFS repository with the permissions
of an authenticated user.
To access the OpenCms VFS repository, obtain a
which will encapsulate the current users permissions.CmsObject
- Since:
- 6.0.0
- See Also:
CmsObject
,CmsRequestContext
,CmsUser
,CmsResource
,I_CmsResourceType
-
Interface Summary Interface Description I_CmsResource Common ancestor interface forCmsFile
andCmsFolder
as well as forCmsHistoryFile
andCmsHistoryFolder
. -
Class Summary Class Description CmsFile A file resource in the OpenCms VFS.CmsFolder A folder resource in the OpenCms VFS.CmsGroup A group principal in the OpenCms permission system.CmsLinkRewriter A class used to rewrite links and relations in one subtree such that relations from that subtree to another given subtree replaced with relations to the first subtree.CmsObject This pivotal class provides all authorized access to the OpenCms VFS resources.CmsProject Describes an OpenCms project, which contains a set of VFS resources that are being worked on at the same time.CmsProject.CmsProjectType Enumeration class for project types.CmsProperty Represents a property (meta-information) mapped to a VFS resource.CmsProperty.CmsPropertyLocaleTransformer Transforms a given properties map, to a map where the returned values for a property are dependent on the locale.CmsPropertyDefinition Defines a property name, so that
instances can be created with that name.CmsProperty
CmsPropertyDefinition.CmsPropertyType Enumeration class for property types.CmsRequestContext Stores the information about the current users OpenCms context, for example the requested URI, the current project, the selected site and more.CmsResource CmsResource.CmsResourceCopyMode Enumeration class for resource copy modes.CmsResource.CmsResourceDeleteMode Enumeration class for resource delete modes.CmsResource.CmsResourceUndoMode Enumeration class for resource undo changes modes.CmsResourceBuilder This class allows the developer to build a CmsResource object by filling out individual fields one after the other.CmsResourceFilter Provides filters for resource result sets obtained from requests to the OpenCms VFS.CmsUser A user principal in the OpenCms permission system.CmsUserSearchParameters An object which represents search criteria for retrieving users.Messages Convenience class to access the localized messages of this OpenCms package. -
Enum Summary Enum Description CmsUserSearchParameters.SearchKey An enum used for indicating searchable columns.CmsUserSearchParameters.SortKey An enum used for indicating sort order.I_CmsResource.CmsResourceAttribute Enumeration for all attributes of a resource. -
Exception Summary Exception Description CmsDataAccessException Signals data access related issues, i.e.CmsDataNotImplementedException Signals that an attempt to call a method has failed since it is not implemented.CmsVfsException Used to signal VFS related issues, for example during file access.CmsVfsResourceAlreadyExistsException Signals that a VFS resource unexpectedly exists.CmsVfsResourceNotFoundException Signals that an attempt to read a resource in the VFS denoted by a specified pathname has failed.