| 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 {@link org.opencms.file.CmsObject}
which will encapsulate the current users permissions.
@version $Revision: 1.13 $
@since 6.0.0
@see org.opencms.file.CmsObject
@see org.opencms.file.CmsRequestContext
@see org.opencms.file.CmsUser
@see org.opencms.file.CmsResource
@see org.opencms.file.types.I_CmsResourceType
|
| Java Source File Name | Type | Comment |
| CmsBackupProject.java | Class | |
| CmsBackupResource.java | Class | A backup resource for the OpenCms VFS resource history.
Backup resources are basic resources that contain additional information
used to describe the backup state. |
| CmsBackupResourceHandler.java | Class | |
| CmsDataAccessException.java | Class | Signals data access related issues, i.e. |
| CmsDataNotImplementedException.java | Class | Signals that an attempt to call a method has failed since it is not implemented.
This exception may be thrown by various driver implementation classes. |
| CmsFile.java | Class | |
| CmsFolder.java | Class | |
| CmsGroup.java | Class | |
| CmsObject.java | Class | This pivotal class provides all authorized access to the OpenCms VFS resources.
It encapsulates user identification and permissions.
Think of it as an initialized "shell" to access the OpenCms VFS.
Every call to a method here will be checked for user permissions
according to the
org.opencms.file.CmsRequestContext this CmsObject instance was created with.
From a JSP page running in OpenCms, use
org.opencms.jsp.CmsJspBean.getCmsObject to gain
access to the current users CmsObject. |
| CmsProject.java | Class | |
| CmsProperty.java | Class | Represents a property (meta-information) mapped to a VFS resource.
A property is an object that contains three string values: a name, a property value which is mapped
to the structure record of a resource, and a property value which is mapped to the resource
record of a resource. |
| CmsPropertyDefinition.java | Class | |
| CmsRequestContext.java | Class | |
| CmsResource.java | Class | Base class for all OpenCms VFS resources like
CmsFile or
CmsFolder .
The OpenCms VFS resource is an important object for using the OpenCms API. |
| CmsResourceFilter.java | Class | Provides filters for resource result sets obtained from requests to the OpenCms VFS.
Using the constant filters provided by this class
you can control "special" behaviour
of access to the VFS. |
| CmsUser.java | Class | A user principal in the OpenCms permission system.
A user in OpenCms is uniquely defined by its user named returned by
CmsUser.getName() .
Basic users in OpenCms are users that can access the OpenCms Workplace.
Moreover, the user must be created by another user with the
org.opencms.security.CmsRole.ACCOUNT_MANAGER role.
These users are "content managers" that actually have write permissions in
at last some parts of the VFS.
Another possibility is to have users in a 'Guests' group.
These users do not have access to the OpenCms Workplace. |
| CmsVfsException.java | Class | |
| CmsVfsResourceAlreadyExistsException.java | Class | |
| CmsVfsResourceNotFoundException.java | Class | |
| Messages.java | Class | |