Uses of Interface
org.opencms.report.I_CmsReport
Package
Description
Low-level database connection and access functionality.
Generic (ANSI-SQL) implementation of the OpenCms database connector.
This important package provides the methods to access the OpenCms VFS repository with the permissions
of an authenticated user.
The implementations of the core resource types for the VFS are located here.
Contains functions to import and export resources from the OpenCms VFS.
Classes related to the LetsEncrypt docker integration.
OpenCms modules provide a powerful, standardized way to extend
the core OpenCms functionality.
Contains classes for the automatical notification of outdated, expiring or released content.
Classes to handle the OpenCms publish process.
Classes to represent and validate the internal and external links/relations of resources in the OpenCms VFS.
Classes used to generate the OpenCms reports, which are displayed during publish, import, export etc.
Implements the main full text search and indexing functions available in OpenCms.
The package contains the Solr search integration.
Contains the functionality for the static HTML page export.
Classes used to synchronize the OpenCms VFS with the real file system.
Contains classes of the source search app.
Utility functions for String manipulation and other often used tasks.
Basic XML functionality and utilities used by OpenCms to maintain XML documents and content.
-
Uses of I_CmsReport in org.opencms.db
Modifier and TypeMethodDescriptionvoid
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, 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
CmsDriverManager.publishProject
(CmsObject cms, CmsDbContext dbc, CmsPublishList publishList, I_CmsReport report) Publishes the resources of a specified publish list.CmsSecurityManager.publishProject
(CmsObject cms, CmsPublishList publishList, I_CmsReport report) Publishes the resources of a specified publish list.void
I_CmsProjectDriver.publishProject
(CmsDbContext dbc, I_CmsReport report, CmsProject onlineProject, CmsPublishList publishList, int publishTag) Publishes a specified project to the online project.void
CmsDbContext.report
(I_CmsReport report, CmsMessageContainer message, Throwable throwable) Reports an error to the given report (if available) and to the OpenCms log file.CmsDriverManager.validateRelations
(CmsDbContext dbc, CmsPublishList publishList, I_CmsReport report) Validates the relations for the given resources.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. -
Uses of I_CmsReport in org.opencms.db.generic
Modifier and TypeMethodDescriptionvoid
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, 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) -
Uses of I_CmsReport in org.opencms.file
Modifier and TypeMethodDescriptionvoid
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.CmsObject.importResource
(String resourcename, I_CmsReport report, CmsResource resource, byte[] content, List<CmsProperty> properties) Imports a resource to the OpenCms VFS. -
Uses of I_CmsReport in org.opencms.file.types
Modifier and TypeMethodDescriptionA_CmsResourceType.importResource
(CmsObject cms, CmsSecurityManager securityManager, I_CmsReport report, String resourcename, CmsResource resource, byte[] content, List<CmsProperty> properties) CmsResourceTypeImage.importResource
(CmsObject cms, CmsSecurityManager securityManager, I_CmsReport report, String resourcename, CmsResource resource, byte[] content, List<CmsProperty> properties) I_CmsResourceType.importResource
(CmsObject cms, CmsSecurityManager securityManager, I_CmsReport report, String resourcename, CmsResource resource, byte[] content, List<CmsProperty> properties) Imports a resource to the OpenCms VFS. -
Uses of I_CmsReport in org.opencms.importexport
Modifier and TypeFieldDescriptionprotected I_CmsReport
A_CmsImport.m_report
Deprecated.The object to report the log messages.protected I_CmsReport
CmsImport.m_report
The output report.protected I_CmsReport
CmsImportVersion10.m_report
The report.Modifier and TypeMethodDescriptionprotected I_CmsReport
CmsExport.getReport()
Returns the report to write progress messages to.CmsImportVersion10.getReport()
Returns the report.CmsImportVersion7.getReport()
Deprecated.Returns the report.Modifier and TypeMethodDescriptionvoid
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
CmsVfsImportExportHandler.exportData
(CmsObject cms, I_CmsReport report) void
I_CmsImportExportHandler.exportData
(CmsObject cms, I_CmsReport report) Exports the data from the Cms.void
CmsImportExportManager.importData
(CmsObject cms, String importFile, String importPath, I_CmsReport report) 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
CmsImportResourceDataReader.importData
(CmsObject cms, I_CmsReport report, CmsImportParameters parameters) void
CmsImportVersion10.importData
(CmsObject cms, I_CmsReport report, CmsImportParameters parameters) void
CmsImportVersion2.importData
(CmsObject cms, I_CmsReport report, CmsImportParameters params) Deprecated.void
CmsImportVersion3.importData
(CmsObject cms, I_CmsReport report, CmsImportParameters params) Deprecated.void
CmsImportVersion4.importData
(CmsObject cms, I_CmsReport report, CmsImportParameters params) Deprecated.void
CmsImportVersion5.importData
(CmsObject cms, I_CmsReport report, CmsImportParameters params) Deprecated.void
CmsImportVersion7.importData
(CmsObject cms, I_CmsReport report, CmsImportParameters parameters) Deprecated.void
CmsVfsImportExportHandler.importData
(CmsObject cms, String importFile, String importPath, I_CmsReport report) Deprecated.void
CmsVfsImportExportHandler.importData
(CmsObject cms, I_CmsReport report) void
I_CmsImport.importData
(CmsObject cms, I_CmsReport report, CmsImportParameters parameters) Imports the data.void
I_CmsImportExportHandler.importData
(CmsObject cms, String importFile, String importPath, I_CmsReport report) Deprecated.void
I_CmsImportExportHandler.importData
(CmsObject cms, I_CmsReport report) Imports the data into the Cms.void
CmsImportVersion10.importResources
(CmsObject cms, String importPath, I_CmsReport report, File importResource, ZipFile importZip, org.dom4j.Document docXml) Deprecated.void
CmsImportVersion2.importResources
(CmsObject cms, String importPath, I_CmsReport report, File importResource, ZipFile importZip, org.dom4j.Document docXml) Deprecated.void
CmsImportVersion3.importResources
(CmsObject cms, String importPath, I_CmsReport report, File importResource, ZipFile importZip, org.dom4j.Document docXml) Deprecated.void
CmsImportVersion4.importResources
(CmsObject cms, String importPath, I_CmsReport report, File importResource, ZipFile importZip, org.dom4j.Document docXml) Deprecated.void
CmsImportVersion5.importResources
(CmsObject cms, String importPath, I_CmsReport report, File importResource, ZipFile importZip, org.dom4j.Document docXml) Deprecated.void
CmsImportVersion7.importResources
(CmsObject cms, String importPath, I_CmsReport report, File importResource, ZipFile importZip, org.dom4j.Document docXml) Deprecated.void
I_CmsImport.importResources
(CmsObject cms, String importPath, I_CmsReport report, File importResource, ZipFile importZip, org.dom4j.Document docXml) Deprecated.static void
CmsImportVersion10.parseLinks
(CmsObject cms, List<CmsResource> parseables, I_CmsReport report) Parses the links.ModifierConstructorDescriptionCmsExport
(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. -
Uses of I_CmsReport in org.opencms.jsp.userdata
Modifier and TypeMethodDescriptionboolean
CmsUserDataRequestManager.getInfoForEmail
(CmsObject cms, I_CmsUserDataDomain.Mode mode, String email, List<String> searchStrings, org.jsoup.nodes.Element root, I_CmsReport report) Gets the user data for an email address.boolean
CmsUserDataRequestManager.getInfoForUser
(CmsObject cms, I_CmsUserDataDomain.Mode mode, CmsUser user, org.jsoup.nodes.Element root, I_CmsReport report) Gets the user data for a specific OpenCms user. -
Uses of I_CmsReport in org.opencms.letsencrypt
Modifier and TypeMethodDescriptionboolean
CmsSiteConfigToLetsEncryptConfigConverter.run
(I_CmsReport report, CmsSiteManagerImpl siteManager) Runs the certificate configuration update for the sites configured in a site manager. -
Uses of I_CmsReport in org.opencms.module
Modifier and TypeMethodDescriptionstatic Optional<CmsModuleUpdater>
CmsModuleUpdater.create
(CmsObject cms, String importFile, I_CmsReport report) Tries to create a new updater instance.void
CmsModuleManager.deleteModule
(CmsObject cms, String moduleName, boolean replace, boolean preserveLibs, I_CmsReport report) Deletes a module from the configuration.void
CmsModuleManager.deleteModule
(CmsObject cms, 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, String importFile, String importPath, I_CmsReport report) Deprecated.void
CmsModuleImportExportHandler.importData
(CmsObject cms, I_CmsReport report) 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, String importFile, I_CmsReport report) Reads the module data from an import zip file.CmsModuleManager.replaceModule
(CmsObject cms, 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, 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.ModifierConstructorDescriptionCmsModuleUpdater
(CmsModuleImportData moduleData, I_CmsReport report) Creates a new instance. -
Uses of I_CmsReport in org.opencms.notification
ModifierConstructorDescriptionCmsPublishNotification
(CmsObject cms, CmsUser receiver, I_CmsReport report) Creates a new CmsPublishNotification. -
Uses of I_CmsReport in org.opencms.publish
Modifier and TypeClassDescriptionclass
Report class used for the publish operations.Modifier and TypeMethodDescriptionCmsPublishJobInfoBean.getPublishReport()
Returns the report for this publish job.CmsPublishJobEnqueued.getReport()
Returns the report for this publish job.CmsPublishJobInfoBean.getReport()
Returns the report for this publish job.CmsPublishJobRunning.getReport()
Returns the report for this publish job.CmsPublishJobInfoBean.removePublishReport()
Removes the assigned publish report.Modifier and TypeMethodDescriptionprotected 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.CmsPublishManager.publishProject
(CmsObject cms, I_CmsReport report) Publishes the current project.CmsPublishManager.publishProject
(CmsObject cms, I_CmsReport report, CmsPublishList publishList) Publishes the resources of a specified publish list.CmsPublishManager.publishProject
(CmsObject cms, I_CmsReport report, CmsResource directPublishResource, boolean directPublishSiblings) Direct publishes a specified resource.CmsPublishManager.publishResource
(CmsObject cms, String resourcename, boolean publishSiblings, I_CmsReport report) Publishes a single resource.CmsPublishManager.validateRelations
(CmsObject cms, CmsPublishList publishList, I_CmsReport report) Validates the relations for the given resources.ModifierConstructorDescriptionprotected
CmsPublishJobInfoBean
(CmsObject cms, CmsPublishList publishList, I_CmsReport report) The Default constructor. -
Uses of I_CmsReport in org.opencms.relations
Modifier and TypeMethodDescriptionvoid
CmsExternalLinksValidator.setReport
(I_CmsReport report) Sets the report for the output.protected List<CmsRelation>
CmsRelationSystemValidator.validateLinks
(CmsDbContext dbc, CmsResource resource, Map<String, CmsResource> fileLookup, CmsProject project, I_CmsReport report) Validates the links for the specified resource.CmsRelationSystemValidator.validateResources
(CmsDbContext dbc, CmsPublishList publishList, I_CmsReport report) Validates the relations against the online project. -
Uses of I_CmsReport in org.opencms.report
Modifier and TypeClassDescriptionclass
Base report class.class
HTML report output to be used for import / export / publish operations in the entire OpenCms system.class
Report class used for the logfile.class
Report proxy that multiplexes to all contained
instances.I_CmsReport
class
Stream report where the output is streamed to the given print stream instance.class
Report for shell which writes to LOG.class
Report class used for the shell.class
Report class used to write the output of a report to a StringBuffer.class
Report class for displaying reports to the user in the workplace.Modifier and TypeFieldDescriptionprotected I_CmsReport
A_CmsReportThread.m_report
The report that belongs to the thread.Modifier and TypeMethodDescriptionprotected I_CmsReport
A_CmsReportThread.getReport()
Returns the report where the output of this Thread is written to. -
Uses of I_CmsReport in org.opencms.report.wrapper
ModifierConstructorDescriptionCmsReportWrapper
(I_CmsMessageBundle messages, I_CmsReport... report) Constructor for the wrapper.ModifierConstructorDescriptionCmsReportWrapper
(I_CmsMessageBundle messages, Collection<I_CmsReport> reports) Constructor for the wrapper. -
Uses of I_CmsReport in org.opencms.search
Modifier and TypeMethodDescriptionCmsVfsIndexer.getReport()
Returns the report used by this indexer.Modifier and TypeMethodDescriptionprotected I_CmsSearchDocument
CmsIndexingThread.createIndexDocument
(CmsObject cms, CmsResource res, I_CmsSearchIndex index, int count, I_CmsReport report) Creates the search index document.protected abstract I_CmsIndexWriter
A_CmsSearchIndex.createIndexWriter
(boolean create, I_CmsReport report) Creates a new index writer.protected I_CmsIndexWriter
CmsSearchIndex.createIndexWriter
(boolean create, I_CmsReport report) Creates a new index writer.A_CmsSearchIndex.getIndexWriter
(I_CmsReport report, boolean create) Returns a new index writer for this index.I_CmsSearchIndex.getIndexWriter
(I_CmsReport report, boolean create) Returns a new index writer for this index.CmsVfsIndexer.newInstance
(CmsObject cms, I_CmsReport report, I_CmsSearchIndex index) 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
(String indexName, I_CmsReport report) Rebuilds (if required creates) the index with the given name.void
CmsSearchManager.rebuildIndexes
(List<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, List<CmsPublishedResource> resourcesToIndex) Updates the offline search indexes for the given list of resources.protected void
CmsSearchManager.updateAllIndexes
(CmsObject adminCms, List<CmsPublishedResource> updateResources, I_CmsReport report) Incrementally updates all indexes that have their rebuild mode set to"auto"
.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, 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, List<CmsPublishedResource> resourcesToIndex) Incrementally updates the given index.protected void
CmsSearchManager.updateIndexOffline
(I_CmsReport report, List<CmsPublishedResource> resourcesToIndex) Updates the offline search indexes for the given list of resources.ModifierConstructorDescriptionCmsIndexingThread
(CmsObject cms, CmsResource res, I_CmsSearchIndex index, int count, I_CmsReport report) Create a new indexing thread.protected
CmsSearchOfflineIndexWorkThread
(I_CmsReport report, List<CmsPublishedResource> resourcesToIndex) Updates the offline search indexes for the given list of resources. -
Uses of I_CmsReport in org.opencms.search.solr
Modifier and TypeMethodDescriptionCmsSolrIndex.createIndexWriter
(boolean create, I_CmsReport report) -
Uses of I_CmsReport in org.opencms.staticexport
Modifier and TypeMethodDescriptionvoid
CmsAfterPublishStaticExportHandler.doExportAfterPublish
(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, List<CmsPublishedResource> publishedResources, I_CmsReport report) Exports all non template resources found in a list of published resources.protected void
CmsAfterPublishStaticExportHandler.exportTemplateResources
(CmsObject cms, List<String> publishedTemplateResources, I_CmsReport report) Exports all template resources found in a list of published resources.void
A_CmsOnDemandStaticExportHandler.performEventPublishProject
(CmsUUID publishHistoryId, I_CmsReport report) abstract void
A_CmsStaticExportHandler.performEventPublishProject
(CmsUUID publishHistoryId, I_CmsReport report) void
CmsAfterPublishStaticExportHandler.performEventPublishProject
(CmsUUID publishHistoryId, I_CmsReport report) void
I_CmsStaticExportHandler.performEventPublishProject
(CmsUUID publishHistoryId, I_CmsReport report) Scrubs files from the export folder that might have been changed.protected void
CmsStaticExportManager.scrubExportFolders
(I_CmsReport report) Scrubs all the "export" folders. -
Uses of I_CmsReport in org.opencms.synchronize
ModifierConstructorDescriptionCmsSynchronize
(CmsObject cms, CmsSynchronizeSettings settings, I_CmsReport report) Creates a new CmsSynchronize object which automatically start the synchronization process. -
Uses of I_CmsReport in org.opencms.ui.apps.dbmanager.sqlconsole
Modifier and TypeMethodDescriptionMain method of this class. -
Uses of I_CmsReport in org.opencms.ui.apps.search
ModifierConstructorDescriptionCmsSearchReplaceThread
(javax.servlet.http.HttpSession session, CmsObject cms, CmsSearchReplaceSettings settings, I_CmsReport report) Creates a replace html tag Thread. -
Uses of I_CmsReport in org.opencms.ui.apps.userdata
ModifierConstructorDescriptionCmsUserDataReportThread
(CmsObject cms, Consumer<I_CmsReport> action) Creates a new instance. -
Uses of I_CmsReport in org.opencms.util
Modifier and TypeMethodDescriptionstatic void
CmsMacroResolver.copyAndResolveMacro
(CmsObject cms, String source, String destination, Map<String, 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). -
Uses of I_CmsReport in org.opencms.xml
ModifierConstructorDescriptionCmsXmlFileTransformer
(CmsObject cms, String path, String type, String xslName, InputStream xslStream, I_CmsReport report) Creates a new instance.
CmsImportExportManager.importData(CmsObject, I_CmsReport, CmsImportParameters)
instead