com.randomcoder.content
Class XHTMLFilter

java.lang.Object
  com.randomcoder.content.XHTMLFilter

All Implemented Interfaces:

ContentFilter

public class XHTMLFilter
extends Object
implements ContentFilter

Simple XHTML content filter.

This class implements a large subset of XHTML (minus dangerous, deprecated, or otherwise undesirable stuff). Tag and attribute names are canonicalized, non-semantic markup is converted to semantic, and disallowed elements, their children, and attributes are removed.

 Copyright (c) 2006, Craig Condit. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
   * Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright notice,
     this list of conditions and the following disclaimer in the documentation
     and/or other materials provided with the distribution.
     
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 

Field Summary

protected static org.apache.commons.logging.Log	logger Apache logger.
static String	PREFIX Prefix to add to content before parsing.
static String	SUFFIX Suffix to add to content before parsing.

Constructor Summary

XHTMLFilter()
Constructs a new XHTML filter

Method Summary

String	getPrefix(String contentType) Gets the data to prepend to a content stream before processing.
String	getSuffix(String contentType) Gets the data to append to a content stream before processing.
XMLReader	getXMLReader(URL baseUrl, String contentType) Gets an XML reader suitable for the given content type.
Templates	getXSLTemplates(String contentType) Gets XSL templates for the given content type.
void	setAllowedClasses(Set<String> allowedClasses) Sets a list of allowed CSS class names in the markup.
void	validate(String contentType, Reader content) Validates the given input.

Methods inherited from class java.lang.Object

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

Field Detail

logger

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

Apache logger.

PREFIX

public static final String PREFIX

Prefix to add to content before parsing.

See Also:

Constant Field Values

SUFFIX

public static final String SUFFIX

Suffix to add to content before parsing.

See Also:

Constant Field Values

Constructor Detail

XHTMLFilter

public XHTMLFilter()
            throws TransformerConfigurationException,
                   SAXException

Constructs a new XHTML filter

Throws:

TransformerConfigurationException - if transformer factory fails

SAXException - if schema validation fails

Method Detail

setAllowedClasses

public void setAllowedClasses(Set<String> allowedClasses)

Sets a list of allowed CSS class names in the markup.

Parameters:

allowedClasses - Set of CSS class names

getXMLReader

public XMLReader getXMLReader(URL baseUrl,
                              String contentType)
                       throws SAXException

Description copied from interface: ContentFilter

Gets an XML reader suitable for the given content type.

Specified by:

getXMLReader in interface ContentFilter

Parameters:

baseUrl - base URL for content, or null to omit

contentType - content type of input

Returns:

XML reader

Throws:

SAXException - if a SAX parsing error occurs

getXSLTemplates

public Templates getXSLTemplates(String contentType)

Description copied from interface: ContentFilter

Gets XSL templates for the given content type.

Specified by:

getXSLTemplates in interface ContentFilter

Parameters:

contentType - content type of input

Returns:

templates, or null if no transformation is to be done

getPrefix

public String getPrefix(String contentType)

Description copied from interface: ContentFilter

Gets the data to prepend to a content stream before processing.

Specified by:

getPrefix in interface ContentFilter

Returns:

prefix data or null if none

getSuffix

public String getSuffix(String contentType)

Description copied from interface: ContentFilter

Gets the data to append to a content stream before processing.

Specified by:

getSuffix in interface ContentFilter

Returns:

suffixs data or null if none

validate

public void validate(String contentType,
                     Reader content)
              throws InvalidContentException,
                     InvalidContentTypeException,
                     IOException

Description copied from interface: ContentFilter

Validates the given input.

Specified by:

validate in interface ContentFilter

Parameters:

contentType - content type

content - textual content to validate

Throws:

InvalidContentException - if content is invalid

InvalidContentTypeException - if the content type is invalid

IOException - if content could not be read