1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2 <!--NewPage--> 3 <HTML> 4 <HEAD> 5 <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 6 <TITLE> 7 Uses of Interface org.owasp.html.HtmlStreamEventReceiver (OWASP Java HTML Sanitizer) 8 </TITLE> 9 10 11 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> 12 13 <SCRIPT type="text/javascript"> 14 function windowTitle() 15 { 16 if (location.href.indexOf('is-external=true') == -1) { 17 parent.document.title="Uses of Interface org.owasp.html.HtmlStreamEventReceiver (OWASP Java HTML Sanitizer)"; 18 } 19 } 20 </SCRIPT> 21 <NOSCRIPT> 22 </NOSCRIPT> 23 24 </HEAD> 25 26 <BODY BGCOLOR="white" onload="windowTitle();"> 27 <HR> 28 29 30 <!-- ========= START OF TOP NAVBAR ======= --> 31 <A NAME="navbar_top"><!-- --></A> 32 <A HREF="#skip-navbar_top" title="Skip navigation links"></A> 33 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 34 <TR> 35 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 36 <A NAME="navbar_top_firstrow"><!-- --></A> 37 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 38 <TR ALIGN="center" VALIGN="top"> 39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html"><FONT CLASS="NavBarFont1"><B>Class</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 46 </TR> 47 </TABLE> 48 </TD> 49 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 50 <a href="http://code.google.com/p/owasp-java-html-sanitizer" target=_top>code.google.com home</a></EM> 51 </TD> 52 </TR> 53 54 <TR> 55 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 56 PREV 57 NEXT</FONT></TD> 58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 59 <A HREF="../../../../index.html?org/owasp/html//class-useHtmlStreamEventReceiver.html" target="_top"><B>FRAMES</B></A> 60 <A HREF="HtmlStreamEventReceiver.html" target="_top"><B>NO FRAMES</B></A> 61 <SCRIPT type="text/javascript"> 62 <!-- 63 if(window==top) { 64 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 65 } 66 //--> 67 </SCRIPT> 68 <NOSCRIPT> 69 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 70 </NOSCRIPT> 71 72 73 </FONT></TD> 74 </TR> 75 </TABLE> 76 <A NAME="skip-navbar_top"></A> 77 <!-- ========= END OF TOP NAVBAR ========= --> 78 79 <HR> 80 <CENTER> 81 <H2> 82 <B>Uses of Interface<br>org.owasp.html.HtmlStreamEventReceiver</B></H2> 83 </CENTER> 84 85 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 86 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 87 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 88 Packages that use <A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A></FONT></TH> 89 </TR> 90 <TR BGCOLOR="white" CLASS="TableRowColor"> 91 <TD><A HREF="#org.owasp.html"><B>org.owasp.html</B></A></TD> 92 <TD>An efficient <A HREF="../../../../org/owasp/html/HtmlSanitizer.html" title="class in org.owasp.html"><CODE>HtmlSanitizer</CODE></A> 93 configurable via a flexible 94 <A HREF="../../../../org/owasp/html/HtmlPolicyBuilder.html" title="class in org.owasp.html"><CODE>HtmlPolicyBuilder</CODE></A>. </TD> 95 </TR> 96 <TR BGCOLOR="white" CLASS="TableRowColor"> 97 <TD><A HREF="#org.owasp.html.examples"><B>org.owasp.html.examples</B></A></TD> 98 <TD> </TD> 99 </TR> 100 </TABLE> 101 102 <P> 103 <A NAME="org.owasp.html"><!-- --></A> 104 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 105 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 106 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 107 Uses of <A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A> in <A HREF="../../../../org/owasp/html/package-summary.html">org.owasp.html</A></FONT></TH> 108 </TR> 109 </TABLE> 110 111 <P> 112 113 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 114 <TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor"> 115 <TH ALIGN="left" COLSPAN="2">Subinterfaces of <A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A> in <A HREF="../../../../org/owasp/html/package-summary.html">org.owasp.html</A></FONT></TH> 116 </TR> 117 <TR BGCOLOR="white" CLASS="TableRowColor"> 118 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 119 <CODE>static interface</CODE></FONT></TD> 120 <TD><CODE><B><A HREF="../../../../org/owasp/html/HtmlSanitizer.Policy.html" title="interface in org.owasp.html">HtmlSanitizer.Policy</A></B></CODE> 121 122 <BR> 123 Receives events based on the HTML stream, and applies a policy to decide 124 what HTML constructs to allow.</TD> 125 </TR> 126 </TABLE> 127 128 <P> 129 130 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 131 <TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor"> 132 <TH ALIGN="left" COLSPAN="2">Classes in <A HREF="../../../../org/owasp/html/package-summary.html">org.owasp.html</A> that implement <A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A></FONT></TH> 133 </TR> 134 <TR BGCOLOR="white" CLASS="TableRowColor"> 135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 136 <CODE> class</CODE></FONT></TD> 137 <TD><CODE><B><A HREF="../../../../org/owasp/html/HtmlStreamRenderer.html" title="class in org.owasp.html">HtmlStreamRenderer</A></B></CODE> 138 139 <BR> 140 Given a series of HTML tokens, writes valid, normalized HTML to the output.</TD> 141 </TR> 142 <TR BGCOLOR="white" CLASS="TableRowColor"> 143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 144 <CODE> class</CODE></FONT></TD> 145 <TD><CODE><B><A HREF="../../../../org/owasp/html/TagBalancingHtmlStreamEventReceiver.html" title="class in org.owasp.html">TagBalancingHtmlStreamEventReceiver</A></B></CODE> 146 147 <BR> 148 Wraps an HTML stream event receiver to fill in missing close tags.</TD> 149 </TR> 150 </TABLE> 151 152 <P> 153 154 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 155 <TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor"> 156 <TH ALIGN="left" COLSPAN="2">Methods in <A HREF="../../../../org/owasp/html/package-summary.html">org.owasp.html</A> that return <A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A></FONT></TH> 157 </TR> 158 <TR BGCOLOR="white" CLASS="TableRowColor"> 159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 160 <CODE> <A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A></CODE></FONT></TD> 161 <TD><CODE><B>HtmlChangeReporter.</B><B><A HREF="../../../../org/owasp/html/HtmlChangeReporter.html#getWrappedRenderer()">getWrappedRenderer</A></B>()</CODE> 162 163 <BR> 164 </TD> 165 </TR> 166 </TABLE> 167 168 <P> 169 170 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 171 <TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor"> 172 <TH ALIGN="left" COLSPAN="2">Methods in <A HREF="../../../../org/owasp/html/package-summary.html">org.owasp.html</A> with parameters of type <A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A></FONT></TH> 173 </TR> 174 <TR BGCOLOR="white" CLASS="TableRowColor"> 175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 176 <CODE> <A HREF="../../../../org/owasp/html/HtmlSanitizer.Policy.html" title="interface in org.owasp.html">HtmlSanitizer.Policy</A></CODE></FONT></TD> 177 <TD><CODE><B>PolicyFactory.</B><B><A HREF="../../../../org/owasp/html/PolicyFactory.html#apply(org.owasp.html.HtmlStreamEventReceiver)">apply</A></B>(<A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A> out)</CODE> 178 179 <BR> 180 Produces a sanitizer that emits tokens to <code>out</code>.</TD> 181 </TR> 182 <TR BGCOLOR="white" CLASS="TableRowColor"> 183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 184 <CODE> 185 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 186 <TR ALIGN="right" VALIGN=""> 187 <TD NOWRAP><FONT SIZE="-1"> 188 <CODE><CTX> <A HREF="../../../../org/owasp/html/HtmlSanitizer.Policy.html" title="interface in org.owasp.html">HtmlSanitizer.Policy</A></CODE></FONT></TD> 189 </TR> 190 </TABLE> 191 </CODE></FONT></TD> 192 <TD><CODE><B>PolicyFactory.</B><B><A HREF="../../../../org/owasp/html/PolicyFactory.html#apply(org.owasp.html.HtmlStreamEventReceiver, org.owasp.html.HtmlChangeListener, CTX)">apply</A></B>(<A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A> out, 193 <A HREF="../../../../org/owasp/html/HtmlChangeListener.html" title="interface in org.owasp.html">HtmlChangeListener</A><CTX> listener, 194 CTX context)</CODE> 195 196 <BR> 197 Produces a sanitizer that emits tokens to <code>out</code> and that notifies 198 any <code>listener</code> of any dropped tags and attributes.</TD> 199 </TR> 200 <TR BGCOLOR="white" CLASS="TableRowColor"> 201 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 202 <CODE> <A HREF="../../../../org/owasp/html/HtmlSanitizer.Policy.html" title="interface in org.owasp.html">HtmlSanitizer.Policy</A></CODE></FONT></TD> 203 <TD><CODE><B>HtmlPolicyBuilder.</B><B><A HREF="../../../../org/owasp/html/HtmlPolicyBuilder.html#build(org.owasp.html.HtmlStreamEventReceiver)">build</A></B>(<A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A> out)</CODE> 204 205 <BR> 206 Produces a policy based on the allow and disallow calls previously made.</TD> 207 </TR> 208 <TR BGCOLOR="white" CLASS="TableRowColor"> 209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 210 <CODE> 211 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 212 <TR ALIGN="right" VALIGN=""> 213 <TD NOWRAP><FONT SIZE="-1"> 214 <CODE><CTX> <A HREF="../../../../org/owasp/html/HtmlSanitizer.Policy.html" title="interface in org.owasp.html">HtmlSanitizer.Policy</A></CODE></FONT></TD> 215 </TR> 216 </TABLE> 217 </CODE></FONT></TD> 218 <TD><CODE><B>HtmlPolicyBuilder.</B><B><A HREF="../../../../org/owasp/html/HtmlPolicyBuilder.html#build(org.owasp.html.HtmlStreamEventReceiver, org.owasp.html.HtmlChangeListener, CTX)">build</A></B>(<A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A> out, 219 <A HREF="../../../../org/owasp/html/HtmlChangeListener.html" title="interface in org.owasp.html">HtmlChangeListener</A><? super CTX> listener, 220 CTX context)</CODE> 221 222 <BR> 223 Produces a policy based on the allow and disallow calls previously made.</TD> 224 </TR> 225 </TABLE> 226 227 <P> 228 229 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 230 <TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor"> 231 <TH ALIGN="left" COLSPAN="2">Constructors in <A HREF="../../../../org/owasp/html/package-summary.html">org.owasp.html</A> with parameters of type <A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A></FONT></TH> 232 </TR> 233 <TR BGCOLOR="white" CLASS="TableRowColor"> 234 <TD><CODE><B><A HREF="../../../../org/owasp/html/HtmlChangeReporter.html#HtmlChangeReporter(org.owasp.html.HtmlStreamEventReceiver, org.owasp.html.HtmlChangeListener, T)">HtmlChangeReporter</A></B>(<A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A> renderer, 235 <A HREF="../../../../org/owasp/html/HtmlChangeListener.html" title="interface in org.owasp.html">HtmlChangeListener</A><? super <A HREF="../../../../org/owasp/html/HtmlChangeReporter.html" title="type parameter in HtmlChangeReporter">T</A>> listener, 236 <A HREF="../../../../org/owasp/html/HtmlChangeReporter.html" title="type parameter in HtmlChangeReporter">T</A> context)</CODE> 237 238 <BR> 239 </TD> 240 </TR> 241 <TR BGCOLOR="white" CLASS="TableRowColor"> 242 <TD><CODE><B><A HREF="../../../../org/owasp/html/TagBalancingHtmlStreamEventReceiver.html#TagBalancingHtmlStreamEventReceiver(org.owasp.html.HtmlStreamEventReceiver)">TagBalancingHtmlStreamEventReceiver</A></B>(<A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A> underlying)</CODE> 243 244 <BR> 245 </TD> 246 </TR> 247 </TABLE> 248 249 <P> 250 <A NAME="org.owasp.html.examples"><!-- --></A> 251 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 252 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 253 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 254 Uses of <A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A> in <A HREF="../../../../org/owasp/html/examples/package-summary.html">org.owasp.html.examples</A></FONT></TH> 255 </TR> 256 </TABLE> 257 258 <P> 259 260 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 261 <TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor"> 262 <TH ALIGN="left" COLSPAN="2">Fields in <A HREF="../../../../org/owasp/html/examples/package-summary.html">org.owasp.html.examples</A> with type parameters of type <A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A></FONT></TH> 263 </TR> 264 <TR BGCOLOR="white" CLASS="TableRowColor"> 265 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 266 <CODE>static com.google.common.base.Function<<A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html">HtmlStreamEventReceiver</A>,<A HREF="../../../../org/owasp/html/HtmlSanitizer.Policy.html" title="interface in org.owasp.html">HtmlSanitizer.Policy</A>></CODE></FONT></TD> 267 <TD><CODE><B>SlashdotPolicyExample.</B><B><A HREF="../../../../org/owasp/html/examples/SlashdotPolicyExample.html#POLICY_DEFINITION">POLICY_DEFINITION</A></B></CODE> 268 269 <BR> 270 A policy definition that matches the minimal HTML that Slashdot allows.</TD> 271 </TR> 272 </TABLE> 273 274 <P> 275 <HR> 276 277 278 <!-- ======= START OF BOTTOM NAVBAR ====== --> 279 <A NAME="navbar_bottom"><!-- --></A> 280 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 281 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 282 <TR> 283 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 284 <A NAME="navbar_bottom_firstrow"><!-- --></A> 285 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 286 <TR ALIGN="center" VALIGN="top"> 287 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 288 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 289 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../org/owasp/html/HtmlStreamEventReceiver.html" title="interface in org.owasp.html"><FONT CLASS="NavBarFont1"><B>Class</B></FONT></A> </TD> 290 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT> </TD> 291 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 292 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 293 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 294 </TR> 295 </TABLE> 296 </TD> 297 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 298 <a href="http://code.google.com/p/owasp-java-html-sanitizer" target=_top>code.google.com home</a></EM> 299 </TD> 300 </TR> 301 302 <TR> 303 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 304 PREV 305 NEXT</FONT></TD> 306 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 307 <A HREF="../../../../index.html?org/owasp/html//class-useHtmlStreamEventReceiver.html" target="_top"><B>FRAMES</B></A> 308 <A HREF="HtmlStreamEventReceiver.html" target="_top"><B>NO FRAMES</B></A> 309 <SCRIPT type="text/javascript"> 310 <!-- 311 if(window==top) { 312 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 313 } 314 //--> 315 </SCRIPT> 316 <NOSCRIPT> 317 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 318 </NOSCRIPT> 319 320 321 </FONT></TD> 322 </TR> 323 </TABLE> 324 <A NAME="skip-navbar_bottom"></A> 325 <!-- ======== END OF BOTTOM NAVBAR ======= --> 326 327 <HR> 328 329 </BODY> 330 </HTML> 331