Interface RenderedContentCleaner

All Known Implementing Classes:
PolicyConfiguredCleaner

public interface RenderedContentCleaner
Responsible for cleaning supplied HTML content into a form that is balanced and free of any insecure markup.
Since:
5.1.4
  • Method Summary

    Modifier and Type
    Method
    Description
    Clean the specified String.
    Convert the supplied value of an HTML style attribute into a safe form if necessary.
    boolean
    Test that the supplied value of a URL type attribute (such as href) is safe for output.
  • Method Details

    • cleanQuietly

      String cleanQuietly(String unclean)
      Clean the specified String.
      Parameters:
      unclean - the String to be cleaned
      Returns:
      a cleaned version of the supplied String
    • cleanStyleAttribute

      String cleanStyleAttribute(String uncleanStyle)
      Convert the supplied value of an HTML style attribute into a safe form if necessary. If the result of the safety checking results in no properties remaining then it is possible that an empty String will be returned.
      Parameters:
      uncleanStyle - the style attribute value to be cleaned
      Returns:
      a cleaned version of the supplied style attribute value..
    • isCleanUrlAttribute

      boolean isCleanUrlAttribute(String urlValue)
      Test that the supplied value of a URL type attribute (such as href) is safe for output.
      Parameters:
      urlValue -
      Returns:
      true if this attribute value can be output, otherwise false.