| Package | Description |
|---|---|
| org.opencms.db |
Low-level database connection and access functionality.
|
| org.opencms.db.generic |
Generic (ANSI-SQL) implementation of the OpenCms database connector.
|
| org.opencms.file |
This important package provides the methods to access the OpenCms VFS repository with the permissions
of an authenticated user.
|
| org.opencms.importexport |
Contains functions to import and export resources from the OpenCms VFS.
|
| org.opencms.letsencrypt |
Classes related to the LetsEncrypt docker integration.
|
| org.opencms.module |
OpenCms modules provide a powerful, standardized way to extend
the core OpenCms functionality.
|
| org.opencms.notification |
Contains classes for the automatical notification of outdated, expiring or released content.
|
| org.opencms.publish |
Classes to handle the OpenCms publish process.
|
| org.opencms.relations |
Classes to represent and validate the internal and external links/relations of resources in the OpenCms VFS.
|
| org.opencms.report |
Classes used to generate the OpenCms reports, which are displayed during publish, import, export etc.
|
| org.opencms.search |
Implements the main full text search and indexing functions available in OpenCms.
|
| org.opencms.search.solr |
The package contains the Solr search integration.
|
| org.opencms.staticexport |
Contains the functionality for the static HTML page export.
|
| org.opencms.synchronize |
Classes used to synchronize the OpenCms VFS with the real file system.
|
| org.opencms.ui.apps.dbmanager.sqlconsole | |
| org.opencms.ui.apps.search |
Contains classes of the source search app.
|
| org.opencms.util |
Utility functions for String manipulation and other often used tasks.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsDriverManager.deleteHistoricalVersions(CmsDbContext dbc,
int versionsToKeep,
int versionsDeleted,
long timeDeleted,
I_CmsReport report)
Deletes the versions from the history tables, keeping the given number of versions per resource.
|
void |
CmsSecurityManager.deleteHistoricalVersions(CmsRequestContext context,
int versionsToKeep,
int versionsDeleted,
long timeDeleted,
I_CmsReport report)
Deletes the versions from the history tables, keeping the given number of versions per resource.
|
void |
I_CmsProjectDriver.publishDeletedFolder(CmsDbContext dbc,
I_CmsReport report,
int m,
int n,
CmsProject onlineProject,
CmsFolder offlineFolder,
CmsUUID publishHistoryId,
int publishTag)
Publishes a deleted folder.
|
void |
I_CmsProjectDriver.publishFile(CmsDbContext dbc,
I_CmsReport report,
int m,
int n,
CmsProject onlineProject,
CmsResource offlineResource,
java.util.Set<CmsUUID> publishedContentIds,
CmsUUID publishHistoryId,
int publishTag)
Publishes a new, changed or deleted file.
|
void |
I_CmsProjectDriver.publishFolder(CmsDbContext dbc,
I_CmsReport report,
int m,
int n,
CmsProject onlineProject,
CmsFolder currentFolder,
CmsUUID publishHistoryId,
int publishTag)
Publishes a new or changed folder.
|
void |
CmsDriverManager.publishJob(CmsObject cms,
CmsDbContext dbc,
CmsPublishList publishList,
I_CmsReport report)
Publishes the given publish job.
|
void |
I_CmsProjectDriver.publishProject(CmsDbContext dbc,
I_CmsReport report,
CmsProject onlineProject,
CmsPublishList publishList,
int publishTag)
Publishes a specified project to the online project.
|
void |
CmsDriverManager.publishProject(CmsObject cms,
CmsDbContext dbc,
CmsPublishList publishList,
I_CmsReport report)
Publishes the resources of a specified publish list.
|
CmsUUID |
CmsSecurityManager.publishProject(CmsObject cms,
CmsPublishList publishList,
I_CmsReport report)
Publishes the resources of a specified publish list.
|
void |
CmsDbContext.report(I_CmsReport report,
CmsMessageContainer message,
java.lang.Throwable throwable)
Reports an error to the given report (if available) and to the OpenCms log file.
|
java.util.Map<java.lang.String,java.util.List<CmsRelation>> |
CmsDriverManager.validateRelations(CmsDbContext dbc,
CmsPublishList publishList,
I_CmsReport report)
Validates the relations for the given resources.
|
java.util.Map<java.lang.String,java.util.List<CmsRelation>> |
CmsSecurityManager.validateRelations(CmsRequestContext context,
CmsPublishList publishList,
I_CmsReport report)
Validates the relations for the given resources.
|
void |
CmsDriverManager.writeExportPoints(CmsDbContext dbc,
I_CmsReport report,
CmsUUID publishHistoryId)
Writes all export points into the file system for the publish task
specified by trhe given publish history ID.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsProjectDriver.publishDeletedFolder(CmsDbContext dbc,
I_CmsReport report,
int m,
int n,
CmsProject onlineProject,
CmsFolder currentFolder,
CmsUUID publishHistoryId,
int publishTag) |
void |
CmsProjectDriver.publishFile(CmsDbContext dbc,
I_CmsReport report,
int m,
int n,
CmsProject onlineProject,
CmsResource offlineResource,
java.util.Set<CmsUUID> publishedContentIds,
CmsUUID publishHistoryId,
int publishTag) |
void |
CmsProjectDriver.publishFolder(CmsDbContext dbc,
I_CmsReport report,
int m,
int n,
CmsProject onlineProject,
CmsFolder offlineFolder,
CmsUUID publishHistoryId,
int publishTag) |
void |
CmsProjectDriver.publishProject(CmsDbContext dbc,
I_CmsReport report,
CmsProject onlineProject,
CmsPublishList publishList,
int publishTag) |
| Modifier and Type | Method and Description |
|---|---|
void |
CmsObject.deleteHistoricalVersions(int versionsToKeep,
int versionsDeleted,
long timeDeleted,
I_CmsReport report)
Deletes the versions from the history tables, keeping the given number of versions per resource.
|
| Modifier and Type | Field and Description |
|---|---|
protected I_CmsReport |
A_CmsImport.m_report
Deprecated.
The object to report the log messages.
|
protected I_CmsReport |
CmsImportVersion10.m_report
The report.
|
protected I_CmsReport |
CmsImport.m_report
The output report.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsReport |
CmsImportVersion7.getReport()
Deprecated.
Returns the report.
|
protected I_CmsReport |
CmsExport.getReport()
Returns the report to write progress messages to.
|
I_CmsReport |
CmsImportVersion10.getReport()
Returns the report.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsImportExportManager.exportData(CmsObject cms,
I_CmsImportExportHandler handler,
I_CmsReport report)
Checks if the current user has permissions to export Cms data of a specified export handler,
and if so, triggers the handler to write the export.
|
void |
I_CmsImportExportHandler.exportData(CmsObject cms,
I_CmsReport report)
Exports the data from the Cms.
|
void |
CmsVfsImportExportHandler.exportData(CmsObject cms,
I_CmsReport report) |
void |
I_CmsImportExportHandler.importData(CmsObject cms,
I_CmsReport report)
Imports the data into the Cms.
|
void |
CmsVfsImportExportHandler.importData(CmsObject cms,
I_CmsReport report) |
void |
CmsImportVersion2.importData(CmsObject cms,
I_CmsReport report,
CmsImportParameters params)
Deprecated.
|
void |
CmsImportExportManager.importData(CmsObject cms,
I_CmsReport report,
CmsImportParameters parameters)
Checks if the current user has permissions to import data into the Cms,
and if so, creates a new import handler instance that imports the data.
|
void |
CmsImportVersion4.importData(CmsObject cms,
I_CmsReport report,
CmsImportParameters params)
Deprecated.
|
void |
CmsImportResourceDataReader.importData(CmsObject cms,
I_CmsReport report,
CmsImportParameters parameters) |
void |
CmsImportVersion7.importData(CmsObject cms,
I_CmsReport report,
CmsImportParameters parameters)
Deprecated.
|
void |
I_CmsImport.importData(CmsObject cms,
I_CmsReport report,
CmsImportParameters parameters)
Imports the data.
|
void |
CmsImportVersion5.importData(CmsObject cms,
I_CmsReport report,
CmsImportParameters params)
Deprecated.
|
void |
CmsImportVersion10.importData(CmsObject cms,
I_CmsReport report,
CmsImportParameters parameters) |
void |
CmsImportVersion3.importData(CmsObject cms,
I_CmsReport report,
CmsImportParameters params)
Deprecated.
|
void |
CmsImportExportManager.importData(CmsObject cms,
java.lang.String importFile,
java.lang.String importPath,
I_CmsReport report)
Deprecated.
|
void |
I_CmsImportExportHandler.importData(CmsObject cms,
java.lang.String importFile,
java.lang.String importPath,
I_CmsReport report)
Deprecated.
|
void |
CmsVfsImportExportHandler.importData(CmsObject cms,
java.lang.String importFile,
java.lang.String importPath,
I_CmsReport report)
Deprecated.
|
void |
CmsImportVersion2.importResources(CmsObject cms,
java.lang.String importPath,
I_CmsReport report,
java.io.File importResource,
java.util.zip.ZipFile importZip,
org.dom4j.Document docXml)
Deprecated.
|
void |
CmsImportVersion4.importResources(CmsObject cms,
java.lang.String importPath,
I_CmsReport report,
java.io.File importResource,
java.util.zip.ZipFile importZip,
org.dom4j.Document docXml)
Deprecated.
|
void |
CmsImportVersion7.importResources(CmsObject cms,
java.lang.String importPath,
I_CmsReport report,
java.io.File importResource,
java.util.zip.ZipFile importZip,
org.dom4j.Document docXml)
Deprecated.
|
void |
I_CmsImport.importResources(CmsObject cms,
java.lang.String importPath,
I_CmsReport report,
java.io.File importResource,
java.util.zip.ZipFile importZip,
org.dom4j.Document docXml)
Deprecated.
|
void |
CmsImportVersion5.importResources(CmsObject cms,
java.lang.String importPath,
I_CmsReport report,
java.io.File importResource,
java.util.zip.ZipFile importZip,
org.dom4j.Document docXml)
Deprecated.
|
void |
CmsImportVersion10.importResources(CmsObject cms,
java.lang.String importPath,
I_CmsReport report,
java.io.File importResource,
java.util.zip.ZipFile importZip,
org.dom4j.Document docXml)
Deprecated.
|
void |
CmsImportVersion3.importResources(CmsObject cms,
java.lang.String importPath,
I_CmsReport report,
java.io.File importResource,
java.util.zip.ZipFile importZip,
org.dom4j.Document docXml)
Deprecated.
|
static void |
CmsImportVersion10.parseLinks(CmsObject cms,
java.util.List<CmsResource> parseables,
I_CmsReport report)
Parses the links.
|
| Constructor and Description |
|---|
CmsExport(CmsObject cms,
I_CmsReport report)
Constructs a new export.
|
CmsImport(CmsObject cms,
I_CmsReport report)
Constructs a new import object which imports the resources from an OpenCms
export zip file or a folder in the "real" file system.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
CmsSiteConfigToLetsEncryptConfigConverter.run(I_CmsReport report,
CmsSiteManagerImpl siteManager)
Runs the certificate configuration update for the sites configured in a site manager.
|
| Modifier and Type | Method and Description |
|---|---|
static java.util.Optional<CmsModuleUpdater> |
CmsModuleUpdater.create(CmsObject cms,
java.lang.String importFile,
I_CmsReport report)
Tries to create a new updater instance.
|
void |
CmsModuleManager.deleteModule(CmsObject cms,
java.lang.String moduleName,
boolean replace,
boolean preserveLibs,
I_CmsReport report)
Deletes a module from the configuration.
|
void |
CmsModuleManager.deleteModule(CmsObject cms,
java.lang.String moduleName,
boolean replace,
I_CmsReport report)
Deletes a module from the configuration.
|
void |
CmsModuleImportExportHandler.exportData(CmsObject cms,
I_CmsReport report) |
void |
CmsModuleImportExportHandler.importData(CmsObject cms,
I_CmsReport report) |
void |
CmsModuleImportExportHandler.importData(CmsObject cms,
java.lang.String importFile,
java.lang.String importPath,
I_CmsReport report)
Deprecated.
|
void |
A_CmsModuleAction.publishProject(CmsObject cms,
CmsPublishList publishList,
int publishTag,
I_CmsReport report) |
void |
I_CmsModuleAction.publishProject(CmsObject cms,
CmsPublishList publishList,
int publishTag,
I_CmsReport report)
Will be called during a the publish process after the resources have been published,
but before the publish event is fired.
|
static CmsModuleImportData |
CmsModuleUpdater.readModuleData(CmsObject cms,
java.lang.String importFile,
I_CmsReport report)
Reads the module data from an import zip file.
|
CmsReplaceModuleInfo |
CmsModuleManager.replaceModule(CmsObject cms,
java.lang.String importFile,
I_CmsReport report)
Replaces an existing module with the one read from an import ZIP file.
|
static void |
CmsModuleImportExportHandler.reportBeginImport(I_CmsReport report,
java.lang.String modulePackageName)
Writes the messages for starting an import to the given report.
|
static void |
CmsModuleImportExportHandler.reportEndImport(I_CmsReport report)
Writes the messages for finishing an import to the given report.
|
| Constructor and Description |
|---|
CmsModuleUpdater(CmsModuleImportData moduleData,
I_CmsReport report)
Creates a new instance.
|
| Constructor and Description |
|---|
CmsPublishNotification(CmsObject cms,
CmsUser receiver,
I_CmsReport report)
Creates a new CmsPublishNotification.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsPublishReport
Report class used for the publish operations.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsReport |
CmsPublishJobInfoBean.getPublishReport()
Returns the report for this publish job.
|
I_CmsReport |
CmsPublishJobInfoBean.getReport()
Returns the report for this publish job.
|
I_CmsReport |
CmsPublishJobEnqueued.getReport()
Returns the report for this publish job.
|
I_CmsReport |
CmsPublishJobRunning.getReport()
Returns the report for this publish job.
|
I_CmsReport |
CmsPublishJobInfoBean.removePublishReport()
Removes the assigned publish report.
|
| Modifier and Type | Method and Description |
|---|---|
protected static CmsPrintStreamReport |
CmsPublishReport.decorate(I_CmsReport report)
Returns a publish report instance that writes to the given report as well as
to the given temporary file.
|
void |
CmsPublishEngine.enqueuePublishJob(CmsObject cms,
CmsPublishList publishList,
I_CmsReport report)
Enqueues a new publish job with the given information in publish queue.
|
CmsUUID |
CmsPublishManager.publishProject(CmsObject cms,
I_CmsReport report)
Publishes the current project.
|
CmsUUID |
CmsPublishManager.publishProject(CmsObject cms,
I_CmsReport report,
CmsPublishList publishList)
Publishes the resources of a specified publish list.
|
CmsUUID |
CmsPublishManager.publishProject(CmsObject cms,
I_CmsReport report,
CmsResource directPublishResource,
boolean directPublishSiblings)
Direct publishes a specified resource.
|
CmsUUID |
CmsPublishManager.publishResource(CmsObject cms,
java.lang.String resourcename,
boolean publishSiblings,
I_CmsReport report)
Publishes a single resource.
|
java.util.Map<java.lang.String,java.util.List<CmsRelation>> |
CmsPublishManager.validateRelations(CmsObject cms,
CmsPublishList publishList,
I_CmsReport report)
Validates the relations for the given resources.
|
| Constructor and Description |
|---|
CmsPublishJobInfoBean(CmsObject cms,
CmsPublishList publishList,
I_CmsReport report)
The Default constructor.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsExternalLinksValidator.setReport(I_CmsReport report)
Sets the report for the output.
|
protected java.util.List<CmsRelation> |
CmsRelationSystemValidator.validateLinks(CmsDbContext dbc,
CmsResource resource,
java.util.Map<java.lang.String,CmsResource> fileLookup,
CmsProject project,
I_CmsReport report)
Validates the links for the specified resource.
|
java.util.Map<java.lang.String,java.util.List<CmsRelation>> |
CmsRelationSystemValidator.validateResources(CmsDbContext dbc,
CmsPublishList publishList,
I_CmsReport report)
Validates the relations against the online project.
|
| Modifier and Type | Class and Description |
|---|---|
class |
A_CmsReport
Base report class.
|
class |
CmsHtmlReport
HTML report output to be used for import / export / publish operations
in the entire OpenCms system.
|
class |
CmsLogReport
Report class used for the logfile.
|
class |
CmsPrintStreamReport
Stream report where the output is streamed to the given print stream instance.
|
class |
CmsShellLogReport
Report for shell which writes to LOG.
|
class |
CmsShellReport
Report class used for the shell.
|
class |
CmsStringBufferReport
Report class used to write the output of a report to a StringBuffer.
|
class |
CmsWorkplaceReport
Report class for displaying reports to the user in the workplace.
|
| Modifier and Type | Field and Description |
|---|---|
protected I_CmsReport |
A_CmsReportThread.m_report
The report that belongs to the thread.
|
| Modifier and Type | Method and Description |
|---|---|
protected I_CmsReport |
A_CmsReportThread.getReport()
Returns the report where the output of this Thread is written to.
|
| Modifier and Type | Field and Description |
|---|---|
protected I_CmsReport |
CmsVfsIndexer.m_report
The report.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsReport |
CmsVfsIndexer.getReport()
Returns the report used by this indexer.
|
| Modifier and Type | Method and Description |
|---|---|
protected I_CmsSearchDocument |
CmsIndexingThread.createIndexDocument(CmsObject cms,
CmsResource res,
I_CmsSearchIndex index,
int count,
I_CmsReport report)
Creates the search index document.
|
protected I_CmsIndexWriter |
CmsSearchIndex.createIndexWriter(boolean create,
I_CmsReport report)
Creates a new index writer.
|
protected abstract I_CmsIndexWriter |
A_CmsSearchIndex.createIndexWriter(boolean create,
I_CmsReport report)
Creates a new index writer.
|
I_CmsIndexWriter |
I_CmsSearchIndex.getIndexWriter(I_CmsReport report,
boolean create)
Returns a new index writer for this index.
|
I_CmsIndexWriter |
A_CmsSearchIndex.getIndexWriter(I_CmsReport report,
boolean create)
Returns a new index writer for this index.
|
I_CmsIndexer |
CmsVfsIndexer.newInstance(CmsObject cms,
I_CmsReport report,
I_CmsSearchIndex index) |
I_CmsIndexer |
I_CmsIndexer.newInstance(CmsObject cms,
I_CmsReport report,
I_CmsSearchIndex index)
Creates and initializes a new instance of this indexer implementation.
|
void |
CmsSearchManager.rebuildAllIndexes(I_CmsReport report)
Rebuilds (if required creates) all configured indexes.
|
void |
CmsSearchManager.rebuildIndex(java.lang.String indexName,
I_CmsReport report)
Rebuilds (if required creates) the index with the given name.
|
void |
CmsSearchManager.rebuildIndexes(java.util.List<java.lang.String> indexNames,
I_CmsReport report)
Rebuilds (if required creates) the List of indexes with the given name.
|
void |
CmsIndexingThreadManager.reportStatistics(I_CmsReport report)
Writes statistical information to the report.
|
protected void |
CmsSearchManager.CmsSearchOfflineIndexThread.startOfflineUpdateThread(I_CmsReport report,
java.util.List<CmsPublishedResource> resourcesToIndex)
Updates the offline search indexes for the given list of resources.
|
protected void |
CmsSearchManager.updateAllIndexes(CmsObject adminCms,
CmsUUID publishHistoryId,
I_CmsReport report)
Incrementally updates all indexes that have their rebuild mode set to
"auto"
after resources have been published. |
protected void |
CmsSearchManager.updateIndex(I_CmsSearchIndex index,
I_CmsReport report,
java.util.List<CmsPublishedResource> resourcesToIndex)
Updates (if required creates) the index with the given name.
|
protected void |
CmsSearchManager.updateIndexCompletely(CmsObject cms,
I_CmsSearchIndex index,
I_CmsReport report)
The method updates all OpenCms documents that are indexed.
|
protected void |
CmsSearchManager.updateIndexIncremental(CmsObject cms,
I_CmsSearchIndex index,
I_CmsReport report,
java.util.List<CmsPublishedResource> resourcesToIndex)
Incrementally updates the given index.
|
protected void |
CmsSearchManager.updateIndexOffline(I_CmsReport report,
java.util.List<CmsPublishedResource> resourcesToIndex)
Updates the offline search indexes for the given list of resources.
|
| Constructor and Description |
|---|
CmsIndexingThread(CmsObject cms,
CmsResource res,
I_CmsSearchIndex index,
int count,
I_CmsReport report)
Create a new indexing thread.
|
CmsSearchOfflineIndexWorkThread(I_CmsReport report,
java.util.List<CmsPublishedResource> resourcesToIndex)
Updates the offline search indexes for the given list of resources.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsIndexWriter |
CmsSolrIndex.createIndexWriter(boolean create,
I_CmsReport report) |
| Modifier and Type | Method and Description |
|---|---|
void |
CmsAfterPublishStaticExportHandler.doExportAfterPublish(java.util.List<CmsPublishedResource> resources,
I_CmsReport report)
Does the actual static export.
|
protected void |
CmsAfterPublishStaticExportHandler.exportAfterPublish(CmsUUID publishHistoryId,
I_CmsReport report)
Starts the static export on publish.
|
void |
CmsStaticExportManager.exportFullStaticRender(boolean purgeFirst,
I_CmsReport report)
Starts a complete static export of all resources.
|
protected boolean |
CmsAfterPublishStaticExportHandler.exportNonTemplateResources(CmsObject cms,
java.util.List<CmsPublishedResource> publishedResources,
I_CmsReport report)
Exports all non template resources found in a list of published resources.
|
protected void |
CmsAfterPublishStaticExportHandler.exportTemplateResources(CmsObject cms,
java.util.List<java.lang.String> publishedTemplateResources,
I_CmsReport report)
Exports all template resources found in a list of published resources.
|
void |
I_CmsStaticExportHandler.performEventPublishProject(CmsUUID publishHistoryId,
I_CmsReport report)
Scrubs files from the export folder that might have been changed.
|
void |
CmsAfterPublishStaticExportHandler.performEventPublishProject(CmsUUID publishHistoryId,
I_CmsReport report) |
abstract void |
A_CmsStaticExportHandler.performEventPublishProject(CmsUUID publishHistoryId,
I_CmsReport report) |
void |
A_CmsOnDemandStaticExportHandler.performEventPublishProject(CmsUUID publishHistoryId,
I_CmsReport report) |
protected void |
CmsStaticExportManager.scrubExportFolders(I_CmsReport report)
Scrubs all the "export" folders.
|
| Constructor and Description |
|---|
CmsSynchronize(CmsObject cms,
CmsSynchronizeSettings settings,
I_CmsReport report)
Creates a new CmsSynchronize object which automatically start the
synchronization process.
|
| Modifier and Type | Method and Description |
|---|---|
CmsSqlConsoleResults |
CmsSqlConsoleExecutor.execute(java.lang.String sql,
java.lang.String pool,
I_CmsReport report,
java.util.List<java.lang.Throwable> errors)
Main method of this class.
|
| Constructor and Description |
|---|
CmsSearchReplaceThread(javax.servlet.http.HttpSession session,
CmsObject cms,
CmsSearchReplaceSettings settings,
I_CmsReport report)
Creates a replace html tag Thread.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
CmsMacroResolver.copyAndResolveMacro(CmsObject cms,
java.lang.String source,
java.lang.String destination,
java.util.Map<java.lang.String,java.lang.String> keyValue,
boolean adjustLinks,
CmsResource.CmsResourceCopyMode copyMode,
I_CmsReport report)
Copies resources, adjust internal links (if adjustLinks==true) and resolves macros (if keyValue map is set).
|