org.milyn.cdr

Class SmooksResourceConfigurationStore

java.lang.Object

org.milyn.cdr.SmooksResourceConfigurationStore

public class SmooksResourceConfigurationStore
extends Object

SmooksResourceConfiguration context store.

Stores the SmooksResourceConfigurations for a given container context in the form of SmooksResourceConfigurationList entries. Also maintains a "default" config list for the context.

Author:

tfennelly

Constructor Summary

Constructors

Constructor and Description
SmooksResourceConfigurationStore(ApplicationContext applicationContext) Public constructor.
SmooksResourceConfigurationStore(ApplicationContext applicationContext, boolean registerInstalledResources)

Method Summary

Modifier and Type	Method and Description
void	addSmooksResourceConfigurationList(SmooksResourceConfigurationList resourceList) Add a SmooksResourceConfigurationList to this store.
void	close() Close this resource configuration store, uninitializing all ContentHandlers allocated from this store instance.
ContentHandlerFactory	getContentHandlerFactory(String type) Get the ContentHandlerFactory for a resource based on the supplied resource type.
SmooksResourceConfiguration	getGlobalParams()
List<Object>	getInitializedObjects()
Object	getObject(SmooksResourceConfiguration resourceConfig) Load a Java Object defined by the supplied SmooksResourceConfiguration instance.
Iterator<SmooksResourceConfigurationList>	getSmooksResourceConfigurationLists() Get all the added SmooksResourceConfigurationList instances added on this store.
SmooksResourceConfiguration[]	getSmooksResourceConfigurations(ProfileSet profileSet) Get all the SmooksResourceConfiguration entries registered on this context store for the specified profile set.
SmooksResourceConfigurationList	getUserDefinedResourceList()
void	load(BufferedReader cdrlLoadList) Load all .cdrl files listed in the BufferedReader stream.
List<SmooksResourceConfiguration>	lookupResource(ConfigSearch configSearch)
void	registerResource(SmooksResourceConfiguration resourceConfig) Register a SmooksResourceConfiguration on this context store.
SmooksResourceConfigurationList	registerResources(String baseURI, InputStream resourceConfigStream) Register the set of resources specified in the supplied XML configuration stream.
void	removeShutdownHook() Deprecated. Smooks no longer uses shutdown hooks. The containing application is responsible for calling Smooks.close().
void	setNamespaces()

Methods inherited from class java.lang.Object

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

Constructor Detail

SmooksResourceConfigurationStore

public SmooksResourceConfigurationStore(ApplicationContext applicationContext)

Public constructor.

Parameters:

applicationContext - Container context in which this store lives.

SmooksResourceConfigurationStore

public SmooksResourceConfigurationStore(ApplicationContext applicationContext,
                                        boolean registerInstalledResources)

Method Detail

removeShutdownHook

public void removeShutdownHook()

Deprecated. Smooks no longer uses shutdown hooks. The containing application is responsible for calling Smooks.close().

Remove the shutdown hook associated with this store instance.

load

public void load(BufferedReader cdrlLoadList)
          throws IOException

Load all .cdrl files listed in the BufferedReader stream.

Because this method uses the ContainerResourceLocator it may be possible to load external cdrl files. If the ContainerResourceLocator is a ServletResourceLocator the lines in the BufferedReader param can contain external URLs.

Parameters:

cdrlLoadList - BufferedReader cdrl list - one cdrl def per line.

Throws:

IOException - Error reading list buffer.

registerResources

public SmooksResourceConfigurationList registerResources(String baseURI,
                                                         InputStream resourceConfigStream)
                                                  throws SAXException,
                                                         IOException,
                                                         URISyntaxException

Register the set of resources specified in the supplied XML configuration stream.

Parameters:

baseURI - The base URI to be associated with the configuration stream.

resourceConfigStream - XML resource configuration stream.

Returns:

The SmooksResourceConfigurationList created from the added resource configuration.

Throws:

SAXException - Error parsing the resource stream.

IOException - Error reading resource stream.

URISyntaxException

See Also:

SmooksResourceConfiguration

registerResource

public void registerResource(SmooksResourceConfiguration resourceConfig)

Register a SmooksResourceConfiguration on this context store.

The config gets added to the default resource list.

Parameters:

resourceConfig - The Content Delivery Resource definition to be registered.

addSmooksResourceConfigurationList

public void addSmooksResourceConfigurationList(SmooksResourceConfigurationList resourceList)

Add a SmooksResourceConfigurationList to this store.

Parameters:

resourceList - All the SmooksResourceConfigurationList instances added on this store.

getSmooksResourceConfigurationLists

public Iterator<SmooksResourceConfigurationList> getSmooksResourceConfigurationLists()

Get all the added SmooksResourceConfigurationList instances added on this store.

Returns:

All the SmooksResourceConfigurationList instances added on this store.

getSmooksResourceConfigurations

public SmooksResourceConfiguration[] getSmooksResourceConfigurations(ProfileSet profileSet)

Get all the SmooksResourceConfiguration entries registered on this context store for the specified profile set.

Parameters:

profileSet - The profile set against which to lookup.

Returns:

All SmooksResourceConfiguration entries targeted at the specified useragent.

getObject

public Object getObject(SmooksResourceConfiguration resourceConfig)

Load a Java Object defined by the supplied SmooksResourceConfiguration instance.

Parameters:

resourceConfig - SmooksResourceConfiguration instance.

Returns:

An Object instance from the SmooksResourceConfiguration.

getInitializedObjects

public List<Object> getInitializedObjects()

getGlobalParams

public SmooksResourceConfiguration getGlobalParams()

getContentHandlerFactory

public ContentHandlerFactory getContentHandlerFactory(String type)
                                               throws UnsupportedContentHandlerTypeException

Get the ContentHandlerFactory for a resource based on the supplied resource type.

Note that ContentHandlerFactory implementations must be configured under a selector value of "cdu-creator".

Parameters:

type - ContentHandlerFactory type e.g. "class", "xsl" etc.

Returns:

ContentHandlerFactory for the resource.

Throws:

UnsupportedContentHandlerTypeException - No ContentHandlerFactory registered for the specified resource type.

close

public void close()

Close this resource configuration store, uninitializing all ContentHandlers allocated from this store instance.

setNamespaces

public void setNamespaces()
                   throws org.jaxen.saxpath.SAXPathException

Throws:

org.jaxen.saxpath.SAXPathException

lookupResource

public List<SmooksResourceConfiguration> lookupResource(ConfigSearch configSearch)

getUserDefinedResourceList

public SmooksResourceConfigurationList getUserDefinedResourceList()