Interface Sanitizer


public interface Sanitizer
Provides an interface and constants for sanitizer component implementations. Commonly, sanitizers are implemented for stripping offensive vocabulary from content or for removing malicious HTML content, such as cross-site scripting (CSS). Multiple implementations can be deployed in a hook plugin and specified in a comma separated list of values for the sanitizer.impl portal property (see Sanitizer). All installed sanitizers are chained.
Author:
Zsolt Balogh, Brian Wing Shun Chan
  • Field Details

  • Method Details

    • sanitize

      String sanitize(long companyId, long groupId, long userId, String className, long classPK, String contentType, String[] modes, String content, Map<String,Object> options) throws SanitizerException
      Returns the sanitized content as a string.
      Parameters:
      companyId - the primary key of the portal instance
      groupId - the primary key of the site's group
      userId - the user who changed the content
      className - the class name of the content model implementation
      classPK - the primary key of the content to sanitize, 0 if not available
      contentType - the content type. For more information, see ContentTypes.
      modes - ways in which to run the sanitizer, such as MODE_ALL, MODE_BAD_WORDS, and/or MODE_XSS
      content - the content to sanitize
      options - the options map
      Returns:
      the sanitized content
      Throws:
      SanitizerException - if a sanitizer exception occurred