org.milyn.delivery

Class AbstractContentDeliveryConfig

java.lang.Object

org.milyn.delivery.AbstractContentDeliveryConfig

All Implemented Interfaces:

ContentDeliveryConfig

Direct Known Subclasses:

DOMContentDeliveryConfig, SAXContentDeliveryConfig

public abstract class AbstractContentDeliveryConfig
extends Object
implements ContentDeliveryConfig

Abstract ContentDeliveryConfig.

Author:

tom.fennelly@gmail.com

Field Summary

Fields inherited from interface org.milyn.delivery.ContentDeliveryConfig

SMOOKS_VISITORS_SORT

Constructor Summary

Constructors

Constructor and Description
AbstractContentDeliveryConfig()

Method Summary

Modifier and Type	Method and Description
<T extends Visitor> void	addToExecutionLifecycleSets(ContentHandlerConfigMapTable<T> handlerSet)
void	executeHandlerCleanup(ExecutionContext executionContext) Cleanup execution context lifecycle aware handlers.
void	executeHandlerInit(ExecutionContext executionContext) Initialize execution context lifecycle aware handlers.
List<ConfigBuilderEvent>	getConfigBuilderEvents() Get the list of Execution Events generated during the build of the configuration.
DTDStore.DTDObjectContainer	getDTD() Get the DTD (DTDStore.DTDObjectContainer) for this delivery context.
protected FilterBypass	getFilterBypass(ContentHandlerConfigMapTable... visitorTables)
List	getObjects(String selector) Get a list Objects from the supplied SmooksResourceConfiguration selector value.
Map<String,List<SmooksResourceConfiguration>>	getSmooksResourceConfigurations() Get the SmooksResourceConfiguration map for the target execution context.
List	getSmooksResourceConfigurations(String selector) Get the list of SmooksResourceConfigurations for the specified selector definition.
XMLReader	getXMLReader() Get an XMLReader instance from the reader pool associated with this ContentDelivery config instance.
void	initializeXMLReaderPool()
boolean	isDefaultSerializationOn() Is default serialization on..
void	returnXMLReader(XMLReader reader) Return an XMLReader instance to the reader pool associated with this ContentDelivery config instance.
void	setApplicationContext(ApplicationContext applicationContext)
void	setDtd(DTDStore.DTDObjectContainer dtd)
void	setSmooksResourceConfigurations(Map<String,List<SmooksResourceConfiguration>> resourceConfigTable)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.milyn.delivery.ContentDeliveryConfig

addToExecutionLifecycleSets, getFilterBypass, newFilter, sort

Constructor Detail

AbstractContentDeliveryConfig

public AbstractContentDeliveryConfig()

Method Detail

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)

getSmooksResourceConfigurations

public List getSmooksResourceConfigurations(String selector)

Get the list of SmooksResourceConfigurations for the specified selector definition.

Specified by:

getSmooksResourceConfigurations in interface ContentDeliveryConfig

Parameters:

selector - The configuration "selector" attribute value from the .cdrl file in the .cdrar.

Returns:

List of SmooksResourceConfiguration instances, or null.

See Also:

ContentDeliveryConfig.getObjects(String)

setSmooksResourceConfigurations

public void setSmooksResourceConfigurations(Map<String,List<SmooksResourceConfiguration>> resourceConfigTable)

getSmooksResourceConfigurations

public Map<String,List<SmooksResourceConfiguration>> getSmooksResourceConfigurations()

Get the SmooksResourceConfiguration map for the target execution context.

This Map will be preordered for the target execution context.

Specified by:

getSmooksResourceConfigurations in interface ContentDeliveryConfig

Returns:

SmooksResourceConfiguration map for the target execution context, keyed by the configuration selector, with each value being a List of preordered SmooksResourceConfiguration instances.

getObjects

public List getObjects(String selector)

Get a list Objects from the supplied SmooksResourceConfiguration selector value.

Uses SmooksResourceConfigurationStore.getObject(org.milyn.cdr.SmooksResourceConfiguration) to construct the object.

Specified by:

getObjects in interface ContentDeliveryConfig

Parameters:

selector - selector attribute value from the .cdrl file in the .cdrar.

Returns:

List of Object instances. An empty list is returned where no selectors exist.

See Also:

SmooksResourceConfigurationStore.getObject(org.milyn.cdr.SmooksResourceConfiguration), ContentDeliveryConfig.getSmooksResourceConfigurations(String)

getDTD

public DTDStore.DTDObjectContainer getDTD()

Description copied from interface: ContentDeliveryConfig

Get the DTD (DTDStore.DTDObjectContainer) for this delivery context.

Specified by:

getDTD in interface ContentDeliveryConfig

Returns:

The DTD (DTDStore.DTDObjectContainer) for this delivery context.

setDtd

public void setDtd(DTDStore.DTDObjectContainer dtd)

getConfigBuilderEvents

public List<ConfigBuilderEvent> getConfigBuilderEvents()

Description copied from interface: ContentDeliveryConfig

Get the list of Execution Events generated during the build of the configuration.

Specified by:

getConfigBuilderEvents in interface ContentDeliveryConfig

Returns:

The list of events.

isDefaultSerializationOn

public boolean isDefaultSerializationOn()

Description copied from interface: ContentDeliveryConfig

Is default serialization on..

Specified by:

isDefaultSerializationOn in interface ContentDeliveryConfig

Returns:

True if default serialization is on, otherwise false.

addToExecutionLifecycleSets

public <T extends Visitor> void addToExecutionLifecycleSets(ContentHandlerConfigMapTable<T> handlerSet)

executeHandlerInit

public void executeHandlerInit(ExecutionContext executionContext)

Description copied from interface: ContentDeliveryConfig

Initialize execution context lifecycle aware handlers.

Specified by:

executeHandlerInit in interface ContentDeliveryConfig

Parameters:

executionContext - The execution context.

executeHandlerCleanup

public void executeHandlerCleanup(ExecutionContext executionContext)

Description copied from interface: ContentDeliveryConfig

Cleanup execution context lifecycle aware handlers.

Specified by:

executeHandlerCleanup in interface ContentDeliveryConfig

Parameters:

executionContext - The execution context.

initializeXMLReaderPool

public void initializeXMLReaderPool()

getXMLReader

public XMLReader getXMLReader()
                       throws SAXException

Description copied from interface: ContentDeliveryConfig

Get an XMLReader instance from the reader pool associated with this ContentDelivery config instance.

Specified by:

getXMLReader in interface ContentDeliveryConfig

Returns:

An XMLReader instance if the pool is not empty, otherwise null.

Throws:

SAXException

returnXMLReader

public void returnXMLReader(XMLReader reader)

Description copied from interface: ContentDeliveryConfig

Return an XMLReader instance to the reader pool associated with this ContentDelivery config instance.

Specified by:

returnXMLReader in interface ContentDeliveryConfig

Parameters:

reader - The XMLReader instance to be returned. If the pool is full, the instance is left to the GC (i.e. lost).

getFilterBypass

protected FilterBypass getFilterBypass(ContentHandlerConfigMapTable... visitorTables)