Package com.webmethods.caf.faces.render

Class LimitedElementsResponseWriter

java.lang.Object

java.io.Writer

javax.faces.context.ResponseWriter

javax.faces.context.ResponseWriterWrapper

com.webmethods.caf.faces.render.LimitedElementsResponseWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable, FacesWrapper<ResponseWriter>

public class LimitedElementsResponseWriter
extends ResponseWriterWrapper

ResponseWriter which eats any element and its content if the element is in the blacklist, or if a whitelist has been specified, and the element is not in the whitelist.

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	m_blacklistAttributes
protected Set<String>	m_blacklistElements
protected int	m_depth
protected Set<String>	m_whitelistAttributes
protected Set<String>	m_whitelistElements
protected ResponseWriter	m_wrapped

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
LimitedElementsResponseWriter()
LimitedElementsResponseWriter(ResponseWriter wrapped)
LimitedElementsResponseWriter(ResponseWriter wrapped, Set<String> whitelistElements)
LimitedElementsResponseWriter(ResponseWriter wrapped, Set<String> whitelistElements, Set<String> whitelistAttributes)

Method Summary

Modifier and Type	Method	Description
Writer	append(char c)
Writer	append(CharSequence csq)
Writer	append(CharSequence csq, int start, int end)
ResponseWriter	cloneWithWriter(Writer writer)
void	endElement(String name)
Set<String>	getBlacklistAttributes()
Set<String>	getBlacklistElements()
Set<String>	getWhitelistAttributes()
Set<String>	getWhitelistElements()
ResponseWriter	getWrapped()
protected boolean	isAttributeAllowed(String name)	Return true if whitelist and blacklist allows specified attribute.
protected boolean	isElementAllowed(String name)	Return true if whitelist and blacklist allows specified element.
void	setBlacklistAttributes(Set<String> blacklistAttributes)
void	setBlacklistElements(Set<String> blacklistElements)
void	setWhitelistAttributes(Set<String> whitelistAttributes)
void	setWhitelistElements(Set<String> whitelistElements)
void	setWrapped(ResponseWriter wrapped)
void	startDocument()
void	startElement(String name, UIComponent component)
void	write(char[] cbuf)
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(String str)
void	write(String str, int off, int len)
void	writeAttribute(String name, Object value, String property)
void	writeComment(Object comment)
void	writeText(char[] text, int off, int len)
void	writeText(Object text, String property)
void	writeURIAttribute(String name, Object value, String property)

Methods inherited from class javax.faces.context.ResponseWriterWrapper

close, endCDATA, endDocument, flush, getCharacterEncoding, getContentType, startCDATA, writeDoctype, writePreamble, writeText

Methods inherited from class java.io.Writer

nullWriter

Methods inherited from class java.lang.Object

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

Field Details

m_wrapped

protected ResponseWriter m_wrapped

m_depth

protected int m_depth

m_whitelistElements

protected Set<String> m_whitelistElements

m_blacklistElements

protected Set<String> m_blacklistElements

m_whitelistAttributes

protected Set<String> m_whitelistAttributes

m_blacklistAttributes

protected Set<String> m_blacklistAttributes

Constructor Details

LimitedElementsResponseWriter

public LimitedElementsResponseWriter()

LimitedElementsResponseWriter

public LimitedElementsResponseWriter(ResponseWriter wrapped)

LimitedElementsResponseWriter

public LimitedElementsResponseWriter(ResponseWriter wrapped,
 Set<String> whitelistElements)

LimitedElementsResponseWriter

public LimitedElementsResponseWriter(ResponseWriter wrapped,
 Set<String> whitelistElements,
 Set<String> whitelistAttributes)

Method Details

append

public Writer append(char c)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public Writer append(CharSequence csq,
 int start,
 int end)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public Writer append(CharSequence csq)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

write

public void write(char[] cbuf,
 int off,
 int len)
           throws IOException

Overrides:

write in class ResponseWriterWrapper

Throws:

IOException

write

public void write(char[] cbuf)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(String str,
 int off,
 int len)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(String str)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

cloneWithWriter

public ResponseWriter cloneWithWriter(Writer writer)

Overrides:

cloneWithWriter in class ResponseWriterWrapper

endElement

public void endElement(String name)
                throws IOException

Overrides:

endElement in class ResponseWriterWrapper

Throws:

IOException

startDocument

public void startDocument()
                   throws IOException

Overrides:

startDocument in class ResponseWriterWrapper

Throws:

IOException

startElement

public void startElement(String name,
 UIComponent component)
                  throws IOException

Overrides:

startElement in class ResponseWriterWrapper

Throws:

IOException

writeAttribute

public void writeAttribute(String name,
 Object value,
 String property)
                    throws IOException

Overrides:

writeAttribute in class ResponseWriterWrapper

Throws:

IOException

writeComment

public void writeComment(Object comment)
                  throws IOException

Overrides:

writeComment in class ResponseWriterWrapper

Throws:

IOException

writeText

public void writeText(char[] text,
 int off,
 int len)
               throws IOException

Overrides:

writeText in class ResponseWriterWrapper

Throws:

IOException

writeText

public void writeText(Object text,
 String property)
               throws IOException

Overrides:

writeText in class ResponseWriterWrapper

Throws:

IOException

writeURIAttribute

public void writeURIAttribute(String name,
 Object value,
 String property)
                       throws IOException

Overrides:

writeURIAttribute in class ResponseWriterWrapper

Throws:

IOException

getWrapped

public ResponseWriter getWrapped()

Specified by:

getWrapped in interface FacesWrapper<ResponseWriter>

Overrides:

getWrapped in class ResponseWriterWrapper

isElementAllowed

protected boolean isElementAllowed(String name)

Return true if whitelist and blacklist allows specified element.

isAttributeAllowed

protected boolean isAttributeAllowed(String name)

Return true if whitelist and blacklist allows specified attribute.

setWrapped

public void setWrapped(ResponseWriter wrapped)

getWhitelistElements

public Set<String> getWhitelistElements()

setWhitelistElements

public void setWhitelistElements(Set<String> whitelistElements)

getBlacklistElements

public Set<String> getBlacklistElements()

setBlacklistElements

public void setBlacklistElements(Set<String> blacklistElements)

getWhitelistAttributes

public Set<String> getWhitelistAttributes()

setWhitelistAttributes

public void setWhitelistAttributes(Set<String> whitelistAttributes)

getBlacklistAttributes

public Set<String> getBlacklistAttributes()

setBlacklistAttributes

public void setBlacklistAttributes(Set<String> blacklistAttributes)