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

Interface Summary

I_CmsResource

Common ancestor interface for CmsFile and CmsFolder as well as for and CmsHistoryFolder.

Class Summary

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.
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.
CmsUserSearchParameters	An object which represents search criteria for retrieving users.
TestAvailability	Unit test for the "setDateExpired" and "setDateReleased" method of the CmsObject.
TestChacc	Unit test for the "chacc" method of the CmsObject.
TestChangeProperties	Unit tests for the CmsObject.changeResourcesInFolderWithProperty(String, String, String, String, boolean) method.
TestChflags	Unit test for the "chflags" method of the CmsObject.
TestChtype	Unit test for the "chtype" method of the CmsObject.
TestConcurrentOperations	Unit test for concurrent operations of the CmsObject.
TestCopy	Unit tests for copy operation.
TestCounters	Unit tests for the counters.
TestCreateWriteResource	Unit tests for the create and import methods.
TestDefaultResourceCollectors	Tests the default resource collectors.
TestDeletion	Unit tests for VFS permissions.
TestExists	Unit tests for resource availability operations.
TestGroupOperations	Unit tests for basic group operations without test import.
TestHistory	Unit tests for history operation.
TestLinkRewriter	Test class for the CmsLinkRewriter class.
TestLinkValidation	Unit tests for OpenCms link validation.
TestLock	Unit tests for lock operation.
TestMoveRename	Unit tests for move/rename operation.
TestMoveRename2	Unit tests for move/rename operation.
TestMoveRename3	Unit tests for move/delete/publish operations.
TestPermissions	Unit tests for VFS permissions.
TestProjectHistory	Unit test for the project history function of the CmsObject.
TestProjects	Unit tests OpenCms projects.
TestProperty	Unit test for the "writeProperty" method of the CmsObject.
TestPropertyDefinition	Unit test for the "createPropertyDefinition", "readPropertyDefiniton" and "readAllPropertyDefintions" methods of the CmsObject.
TestPublishing	Unit tests for OpenCms publishing.
TestPublishIssues	Comment for TestPermissions.
TestReadResource	Unit test for the "readFileHeader" method of the CmsObject to test the release and expiration date.
TestReadResourceTree	Unit test for the "readResources" method of the CmsObject to test reading resource lists within a subtree.
TestReplace	Unit tests for replace operation.
TestResourceFilter	Unit test for CmsResourceFilter.
TestResourceOperations	Unit tests for basic resource operations without test import.
TestRestoreFromHistory	Unit tests for the history restore method.
TestSiblings	Unit test for operations on siblings.
TestTouch	Unit test for the "touch" method of the CmsObject.
TestUndelete	Unit test for the "undelete" method of the CmsObject.
TestUndoChanges	Unit test for the "undoChanges" method of the CmsObject.
TestUser	Unit tests for OpenCms user object.

Enum Summary

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

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.

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

See Also:

CmsObject, CmsRequestContext, CmsUser, CmsResource, I_CmsResourceType