org.apache.portals.applications.webcontent2.portlet.rewriter

Class MappingRewriterController

java.lang.Object

org.apache.portals.applications.webcontent2.portlet.rewriter.MappingRewriterController

All Implemented Interfaces:

RewriterController

Direct Known Subclasses:

MappingClasspathRewriterController

public class MappingRewriterController
extends Object
implements RewriterController

RewriterServiceImpl

Version:

$Id: MappingRewriterController.java 833059 2009-11-05 15:38:39Z woonsan $ Exp $

Author:

David Sean Taylor

Field Summary

Fields

Modifier and Type	Field and Description
protected Class	basicRewriterClass configured basic rewriter class
protected Map<String,String[]>	basicRewriterProps Basic rewriter instance properties
protected static org.slf4j.Logger	log
protected org.exolab.castor.mapping.Mapping	mapper the Castor mapping file name
protected String	mappingFile
protected Map<String,Class>	parserAdaptorMimeTypeClassMap Adaptors
protected Map<String,Map<String,String[]>>	parserAdaptorMimeTypePropsMap Parser adaptor rewriter instance properties map
protected Class	rulesetRewriterClass configured ruleset rewriter class
protected Map<String,String[]>	rulesetRewriterProps Ruleset rewriter instance properties
protected Map	rulesets Collection of rulesets in the system

Fields inherited from interface org.apache.portals.applications.webcontent2.portlet.rewriter.RewriterController

SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
MappingRewriterController(String mappingFile)
MappingRewriterController(String mappingFile, Class basicRewriterClass, Class ruleBasedRewriterClass, Map<String,Class> adaptorMimeTypeClassMap)
MappingRewriterController(String mappingFile, List rewriterClasses, List adaptorClasses)
MappingRewriterController(String mappingFile, String basicRewriterClassName, String rulesetRewriterClassName, String adaptorHtmlClassName, String adaptorXmlClassName)

Method Summary

Methods

Modifier and Type	Method and Description
ParserAdaptor	createParserAdaptor(String mimeType) Creates a Parser Adaptor for the given mime type The Parser Adaptor implementation is configured in the service configuration.
Rewriter	createRewriter() Creates a basic rewriter that does not support rulesets configurations.
RulesetRewriter	createRewriter(Ruleset ruleset) Creates a rewriter that supports rulesets configurations.
Map<String,String[]>	getBasicRewriterProps()
Map<String,Map<String,String[]>>	getParserAdaptorMimeTypePropsMap()
protected Reader	getReader(String resourcePath)
Map<String,String[]>	getRulesetRewriterProps()
protected void	loadMapping() Load the mapping file for ruleset configuration
Ruleset	loadRuleset(InputStream input) Loads a XML-based Rewriter Ruleset given a stream to the XML configuration.
Ruleset	loadRuleset(Reader reader) Loads a XML-based Rewriter Ruleset given a reader to the XML configuration.
Ruleset	lookupRuleset(String id) Lookup a Ruleset given a ruleset identifier.
void	setBasicRewriterProps(Map<String,String[]> props)
void	setParserAdaptorMimeTypePropsMap(Map<String,Map<String,String[]>> propsMap)
void	setRulesetRewriterProps(Map<String,String[]> props)
protected static List	toClassList(String classNameA, String classNameB)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

mappingFile

protected String mappingFile

mapper

protected org.exolab.castor.mapping.Mapping mapper

the Castor mapping file name

rulesets

protected Map rulesets

Collection of rulesets in the system

basicRewriterClass

protected Class basicRewriterClass

configured basic rewriter class

rulesetRewriterClass

protected Class rulesetRewriterClass

configured ruleset rewriter class

parserAdaptorMimeTypeClassMap

protected Map<String,Class> parserAdaptorMimeTypeClassMap

Adaptors

basicRewriterProps

protected Map<String,String[]> basicRewriterProps

Basic rewriter instance properties

rulesetRewriterProps

protected Map<String,String[]> rulesetRewriterProps

Ruleset rewriter instance properties

parserAdaptorMimeTypePropsMap

protected Map<String,Map<String,String[]>> parserAdaptorMimeTypePropsMap

Parser adaptor rewriter instance properties map

Constructor Detail

MappingRewriterController

public MappingRewriterController(String mappingFile)
                          throws RewriterException

Throws:

RewriterException

MappingRewriterController

public MappingRewriterController(String mappingFile,
                         Class basicRewriterClass,
                         Class ruleBasedRewriterClass,
                         Map<String,Class> adaptorMimeTypeClassMap)
                          throws RewriterException

Throws:

RewriterException

MappingRewriterController

public MappingRewriterController(String mappingFile,
                         List rewriterClasses,
                         List adaptorClasses)
                          throws RewriterException

Throws:

RewriterException

MappingRewriterController

public MappingRewriterController(String mappingFile,
                         String basicRewriterClassName,
                         String rulesetRewriterClassName,
                         String adaptorHtmlClassName,
                         String adaptorXmlClassName)
                          throws RewriterException

Throws:

RewriterException

Method Detail

toClassList

protected static List toClassList(String classNameA,
               String classNameB)

createRewriter

public Rewriter createRewriter()
                        throws InstantiationException,
                               IllegalAccessException

Description copied from interface: RewriterController

Creates a basic rewriter that does not support rulesets configurations. The Rewriter implementation is configured in the service configuration.

Specified by:

createRewriter in interface RewriterController

Returns:

A new rewriter that does not support rulesets.

Throws:

InstantiationException

IllegalAccessException

createRewriter

public RulesetRewriter createRewriter(Ruleset ruleset)
                               throws RewriterException

Description copied from interface: RewriterController

Creates a rewriter that supports rulesets configurations. The rewriter uses the rulesets configuration to control rewriting. The Rewriter implementation is configured in the service configuration.

Specified by:

createRewriter in interface RewriterController

Parameters:

ruleset - The ruleset configuration to control the rewriter.

Returns:

A new rewriter that supports rulesets.

Throws:

RewriterException

createParserAdaptor

public ParserAdaptor createParserAdaptor(String mimeType)
                                  throws RewriterException

Description copied from interface: RewriterController

Creates a Parser Adaptor for the given mime type The Parser Adaptor implementation is configured in the service configuration. Only MimeTypes of "text/html" and "text/xml" are currently supported.

Specified by:

createParserAdaptor in interface RewriterController

Parameters:

mimeType - The mimetype to create a parser adaptor for.

Returns:

A new parser adaptor

Throws:

RewriterException

loadMapping

protected void loadMapping()
                    throws RewriterException

Load the mapping file for ruleset configuration

Throws:

RewriterException

lookupRuleset

public Ruleset lookupRuleset(String id)

Description copied from interface: RewriterController

Lookup a Ruleset given a ruleset identifier.

Specified by:

lookupRuleset in interface RewriterController

Parameters:

id - The identifier for the Ruleset.

Returns:

A Ruleset configuration tree.

loadRuleset

public Ruleset loadRuleset(Reader reader)

Description copied from interface: RewriterController

Loads a XML-based Rewriter Ruleset given a reader to the XML configuration.

Specified by:

loadRuleset in interface RewriterController

Parameters:

reader - The stream to the XML configuration.

Returns:

A Ruleset configuration tree.

loadRuleset

public Ruleset loadRuleset(InputStream input)

Description copied from interface: RewriterController

Loads a XML-based Rewriter Ruleset given a stream to the XML configuration.

Specified by:

loadRuleset in interface RewriterController

Returns:

A Ruleset configuration tree.

getBasicRewriterProps

public Map<String,String[]> getBasicRewriterProps()

setBasicRewriterProps

public void setBasicRewriterProps(Map<String,String[]> props)

getRulesetRewriterProps

public Map<String,String[]> getRulesetRewriterProps()

setRulesetRewriterProps

public void setRulesetRewriterProps(Map<String,String[]> props)

getParserAdaptorMimeTypePropsMap

public Map<String,Map<String,String[]>> getParserAdaptorMimeTypePropsMap()

setParserAdaptorMimeTypePropsMap

public void setParserAdaptorMimeTypePropsMap(Map<String,Map<String,String[]>> propsMap)

getReader

protected Reader getReader(String resourcePath)
                    throws RewriterException

Throws:

RewriterException