Uploaded image for project: 'XWiki Rendering'
  1. XWiki Rendering
  2. XRENDERING-441

Introduce a component to generate error blocks

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 7.4
    • Fix Version/s: 8.1-milestone-1
    • Component/s: API
    • Labels:
      None
    • Tests:
      Integration
    • Documentation:
      N/A
    • Documentation in Release Notes:
      N/A
    • Similar issues:

      Description

      /**
       * Generates error blocks to render an error in a wiki page.
       *
       * @version $Id$
       * @since 8.1M1
       */
      @Role
      public interface ErrorBlockGenerator
      {
          /**
           * The CSS class attribute name to use for the generated top level error block.
           */
          String CLASS_ATTRIBUTE_NAME = "class";
      
          /**
           * The CSS class attribute value to use for the block displaying the message.
           */
          String CLASS_ATTRIBUTE_MESSAGE_VALUE = "xwikirenderingerror";
      
          /**
           * The CSS class attribute value to use for the block displaying the description.
           */
          String CLASS_ATTRIBUTE_DESCRIPTION_VALUE = "xwikirenderingerrordescription hidden";
      
          /**
           * Generates error blocks to render an error in a wiki page.
           *
           * @param message the short message that will be displayed to the user
           * @param description the description that will be displayed to the user when he clicks on the message
           * @param isInline whether the generated blocks should be inline or not
           * @return the generated blocks
           */
          List<Block> generateErrorBlocks(String message, String description, boolean isInline);
      
          /**
           * Generates error blocks to render an error in a wiki page.
           *
           * @param messagePrefix the prefix of the short message that will be displayed to the user. This message will be
           *                      augmented with the root cause of the error extracted from the passed throwable and an
           *                      additional text inviting the user to click the message will be added to the message prefix
           * @param throwable the exception from which the description will be extracted from
           * @param isInline whether the generated blocks should be inline or not
           * @return the generated blocks
           */
          List<Block> generateErrorBlocks(String messagePrefix, Throwable throwable, boolean isInline);
      }
      

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                vmassol Vincent Massol
                Reporter:
                vmassol Vincent Massol
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: