类 org.opencms.db.CmsPublishedResource
的使用

使用CmsPublishedResource的程序包

程序包	说明
org.opencms.ade.configuration
org.opencms.ade.configuration.formatters
org.opencms.ade.containerpage.inherited
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.db.jpa
org.opencms.file	This important package provides the methods to access the OpenCms VFS repository with the permissions of an authenticated user.
org.opencms.monitor	Contains functions to monitor the OpenCms system status.
org.opencms.search	Implements the main full text search and indexing functions available in OpenCms.
org.opencms.search.documents	Handles indexing different sorts of document and resource type from the OpenCms VFS for the full text search.
org.opencms.search.solr
org.opencms.staticexport	Contains the functionality for the static HTML page export.

org.opencms.ade.configuration中CmsPublishedResource的使用

参数类型为CmsPublishedResource的org.opencms.ade.configuration中的方法

限定符和类型	方法和说明
protected void	CmsGlobalConfigurationCacheEventHandler.offlineCacheRemove(CmsPublishedResource resource) Removes a resource from the offline caches.
protected void	CmsGlobalConfigurationCacheEventHandler.offlineCacheUpdate(CmsPublishedResource resource) Updates a resource in the offline caches.
protected void	CmsGlobalConfigurationCacheEventHandler.onlineCacheRemove(CmsPublishedResource resource) Removes a resource from the online caches.
protected void	CmsGlobalConfigurationCacheEventHandler.onlineCacheUpdate(CmsPublishedResource resource) Updates a resource in the online caches.
void	I_CmsGlobalConfigurationCache.remove(CmsPublishedResource pubRes) Removes a published resource from the cache.
void	CmsDetailNameCache.remove(CmsPublishedResource pubRes)
void	I_CmsGlobalConfigurationCache.update(CmsPublishedResource pubRes) Updates the cache entry for the given published resource.
void	CmsDetailNameCache.update(CmsPublishedResource pubRes)

org.opencms.ade.configuration.formatters中CmsPublishedResource的使用

参数类型为CmsPublishedResource的org.opencms.ade.configuration.formatters中的方法

限定符和类型	方法和说明
void	CmsFormatterConfigurationCache.remove(CmsPublishedResource pubRes)
void	CmsFormatterConfigurationCache.update(CmsPublishedResource pubRes)

org.opencms.ade.containerpage.inherited中CmsPublishedResource的使用

参数类型为CmsPublishedResource的org.opencms.ade.containerpage.inherited中的方法

限定符和类型	方法和说明
void	CmsContainerConfigurationCache.remove(CmsPublishedResource resource)
void	CmsContainerConfigurationCache.update(CmsPublishedResource resource)

org.opencms.db中CmsPublishedResource的使用

返回变量类型为CmsPublishedResource的类型的org.opencms.db中的方法

限定符和类型	方法和说明
java.util.List<CmsPublishedResource>	CmsDriverManager.readPublishedResources(CmsDbContext dbc, CmsUUID publishHistoryId) Reads the resources that were published in a publish task for a given publish history ID.
java.util.List<CmsPublishedResource>	I_CmsProjectDriver.readPublishedResources(CmsDbContext dbc, CmsUUID publishHistoryId) Reads the resources that were published during a publish process for a given publish history ID.
java.util.List<CmsPublishedResource>	CmsSecurityManager.readPublishedResources(CmsRequestContext context, CmsUUID publishHistoryId) Reads the resources that were published in a publish task for a given publish history ID.

参数类型为CmsPublishedResource的org.opencms.db中的方法

限定符和类型	方法和说明
int	CmsPublishedResource.compareTo(CmsPublishedResource obj)
void	I_CmsProjectDriver.deletePublishHistoryEntry(CmsDbContext dbc, CmsUUID publishHistoryId, CmsPublishedResource publishResource) Deletes a publish history entry with publish tags >=0 and < the specified max. publish tag.
void	I_CmsProjectDriver.writePublishHistory(CmsDbContext dbc, CmsUUID publishId, CmsPublishedResource resource) Inserts an entry in the publish history for a published VFS resource.

org.opencms.db.generic中CmsPublishedResource的使用

返回变量类型为CmsPublishedResource的类型的org.opencms.db.generic中的方法

限定符和类型	方法和说明
java.util.List<CmsPublishedResource>	CmsProjectDriver.readPublishedResources(CmsDbContext dbc, CmsUUID publishHistoryId)

参数类型为CmsPublishedResource的org.opencms.db.generic中的方法

限定符和类型	方法和说明
void	CmsProjectDriver.deletePublishHistoryEntry(CmsDbContext dbc, CmsUUID publishHistoryId, CmsPublishedResource publishedResource)
void	CmsProjectDriver.writePublishHistory(CmsDbContext dbc, CmsUUID publishId, CmsPublishedResource resource)

org.opencms.db.jpa中CmsPublishedResource的使用

返回变量类型为CmsPublishedResource的类型的org.opencms.db.jpa中的方法

限定符和类型	方法和说明
java.util.List<CmsPublishedResource>	CmsProjectDriver.readPublishedResources(CmsDbContext dbc, CmsUUID publishHistoryId)

参数类型为CmsPublishedResource的org.opencms.db.jpa中的方法

限定符和类型	方法和说明
void	CmsProjectDriver.deletePublishHistoryEntry(CmsDbContext dbc, CmsUUID publishHistoryId, CmsPublishedResource publishedResource)
void	CmsProjectDriver.writePublishHistory(CmsDbContext dbc, CmsUUID publishId, CmsPublishedResource resource)

org.opencms.file中CmsPublishedResource的使用

返回变量类型为CmsPublishedResource的类型的org.opencms.file中的方法

限定符和类型	方法和说明
java.util.List<CmsPublishedResource>	CmsObject.readPublishedResources(CmsUUID publishHistoryId) Reads the resources that were published in a publish task for a given publish history ID.

org.opencms.monitor中CmsPublishedResource的使用

返回变量类型为CmsPublishedResource的类型的org.opencms.monitor中的方法

限定符和类型	方法和说明
java.util.List<CmsPublishedResource>	CmsMemoryMonitor.getCachedPublishedResources(java.lang.String cacheKey) Returns the published resources list cached with the given cache key or null if not found.

类型变量类型为CmsPublishedResource的org.opencms.monitor中的方法参数

限定符和类型	方法和说明
void	CmsMemoryMonitor.cachePublishedResources(java.lang.String cacheKey, java.util.List<CmsPublishedResource> publishedResources) Caches the given published resources list under the given cache key.

org.opencms.search中CmsPublishedResource的使用

返回变量类型为CmsPublishedResource的类型的org.opencms.search中的方法

限定符和类型	方法和说明
java.util.List<CmsPublishedResource>	CmsSearchIndexUpdateData.getResourcesToDelete() Returns the list of CmsPublishedResource instances that must be deleted.
protected java.util.List<CmsPublishedResource>	CmsSearchManager.CmsSearchOfflineHandler.getResourcesToIndex() Returns the list of CmsPublishedResource objects to index.
protected java.util.List<CmsPublishedResource>	CmsSearchManager.CmsSearchOfflineIndexThread.getResourcesToIndex() Obtains the list of resource to update in the offline index, then optimizes the list by removing duplicate entries.
java.util.List<CmsPublishedResource>	CmsSearchIndexUpdateData.getResourcesToUpdate() Returns the list of CmsPublishedResource instances that must be updated.

参数类型为CmsPublishedResource的org.opencms.search中的方法

限定符和类型	方法和说明
void	CmsSearchIndexUpdateData.addResourceToDelete(CmsPublishedResource resource) Adds the given resource to the resources that must be deleted from the search index.
void	CmsSearchIndexUpdateData.addResourceToUpdate(CmsPublishedResource resource) Adds the given resource to the resources that must be updated in the search index.
protected void	CmsVfsIndexer.addResourceToUpdateData(CmsPublishedResource pubRes, CmsSearchIndexUpdateData updateData) Adds a given published resource to the provided search index update data.
void	I_CmsIndexWriter.deleteDocument(CmsPublishedResource resource) Delete a document from the index.
void	CmsLuceneIndexWriter.deleteDocument(CmsPublishedResource resource)
protected void	CmsVfsIndexer.deleteResource(I_CmsIndexWriter indexWriter, CmsPublishedResource resource) Deletes a resource with the given index writer.
protected boolean	CmsVfsIndexer.isResourceInTimeWindow(CmsPublishedResource resource) Checks if the published resource is inside the time window set with release and expiration date.

类型变量类型为CmsPublishedResource的org.opencms.search中的方法参数

限定符和类型	方法和说明
protected void	CmsSearchManager.CmsSearchOfflineHandler.addResourcesToIndex(java.util.List<CmsPublishedResource> resourcesToIndex) Adds a list of CmsPublishedResource objects to be indexed.
void	CmsVfsIndexer.deleteResources(I_CmsIndexWriter indexWriter, java.util.List<CmsPublishedResource> resourcesToDelete)
void	I_CmsIndexer.deleteResources(I_CmsIndexWriter indexWriter, java.util.List<CmsPublishedResource> resourcesToDelete) Incremental index update - delete the index entry for all resources in the given list.
CmsSearchIndexUpdateData	CmsDependencyIndexer.getUpdateData(CmsSearchIndexSource source, java.util.List<CmsPublishedResource> publishedResources)
CmsSearchIndexUpdateData	CmsVfsIndexer.getUpdateData(CmsSearchIndexSource source, java.util.List<CmsPublishedResource> publishedResources)
CmsSearchIndexUpdateData	I_CmsIndexer.getUpdateData(CmsSearchIndexSource source, java.util.List<CmsPublishedResource> publishedResources) Calculates the data for an incremental search index update.
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.updateIndex(CmsSearchIndex index, I_CmsReport report, java.util.List<CmsPublishedResource> resourcesToIndex) Updates (if required creates) the index with the given name.
protected void	CmsSearchManager.updateIndexIncremental(CmsObject cms, 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.
void	CmsVfsIndexer.updateResources(I_CmsIndexWriter writer, CmsIndexingThreadManager threadManager, java.util.List<CmsPublishedResource> resourcesToUpdate)
void	I_CmsIndexer.updateResources(I_CmsIndexWriter writer, CmsIndexingThreadManager threadManager, java.util.List<CmsPublishedResource> resourcesToUpdate) Incremental index update - create a new index entry for all resources in the given list.

类型变量类型为CmsPublishedResource的org.opencms.search中的构造器参数

构造器和说明
CmsSearchManager.CmsSearchOfflineIndexWorkThread(I_CmsReport report, java.util.List<CmsPublishedResource> resourcesToIndex) Updates the offline search indexes for the given list of resources.

org.opencms.search.documents中CmsPublishedResource的使用

返回CmsPublishedResource的org.opencms.search.documents中的方法

限定符和类型	方法和说明
CmsPublishedResource	CmsDocumentDependency.getResource() Returns the VFS resource for which the dependencies are calculated.

参数类型为CmsPublishedResource的org.opencms.search.documents中的方法

限定符和类型	方法和说明
static CmsDocumentDependency	CmsDocumentDependency.load(CmsObject cms, CmsPublishedResource pubRes) Loads or creates a dependency object for the given parameters.
protected static void	CmsDocumentDependency.removeFromContext(CmsObject cms, CmsPublishedResource pubRes) Removes the dependency object for a published resource from the OpenCms runtime context.

org.opencms.search.solr中CmsPublishedResource的使用

参数类型为CmsPublishedResource的org.opencms.search.solr中的方法

限定符和类型	方法和说明
void	CmsSolrIndexWriter.deleteDocument(CmsPublishedResource resource)

org.opencms.staticexport中CmsPublishedResource的使用

返回变量类型为CmsPublishedResource的类型的org.opencms.staticexport中的方法

限定符和类型	方法和说明
protected java.util.List<CmsPublishedResource>	A_CmsStaticExportHandler.addMovedLinkSources(CmsObject cms, java.util.List<CmsPublishedResource> publishedResources) Add the link sources of moved resources to the list of published resources.
java.util.List<CmsPublishedResource>	CmsAfterPublishStaticExportHandler.getAllResources(CmsObject cms) Returns all resources within the current OpenCms site that are not marked as internal.
java.util.Set<CmsPublishedResource>	CmsStaticExportExportRule.getExportResources(CmsObject cms) Returns a set of CmsPublishedResource objects containing all resources specified by the <export-resources> node of this rule.
java.util.Set<CmsPublishedResource>	CmsStaticExportExportRule.getRelatedResources(CmsObject cms, CmsPublishedResource publishedResource) Returns a set of CmsPublishedResource objects specified by the <export-resources> node of this rule, if the publishedResource matches a modified Resource regular expression.
protected java.util.List<CmsPublishedResource>	CmsAfterPublishStaticExportHandler.getRelatedResources(CmsObject cms, java.util.List<CmsPublishedResource> publishedResources) Creates a list of CmsPublishedResource objects containing all related resources of the VFS tree.
protected java.util.Set<CmsPublishedResource>	CmsAfterPublishStaticExportHandler.getSiblings(CmsObject cms, CmsPublishedResource pubResource) Returns all siblings of the published resource as list of CmsPublishedResource.
java.util.List<CmsPublishedResource>	A_CmsStaticExportHandler.scrubExportFolders(CmsUUID publishHistoryId) Scrubs all files from the export folder that might have been changed, so that the export is newly created after the next request to the resource.

参数类型为CmsPublishedResource的org.opencms.staticexport中的方法

限定符和类型	方法和说明
java.util.Set<CmsPublishedResource>	CmsStaticExportExportRule.getRelatedResources(CmsObject cms, CmsPublishedResource publishedResource) Returns a set of CmsPublishedResource objects specified by the <export-resources> node of this rule, if the publishedResource matches a modified Resource regular expression.
protected java.util.Set<CmsPublishedResource>	CmsAfterPublishStaticExportHandler.getSiblings(CmsObject cms, CmsPublishedResource pubResource) Returns all siblings of the published resource as list of CmsPublishedResource.
protected void	A_CmsStaticExportHandler.scrubResource(CmsObject cms, CmsPublishedResource res, java.util.Set<java.lang.String> scrubbedFolders, java.util.Set<java.lang.String> scrubbedFiles) Scrub a single file or folder.

类型变量类型为CmsPublishedResource的org.opencms.staticexport中的方法参数

限定符和类型	方法和说明
protected java.util.List<CmsPublishedResource>	A_CmsStaticExportHandler.addMovedLinkSources(CmsObject cms, java.util.List<CmsPublishedResource> publishedResources) Add the link sources of moved resources to the list of published resources.
void	CmsAfterPublishStaticExportHandler.doExportAfterPublish(java.util.List<CmsPublishedResource> resources, I_CmsReport report) Does the actual static export.
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 java.util.List<CmsPublishedResource>	CmsAfterPublishStaticExportHandler.getRelatedResources(CmsObject cms, java.util.List<CmsPublishedResource> publishedResources) Creates a list of CmsPublishedResource objects containing all related resources of the VFS tree.
protected boolean	CmsAfterPublishStaticExportHandler.readNonTemplateResourcesToExport(CmsObject cms, java.util.List<CmsPublishedResource> publishedResources, java.util.List<CmsStaticExportData> resourcesToExport) Returns all non template resources found in a list of published resources.