org.owasp.validator.html.scan

Class AntiSamySAXScanner

java.lang.Object

org.owasp.validator.html.scan.AbstractAntiSamyScanner

org.owasp.validator.html.scan.AntiSamySAXScanner

public class AntiSamySAXScanner
extends AbstractAntiSamyScanner

Field Summary

Fields inherited from class org.owasp.validator.html.scan.AbstractAntiSamyScanner

errorMessages, isNofollowAnchors, isValidateParamAsEmbed, locale, messages, policy

Constructor Summary

Constructors

Constructor and Description
AntiSamySAXScanner(Policy policy)

Method Summary

Modifier and Type	Method and Description
CleanResults	getResults()
CleanResults	scan(Reader reader, Writer writer) Using a SAX parser, can pass Streams for input and output.
CleanResults	scan(String html)
CleanResults	scan(String html, Policy policy)

Methods inherited from class org.owasp.validator.html.scan.AbstractAntiSamyScanner

addError, getHTMLSerializer, getOutputFormat, trim

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AntiSamySAXScanner

public AntiSamySAXScanner(Policy policy)

Method Detail

getResults

public CleanResults getResults()

Specified by:

getResults in class AbstractAntiSamyScanner

scan

public CleanResults scan(String html)
                  throws ScanException

Specified by:

scan in class AbstractAntiSamyScanner

Throws:

ScanException

scan

public CleanResults scan(String html,
                         Policy policy)
                  throws ScanException

Throws:

ScanException

scan

public CleanResults scan(Reader reader,
                         Writer writer)
                  throws ScanException

Using a SAX parser, can pass Streams for input and output. Use case is a Servlet filter where request or response is large and caller does not need the entire string in memory.

Parameters:

reader - A Reader which can feed the SAXParser a little input at a time

writer - A Writer that can take a little output at a time

Returns:

CleanResults where the cleanHtml is null. If a caller wants the HTML as a string, it must capture the contents of the writer (i.e., use a StringWriter).

Throws:

ScanException - When there is a problem encountered while scanning the HTML.