org.milyn.delivery
Interface ContentDeliveryConfig

All Known Implementing Classes:

AbstractContentDeliveryConfig, DOMContentDeliveryConfig, MockContentDeliveryConfig, SAXContentDeliveryConfig

public interface ContentDeliveryConfig

Content delivery configuration.

Provides access to Content Delivery Resources (e.g. Content Delivery Units) and other information for the targeted profile.

Author:

tfennelly

Method Summary

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.
List	getObjects(String selector) Get a list of Objects from the SmooksResourceConfigurations specified by the selector.
Map<String,List<SmooksResourceConfiguration>>	getSmooksResourceConfigurations() Get the SmooksResourceConfiguration map for the target execution context.
List<ContentHandlerConfigMap>	getSmooksResourceConfigurations(String selector) Get the list of SmooksResourceConfigurations for the specified selector definition.
boolean	isDefaultSerializationOn() Is default serialization on..
Filter	newFilter(ExecutionContext executionContext) Get a new stream filter for the content delivery configuration.

Method Detail

getSmooksResourceConfigurations

List<ContentHandlerConfigMap> getSmooksResourceConfigurations(String selector)

Get the list of SmooksResourceConfigurations for the specified selector definition.

This list will be preselected and preordered for the target execution context.

Parameters:

selector - Configuration selector. This parameter is treated case incensitively.

Returns:

List of SmooksResourceConfiguration instances, or null if no SmooksResourceConfigurations are defined under that selector (for the device).

See Also:

getObjects(String)

getSmooksResourceConfigurations

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

Get the SmooksResourceConfiguration map for the target execution context.

This Map will be preordered for the target execution context.

Returns:

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

getObjects

List getObjects(String selector)

Get a list of Objects from the SmooksResourceConfigurations specified by the selector.

Gets the SmooksResourceConfigurations specified for the selector and attempts to instanciate a Java class instance from the resource specified by each of the SmooksResourceConfigurations.

Implementations should use SmooksResourceConfigurationStore.getObject(org.milyn.cdr.SmooksResourceConfiguration) to construct each object.

Parameters:

selector - selector attribute value from the .cdrl file in the .cdrar. This parameter is treated case incensitively.

Returns:

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

See Also:

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

newFilter

Filter newFilter(ExecutionContext executionContext)

Get a new stream filter for the content delivery configuration.

Parameters:

executionContext - Execution context.

Returns:

The stream filter.

getDTD

DTDStore.DTDObjectContainer getDTD()

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

Returns:

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

getConfigBuilderEvents

List<ConfigBuilderEvent> getConfigBuilderEvents()

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

Returns:

The list of events.

isDefaultSerializationOn

boolean isDefaultSerializationOn()

Is default serialization on..

Returns:

True if default serialization is on, otherwise false.