Package org.opencms.setup.comptest

Class CmsSetupTestResult

  • public class CmsSetupTestResult
extends java.lang.Object
    Contains info about the result of a setup test.

    Since:
    6.0.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getHelp()
      Returns the help string what to do if a test failed.
      java.lang.String getInfo()
      Returns the description of the test, e.g.
      java.lang.String getName()
      Returns the name of the test, e.g.
      java.lang.String getResult()
      Returns the result of the test, e.g.
      boolean isGreen()
      Returns true, if the conditions the test were fulfilled.
      boolean isRed()
      Returns true if the test found a violated condition.
      boolean isYellow()
      Returns true if the test found a questionable condition.
      protected void setGreen()
      Sets if the conditions in the test were fulfilled.
      protected void setHelp​(java.lang.String help)
      Sets the help string what to do if a test failed.
      protected void setInfo​(java.lang.String info)
      Sets the description of the test, e.g.
      protected void setName​(java.lang.String name)
      Sets the name of the test, e.g.
      protected void setRed()
      Sets if the test found a violated condition.
      protected void setResult​(java.lang.String result)
      Sets the result of the test, e.g.
      protected void setYellow()
      Sets if the test found a questionable condition.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getHelp

        public java.lang.String getHelp()
        Returns the help string what to do if a test failed.

        This string will be displayed in a help bubble.

        Returns:
        the help string what to do if a test failed

      • getInfo

        public java.lang.String getInfo()
        Returns the description of the test, e.g. "Test xy failed due to...".

        Returns:
        the description of the test

      • getName

        public java.lang.String getName()
        Returns the name of the test, e.g. "Operating system test".

        Returns:
        the name of the test

      • getResult

        public java.lang.String getResult()
        Returns the result of the test, e.g. "Detected Apache Tomcat/4.1.24...".

        Returns:
        the result of the test

      • isGreen

        public boolean isGreen()
        Returns true, if the conditions the test were fulfilled.

        Returns:
        true, if the conditions the test were fulfilled

      • isRed

        public boolean isRed()
        Returns true if the test found a violated condition. It is assumed that it will be impossible to run OpenCms.

        Returns:
        true if the test found a violated a condition

      • isYellow

        public boolean isYellow()
        Returns true if the test found a questionable condition. It is possible that OpenCms will not run.

        Returns:
        true if the test found a questionable condition

      • setGreen

        protected void setGreen()
        Sets if the conditions in the test were fulfilled.

      • setHelp

        protected void setHelp​(java.lang.String help)
        Sets the help string what to do if a test failed.

        This string will be displayed in a help bubble.

        Parameters:
        help - the help string what to do if a test failed

      • setInfo

        protected void setInfo​(java.lang.String info)
        Sets the description of the test, e.g. "Test xy failed due to...".

        Parameters:
        info - the description of the test

      • setName

        protected void setName​(java.lang.String name)
        Sets the name of the test, e.g. "Operating system test".

        Parameters:
        name - the name of the test

      • setRed

        protected void setRed()
        Sets if the test found a violated condition.

      • setResult

        protected void setResult​(java.lang.String result)
        Sets the result of the test, e.g. "Detected Apache Tomcat/4.1.24...".

        Parameters:
        result - the result of the test

      • setYellow

        protected void setYellow()
        Sets if the test found a questionable condition.