org.jasig.portal
Class CharacterCachingChannelIncorporationFilter

java.lang.Object
  org.jasig.portal.utils.SAX2FilterImpl
      org.jasig.portal.CharacterCachingChannelIncorporationFilter

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler, LexicalHandler, XMLFilter, XMLReader

public class CharacterCachingChannelIncorporationFilter
extends SAX2FilterImpl

A filter that incorporates channel content into the main SAX stream. Unlike a regular ChannelIncorporationFilter, this class can feed cache character buffers to the CachingSerializer.

Replaces <channel ID="channelSubcribeId"/> elements with channel output from the IChannelRenderer for that channelSubscribeId.

Version:

$Revision: 19776 $ $Date: 2010-01-14 16:17:21 -0600 (Thu, 14 Jan 2010) $

Author:

Peter Kharchenko pkharchenko@interactivebusiness.com"

Field Summary

protected org.apache.commons.logging.Log

logger

Fields inherited from class org.jasig.portal.utils.SAX2FilterImpl

contentHandler, dtdHandler, entityResolver, errorHandler, lexicalHandler, locator, log

Constructor Summary

CharacterCachingChannelIncorporationFilter(ContentHandler handler, ChannelManager chanm, boolean ccaching, HttpServletRequest request, HttpServletResponse response)
Downward chaining constructor.

Method Summary

void	endDocument() Filter an end document event.
void	endElement(String uri, String localName, String qName) Filter an end element event.
void	flush()
List<CacheEntry>	getCacheBlocks() Obtain system cache blocks.
void	startDocument() Filter a start document event.
void	startElement(String uri, String localName, String qName, Attributes atts) Filter a start element event.
String	toString()

Methods inherited from class org.jasig.portal.utils.SAX2FilterImpl

characters, comment, endCDATA, endDTD, endEntity, endPrefixMapping, error, fatalError, getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, getProperty, ignorableWhitespace, notationDecl, parse, parse, processingInstruction, resolveEntity, setAllHandlers, setContentHandler, setDocumentLocator, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setLexicalHandler, setParent, setProperty, skippedEntity, startCDATA, startDTD, startEntity, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

CharacterCachingChannelIncorporationFilter

public CharacterCachingChannelIncorporationFilter(ContentHandler handler,
                                                  ChannelManager chanm,
                                                  boolean ccaching,
                                                  HttpServletRequest request,
                                                  HttpServletResponse response)

Downward chaining constructor.

Method Detail

getCacheBlocks

public List<CacheEntry> getCacheBlocks()

Obtain system cache blocks.

Returns:

a List of CacheEntry blocks.

startDocument

public void startDocument()
                   throws SAXException

Description copied from class: SAX2FilterImpl

Filter a start document event.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class SAX2FilterImpl

Throws:

SAXException - The client may throw an exception during processing.

See Also:

ContentHandler.startDocument()

endDocument

public void endDocument()
                 throws SAXException

Description copied from class: SAX2FilterImpl

Filter an end document event.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class SAX2FilterImpl

Throws:

SAXException - The client may throw an exception during processing.

See Also:

ContentHandler.endDocument()

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes atts)
                  throws SAXException

Description copied from class: SAX2FilterImpl

Filter a start element event.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class SAX2FilterImpl

Parameters:

uri - The element's Namespace URI, or the empty string.

localName - The element's local name, or the empty string.

qName - The element's qualified (prefixed) name, or the empty string.

atts - The element's attributes.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

endElement

public void endElement(String uri,
                       String localName,
                       String qName)
                throws SAXException

Description copied from class: SAX2FilterImpl

Filter an end element event.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class SAX2FilterImpl

Parameters:

uri - The element's Namespace URI, or the empty string.

localName - The element's local name, or the empty string.

qName - The element's qualified (prefixed) name, or the empty string.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

flush

public void flush()

toString

public String toString()

Overrides:

toString in class Object