Class PartialResponseWriterImpl
- java.lang.Object
-
- java.io.Writer
-
- jakarta.faces.context.ResponseWriter
-
- jakarta.faces.context.ResponseWriterWrapper
-
- jakarta.faces.context.PartialResponseWriter
-
- org.apache.myfaces.context.PartialResponseWriterImpl
-
- All Implemented Interfaces:
FacesWrapper<ResponseWriter>,Closeable,Flushable,Appendable,AutoCloseable
public class PartialResponseWriterImpl extends PartialResponseWriter
Double buffering partial response writer to take care if embedded CDATA blocks in update delete etc...
According to the spec 13.4.4.1 Writing The Partial Response implementations have to take care to handle nested cdata blocks properly
This means we cannot allow nested CDATA according to the xml spec http://www.w3.org/TR/REC-xml/#sec-cdata-sect everything within a CDATA block is unparsed except for ]]>
Now we have following problem, that CDATA inserts can happen everywhere not only within the CDATA instructions.
What we have to do now is to double buffer CDATA blocks until their end and also!!! parse their content for CDATA embedding and replace it with an escaped end sequence.
Now parsing CDATA embedding is a little bit problematic in case of PPR because it can happen that someone simply adds a CDATA in a javascript string or somewhere else. Because he/she is not aware that we wrap the entire content into CDATA. Simply encoding and decoding of the CDATA is similarly problematic because the browser then chokes on embedded //<![CDATA[ //]]> sections
What we do for now is to simply remove //<![CDATA[ and //]]> and replace all other pending cdatas with their cdata escapes ]]> becomes <![CDATA[]]]]><![CDATA[>
If this causes problems in corner cases we also can add a second encoding step in case of the cdata Javascript comment removal is not enough to cover all corner cases.
For now I will only implement this in the impl, due to the spec stating that implementations are responsible of the correct CDATA handling!
- Version:
- $Revision$ $Date$
- Author:
- Werner Punz (latest modification by $Author$)
-
-
Field Summary
-
Fields inherited from class jakarta.faces.context.PartialResponseWriter
RENDER_ALL_MARKER, VIEW_STATE_MARKER
-
-
Constructor Summary
Constructors Constructor Description PartialResponseWriterImpl(ResponseWriter writer)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Writerappend(char c)Writerappend(CharSequence csq)Writerappend(CharSequence csq, int start, int end)ResponseWritercloneWithWriter(Writer writer)voidclose()voidendCDATA()voidendElement(String name)voidendError()voidendEval()voidendExtension()voidendInsert()voidendUpdate()voidflush()voidstartCDATA()voidstartElement(String name, UIComponent component)voidwrite(char[] cbuf)voidwrite(char[] cbuf, int off, int len)voidwrite(int c)voidwrite(String str)voidwrite(String str, int off, int len)voidwriteAttribute(String name, Object value, String property)voidwriteComment(Object comment)voidwriteText(char[] text, int off, int len)voidwriteText(Object object, UIComponent component, String string)voidwriteText(Object text, String property)voidwriteURIAttribute(String name, Object value, String property)-
Methods inherited from class jakarta.faces.context.PartialResponseWriter
delete, endDocument, redirect, startDocument, startError, startEval, startExtension, startInsertAfter, startInsertBefore, startUpdate, updateAttributes
-
Methods inherited from class jakarta.faces.context.ResponseWriterWrapper
getCharacterEncoding, getContentType, getWrapped, writeDoctype, writePreamble
-
Methods inherited from class java.io.Writer
nullWriter
-
-
-
-
Constructor Detail
-
PartialResponseWriterImpl
public PartialResponseWriterImpl(ResponseWriter writer)
-
-
Method Detail
-
startCDATA
public void startCDATA() throws IOException- Overrides:
startCDATAin classResponseWriterWrapper- Throws:
IOException
-
endCDATA
public void endCDATA() throws IOException- Overrides:
endCDATAin classResponseWriterWrapper- Throws:
IOException
-
endInsert
public void endInsert() throws IOException- Overrides:
endInsertin classPartialResponseWriter- Throws:
IOException
-
endUpdate
public void endUpdate() throws IOException- Overrides:
endUpdatein classPartialResponseWriter- Throws:
IOException
-
endExtension
public void endExtension() throws IOException- Overrides:
endExtensionin classPartialResponseWriter- Throws:
IOException
-
endEval
public void endEval() throws IOException- Overrides:
endEvalin classPartialResponseWriter- Throws:
IOException
-
endError
public void endError() throws IOException- Overrides:
endErrorin classPartialResponseWriter- Throws:
IOException
-
endElement
public void endElement(String name) throws IOException
- Overrides:
endElementin classResponseWriterWrapper- Throws:
IOException
-
writeComment
public void writeComment(Object comment) throws IOException
- Overrides:
writeCommentin classResponseWriterWrapper- Throws:
IOException
-
startElement
public void startElement(String name, UIComponent component) throws IOException
- Overrides:
startElementin classResponseWriterWrapper- Throws:
IOException
-
writeText
public void writeText(Object text, String property) throws IOException
- Overrides:
writeTextin classResponseWriterWrapper- Throws:
IOException
-
writeText
public void writeText(char[] text, int off, int len) throws IOException- Overrides:
writeTextin classResponseWriterWrapper- Throws:
IOException
-
write
public void write(char[] cbuf, int off, int len) throws IOException- Overrides:
writein classResponseWriterWrapper- Throws:
IOException
-
cloneWithWriter
public ResponseWriter cloneWithWriter(Writer writer)
- Overrides:
cloneWithWriterin classResponseWriterWrapper
-
writeURIAttribute
public void writeURIAttribute(String name, Object value, String property) throws IOException
- Overrides:
writeURIAttributein classResponseWriterWrapper- Throws:
IOException
-
close
public void close() throws IOException- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classResponseWriterWrapper- Throws:
IOException
-
flush
public void flush() throws IOException- Specified by:
flushin interfaceFlushable- Overrides:
flushin classResponseWriterWrapper- Throws:
IOException
-
writeAttribute
public void writeAttribute(String name, Object value, String property) throws IOException
- Overrides:
writeAttributein classResponseWriterWrapper- Throws:
IOException
-
writeText
public void writeText(Object object, UIComponent component, String string) throws IOException
- Overrides:
writeTextin classResponseWriterWrapper- Throws:
IOException
-
append
public Writer append(char c) throws IOException
- Specified by:
appendin interfaceAppendable- Overrides:
appendin classWriter- Throws:
IOException
-
append
public Writer append(CharSequence csq, int start, int end) throws IOException
- Specified by:
appendin interfaceAppendable- Overrides:
appendin classWriter- Throws:
IOException
-
append
public Writer append(CharSequence csq) throws IOException
- Specified by:
appendin interfaceAppendable- Overrides:
appendin classWriter- Throws:
IOException
-
write
public void write(char[] cbuf) throws IOException- Overrides:
writein classWriter- Throws:
IOException
-
write
public void write(int c) throws IOException- Overrides:
writein classWriter- Throws:
IOException
-
write
public void write(String str, int off, int len) throws IOException
- Overrides:
writein classWriter- Throws:
IOException
-
write
public void write(String str) throws IOException
- Overrides:
writein classWriter- Throws:
IOException
-
-