Package org.opencms.report

Class CmsLogReport

  • All Implemented Interfaces:
    I_CmsReport
    public class CmsLogReport
extends A_CmsReport
    Report class used for the logfile.

    This prints all messages in the logfile at INFO level.

    Since:
    6.0.0

    • Constructor Detail

      • CmsLogReport

        public CmsLogReport​(java.util.Locale locale,
                    java.lang.Class<?> channel)
        Constructs a new report using the provided locale for the output language, using the provided Java class for the log channel.

        Parameters:
        locale - the locale to use for the report output messages
        channel - the log channel

      • CmsLogReport

        public CmsLogReport​(java.util.Locale locale,
                    java.lang.Object channel)
        Constructs a new report using the provided locale for the output language, using the provided Java class for the log channel.

        Parameters:
        locale - the locale to use for the report output messages
        channel - the log channel (usually a string with the package name, or a class)

    • Method Detail

      • getReportUpdate

        public java.lang.String getReportUpdate()
        Description copied from interface: I_CmsReport
        Updates this report, this processes all new output added since the last call to this method.

        This is only required in case the output is written to a HTML page, if the shell output is used, this will just return an empty String.

        Returns:
        new elements that have been added to the report and not yet processed.
        See Also:
        I_CmsReport.getReportUpdate()

      • print

        public void print​(java.lang.String value,
                  int format)
        Description copied from class: A_CmsReport
        Prints a String to the report, using the indicated formatting.

        Use the constants starting with FORMAT from this interface to indicate which formatting to use.

        Specified by:
        print in class A_CmsReport
        Parameters:
        value - the message container to add
        format - the formatting to use for the output
        See Also:
        A_CmsReport.print(java.lang.String, int)

      • println

        public void println​(java.lang.Throwable t)
        Description copied from interface: I_CmsReport
        Adds an Exception to the report, ensuring that the Exception content is processed to generate a valid output esp. for HTML pages.

        The exception will be stored and the output will later be processed in a special way.

        Parameters:
        t - the exception to add
        See Also:
        I_CmsReport.println(java.lang.Throwable)