Package org.opencms.db

Low-level database connection and access functionality.

See:
Description

Interface Summary

I_CmsBackupDriver	Deprecated. use I_CmsHistoryDriver instead
I_CmsCacheKey	Describes the cache key generating methods.
I_CmsDbContextFactory	This interface defines a factory to create runtime info objects.
I_CmsDriver	Generic base driver interface.
I_CmsHistoryDriver	Definitions of all required history driver methods.
I_CmsProjectDriver	Definitions of all required project driver methods.
I_CmsUserDriver	Definitions of all required user driver methods.
I_CmsVfsDriver	Definitions of all required VFS driver methods.

Class Summary

CmsCacheKey	Generates the cache keys for the user and permission caches.
CmsCacheSettings	The settings of the OpenCms driver manager.
CmsDbContext	Wraps context information to access the OpenCms database.
CmsDbContextFactory	A default implementation of I_CmsDbContextFactory.
CmsDbPool	Various methods to create DBCP pools.
CmsDefaultUsers	Provides access to the names of the OpenCms default users and groups.
CmsDriverManager	The OpenCms driver manager.
CmsExportPoint	Contains the data of a single export point.
CmsExportPointDriver	Provides methods to write export points to the "real" file system.
CmsImportFolder	Allows to import resources from the filesystem or a ZIP file into the OpenCms VFS.
CmsLoginManager	Provides functions used to check the validity of a user login.
CmsLoginMessage	A message to display when a user logs in to the system.
CmsPublishedResource	Represents the state of a published resource *before* it got published.
CmsPublishedResource.CmsPublishedResourceState	Add new resource states under consideration of the move operation.
CmsPublishList	A container for all new/changed/deteled Cms resources that are published together.
CmsResourceState	Enumeration class for the different resource states.
CmsSecurityManager	The OpenCms security manager.
CmsSqlManager	Superclass for all SQL manager implementations.
CmsUserExportSettings	Provides the user export settings.
CmsUserSettings	Object to conveniently access and modify the users workplace settings.
CmsUserSettings.CmsSearchResultStyle	Enumeration class for workplace search result styles.

Exception Summary

CmsDbConsistencyException	Signals that a data source consistency problem has been detected.
CmsDbEntryAlreadyExistsException	Signals that an attempt to create an object was not successfull because it already exists.
CmsDbEntryNotFoundException	Signals that an attempt to read an object from a data source, that is supposed to exist, was not successfull.
CmsDbException	Signals that a low-level exception occurred when accessing the OpenCms database.
CmsDbIoException	Signals that an IO exception occurred when reading from or writing to the OpenCms database.
CmsDbKeyException	Signals that a foreign key in the VFS STRUCTURE, RESOURCES or FILES database tables is either invalid or empty.
CmsDbSqlException	Used to signal sql related issues.
CmsVfsOnlineResourceAlreadyExistsException	Signals that an attempt to create a resource was not successfull since at the given location another online resource with a different structure id has been found.

Package org.opencms.db Description

Low-level database connection and access functionality.

You should usually not access the OpenCms database directly. To access the OpenCms VFS repository, obtain a CmsObject which will encapsulate the current users permissions.

Since:

6.0.0

Version:

$Revision: 1.9 $