Package org.opencms.db
Low-level database connection and access functionality.
You should usually not access the OpenCms database directly.
To access the OpenCms VFS repository, obtain a
which will encapsulate the current users permissions.CmsObject
- Since:
- 6.0.0
-
Interface Summary Interface Description 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_CmsExportPointDriver Provides methods to write export points to the "real" file system.I_CmsHistoryDriver Definitions of all required history driver methods.I_CmsPreparedStatementParameter An interface which represents a parameter value which is going to be used in an SQL prepared statement.I_CmsProjectDriver Definitions of all required project driver methods.I_CmsQueryFragment An interface for classes which are used to generate SQL statements.I_CmsSubscriptionDriver The interface for drivers handling subscriptions and user tracking.I_CmsUserDriver Definitions of all required user driver methods.I_CmsVfsDriver Definitions of all required VFS driver methods. -
Class Summary Class Description CmsAlias This class represents an alias from a virtual path to a resource in the VFS.CmsAliasFilter This class is used for filtering aliases in database operations.CmsAliasManager The alias manager provides access to the aliases stored in the database.CmsCacheKey Generates the cache keys for the user and permission caches.CmsCacheSettings The settings of the OpenCms memory monitor.CmsCompositeQueryFragment A query fragment which aggregates the results from a list of other query fragments.CmsDbContext Wraps context information to access the OpenCms database.CmsDbContextFactory A default implementation ofI_CmsDbContextFactory
.CmsDbPool Deprecated. CmsDbPoolV11 Database connection pool class using HikariCP.CmsDbUtil Generic database utility functions.CmsDefaultUsers Provides access to the names of the OpenCms default users and groups.CmsDriverManager The OpenCms driver manager.CmsDriverManager.ResourceListWithCacheability Resource list which additionally knows whether it should be cacheable in the resource list cache or not.CmsDriverManager.ResourceOUCacheKey Special key class for caching the resource OU data with a Guava LoadingCache.CmsDriverManager.ResourceOUMap Helper class used to store information about resources assigned to OUs in a cache.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.CmsPagingQuery Wrapper forCmsSelectQuery
objects which adds SQL code for results paging.CmsPreparedStatementIntParameter A prepared statement parameter of type 'int'.CmsPreparedStatementLongParameter A prepared statement of type 'long'.CmsPreparedStatementStringParameter A prepared statement parameter of type 'string'.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.CmsRewriteAlias This class represents an alias which does not just map a fixed path to a fixed resource, but instead uses a regular expression substitution to determine the target path.CmsRewriteAliasFilter Filter class used for selecting rewrite aliases from the database.CmsRewriteAliasMatcher Helper class used for matching rewrite aliases to incoming request URIs.CmsRewriteAliasMatcher.RewriteResult The result of a match operation.CmsSecurityManager The OpenCms security manager.CmsSelectQuery A class for generating SQL SELECT statements.CmsSimpleQueryFragment A simple query fragment which takes its SQL string and query parameters as constructor arguments.CmsSqlBooleanClause Class for generating an SQL boolean expression.CmsSqlManager Superclass for all SQL manager implementations.CmsStatementBuilder A helper class used to accumulate SQL fragments together with the corresponding query parameters.CmsSubscriptionFilter Provides filters for getting resources subscribed by a user or group in a specified time range.CmsSubscriptionManager Manager that provides methods to subscribe resources to users, read subscribed or unvisited resources and more.CmsSubscriptionReadMode The read modes to get subscribed resources of a user or group.CmsTempFolderExportPointDriver An alternative export point driver which replaces the RFS targets of some export points with locations in a temporary export folder.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.CmsUserTrackingResourceHandler This resource handler checks if a resource has to be marked as visited by the current user.CmsVisitedByFilter Provides filters for getting resources visited by a user in a specified time range.CmsVisitEntry A bean which represents a user having visited a page.CmsVisitEntryFilter A filter which contains criteria for readingCmsVisitEntry
instances from the database.Messages Convenience class to access the localized messages of this OpenCms package. -
Enum Summary Enum Description CmsDriverManager.LoginUserMode Enum for distinguishing between login modes.CmsUserSettings.UploadVariant A enum for the different upload variants. -
Exception Summary Exception Description 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.