Class CmsContentCheck
- java.lang.Object
-
- org.opencms.workplace.tools.content.check.CmsContentCheck
-
public class CmsContentCheck extends java.lang.Object
Main implementation of the content check. It maintains all configured content check plugins and handles the check process.- Since:
- 6.1.2
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
VFS_PATH_PLUGIN_FOLDER
Path to the plugin folder.
-
Constructor Summary
Constructors Constructor Description CmsContentCheck(org.opencms.file.CmsObject cms)
Constructor, creates a new CmsContentCheck.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List
getPaths()
Gets a list of all paths to be processed by the content check plugins.java.util.List
getPlugins()
Gets a list of instances of all available content check plugins.int
getPluginsCount()
Gets the number of installed plugins.CmsContentCheckResult
getResults()
Gets the results of the content check.void
setPaths(java.util.List paths)
Sets the list of all paths to be processed by the content check plugins.void
startContentCheck(org.opencms.file.CmsObject cms, org.opencms.report.I_CmsReport report)
Starts the content check.java.lang.String
toString()
-
-
-
Field Detail
-
VFS_PATH_PLUGIN_FOLDER
public static final java.lang.String VFS_PATH_PLUGIN_FOLDER
Path to the plugin folder.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsContentCheck
public CmsContentCheck(org.opencms.file.CmsObject cms)
Constructor, creates a new CmsContentCheck.- Parameters:
cms
- the CmsObject
-
-
Method Detail
-
getPaths
public java.util.List getPaths()
Gets a list of all paths to be processed by the content check plugins.- Returns:
- list of vfs paths
-
getPlugins
public java.util.List getPlugins()
Gets a list of instances of all available content check plugins.- Returns:
- list of plugin instances.
-
getPluginsCount
public int getPluginsCount()
Gets the number of installed plugins.- Returns:
- number of installed plugins
-
getResults
public CmsContentCheckResult getResults()
Gets the results of the content check.- Returns:
- CmsContentCheckResult object containing all resources that collected an error or warning
-
setPaths
public void setPaths(java.util.List paths)
Sets the list of all paths to be processed by the content check plugins.- Parameters:
paths
- list of vfs paths
-
startContentCheck
public void startContentCheck(org.opencms.file.CmsObject cms, org.opencms.report.I_CmsReport report) throws java.lang.Exception
Starts the content check.- Parameters:
cms
- the CmsObjectreport
- StringBuffer for reporting- Throws:
java.lang.Exception
- if something goes wrong
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
- See Also:
Object.toString()
-
-