Package org.opencms.workplace.tools.content.check

Class CmsContentCheck

java.lang.Object
org.opencms.workplace.tools.content.check.CmsContentCheck
public class CmsContentCheck extends Object
Main implementation of the content check. It maintains all configured content check plugins and handles the check process.

Since:
6.1.2

  • Field Details

  • Constructor Details

    • CmsContentCheck

      public CmsContentCheck(org.opencms.file.CmsObject cms)
      Constructor, creates a new CmsContentCheck.

      Parameters:
      cms - the CmsObject

  • Method Details

    • getPaths

      public List getPaths()
      Gets a list of all paths to be processed by the content check plugins.

      Returns:
      list of vfs paths

    • getPlugins

      public 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(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 Exception
      Starts the content check.

      Parameters:
      cms - the CmsObject
      report - StringBuffer for reporting
      Throws:
      Exception - if something goes wrong

    • toString

      public String toString()
      Overrides:
      toString in class Object
      See Also: