Module org.apache.wicket.core
Package org.apache.wicket.response.filter

Class XmlCleaningResponseFilter

java.lang.Object
org.apache.wicket.response.filter.XmlCleaningResponseFilter
All Implemented Interfaces:
IResponseFilter
public class XmlCleaningResponseFilter extends Object implements IResponseFilter
An IResponseFilter that removes all invalid XML characters. By default it is used only for Wicket Ajax responses.

If the application needs to use it for other use cases then it can either override shouldFilter(AppendingStringBuffer) in the case it is used as IResponseFilter or stripNonValidXMLCharacters(AppendingStringBuffer) can be used directly.

Usage: MyApplication.java 

         public void init() {
             super.init();

             getRequestCycleSettings().addResponseFilter(new XmlCleaningResponseFilter());
         }

  • Constructor Details

  • Method Details

    • filter

      public AppendingStringBuffer filter(AppendingStringBuffer responseBuffer)
      Description copied from interface: IResponseFilter
      Filters the response buffer and returns the filtered response that can be used in the next filter or returned to the real output itself. A filter may alter the response buffer and return the response buffer itself.
      Specified by:
      filter in interface IResponseFilter
      Parameters:
      responseBuffer - The response buffer to be filtered
      Returns:
      The changed buffer or the response buffer itself (changed or not)

    • shouldFilter

      protected boolean shouldFilter(AppendingStringBuffer responseBuffer)
      Decides whether the filter should be applied.
      Parameters:
      responseBuffer - The buffer to filter
      Returns:
      true if the buffer brings Ajax response

    • stripNonValidXMLCharacters

      public AppendingStringBuffer stripNonValidXMLCharacters(AppendingStringBuffer input)
      This method ensures that the output String has only valid XML unicode characters as specified by the XML 1.0 standard. For reference, please see the standard. This method will return an empty String if the input is null or empty.
      Parameters:
      input - The StringBuffer whose non-valid characters we want to remove.
      Returns:
      The in String, stripped of non-valid characters.

    • isValidXmlChar

      protected boolean isValidXmlChar(int codePoint)
      Checks whether the character represented by this codePoint is a valid in XML documents.
      Parameters:
      codePoint - The codePoint for the checked character
      Returns:
      true if the character can be used in XML documents