Package org.opencms.file

This important package provides the methods to access the OpenCms VFS repository with the permissions of an authenticated user.

See:
Description

Class Summary

CmsBackupProject	Deprecated. use CmsHistoryProject
CmsBackupResource	Deprecated. use CmsHistoryFile instead
CmsBackupResourceHandler	Deprecated. use CmsHistoryResourceHandler instead
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.
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.
CmsPropertyDefinition	Defines a property name, so that CmsProperty instances can be created with that name.
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	Base class for all OpenCms VFS resources like CmsFile or CmsFolder.
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.
CmsResourceFilter	Provides filters for resource result sets obtained from requests to the OpenCms VFS.
CmsUser	A user principal in the OpenCms permission system.

Exception Summary

CmsDataAccessException	Signals data access related issues, i.e. database access.
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.

Package org.opencms.file Description

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 CmsObject which will encapsulate the current users permissions.

Since:

6.0.0

Version:

$Revision: 1.13 $

See Also:

CmsObject, CmsRequestContext, CmsUser, CmsResource, I_CmsResourceType