Package org.smooks

Class Smooks

java.lang.Object

org.smooks.Smooks

All Implemented Interfaces:

Closeable, AutoCloseable

@ThreadSafe
public class Smooks
extends Object
implements Closeable

Smooks executor class.

Additional configurations can be carried out on the Smooks instance through the SmooksUtil class.

The basic usage scenario for this class might be as follows:

1. Develop (or reuse) an implementation of ElementVisitor to perform some transformation/analysis operation on a message. There are a number of prebuilt and reuseable implemntations available as "Smooks Cartridges".
2. Write a resource configuration to target the ElementVisitor implementation at the target fragment of the message being processed.
3. Apply the logic as follows:

    Smooks smooks = new Smooks("smooks-config.xml");
    ExecutionContext execContext;
   
    execContext = smooks.createExecutionContext();
    smooks.filter(new StreamSource(...), new StreamResult(...), execContext);
    

Remember, you can implement and apply multiple ElementVisitor within the context of a single filtering operation. You can also target DOMElementVisitors/ElementVisitor based on target profiles, and so use a single configuration to process multiple messages by sharing profiles across your message set.

See Smooks Tutorials.

Author:

tom.fennelly@gmail.com

Constructor Summary

Constructors

Constructor	Description
Smooks()	Public Default Constructor.
Smooks(InputStream resourceConfigStream)	Public constructor.
Smooks(String resourceURI)	Public constructor.
Smooks(ApplicationContext applicationContext)	Public Default Constructor.

Method Summary

Modifier and Type	Method	Description
void	addConfiguration(ResourceConfig resourceConfig)	Add a resource configuration to this Smooks instance.
void	addConfigurations(InputStream resourceConfigStream)	Add a set of resource configurations to this Smooks instance.
void	addConfigurations(String resourceURI)	Add a set of resource configurations to this Smooks instance.
void	addConfigurations(String baseURI, InputStream resourceConfigStream)	Add a set of resource configurations to this Smooks instance.
ResourceConfig	addVisitor(Visitor visitor)	Add a visitor instance to this Smooks instance.
ResourceConfig	addVisitor(Visitor visitor, String targetSelector)	Add a visitor instance to this Smooks instance.
ResourceConfig	addVisitor(Visitor visitor, String targetSelector, String targetSelectorNS)	Deprecated.
void	addVisitors(VisitorAppender visitorAppender)	Adds a Visitor to this Smooks via a VisitorAppender.
void	close()	Close this Smooks instance and all associated resources.
ExecutionContext	createExecutionContext()	Create a ExecutionContext instance for use on this Smooks instance.
ExecutionContext	createExecutionContext(String targetProfile)	Create a ExecutionContext instance for use on this Smooks instance.
void	filterSource(Source source)	Filter the content in the supplied Source instance.
void	filterSource(Source source, Result... results)	Filter the content in the supplied Source instance, outputing data to the supplied Result instances.
void	filterSource(ExecutionContext executionContext, Source source, Result... results)	Filter the content in the supplied Source instance, outputing data to the supplied Result instances.
ApplicationContext	getApplicationContext()	Get the Smooks ApplicationContext associated with this Smooks instance.
Smooks	setExports(Exports exports)	Set the Exports for this Smooks instance.
void	setFilterSettings(FilterSettings filterSettings)	Set the filter settings for this Smooks instance.
void	setNamespaces(Properties namespaces)	Set the namespace prefix-to-uri mappings to be used on this Smooks instance.
void	setReaderConfig(ReaderConfigurator readerConfigurator)	Set the configuration for the reader to be used on this Smooks instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Smooks

public Smooks()

Public Default Constructor.

Resource configurations can be added through calls to addConfigurations(String) or addConfigurations(String,java.io.InputStream).

Smooks

public Smooks(ApplicationContext applicationContext)

Public Default Constructor.

Resource configurations can be added through calls to addConfigurations(String) or addConfigurations(String,java.io.InputStream).

Smooks

public Smooks(String resourceURI)
       throws IOException,
              SAXException

Public constructor.

Adds the set of resources via the addConfigurations(String) method, which resolves the resourceURI parameter using a URIResourceLocator.

Additional resource configurations can be added through calls to addConfigurations(String) or addConfigurations(String,java.io.InputStream).

Parameters:

resourceURI - XML resource configuration stream URI.

Throws:

IOException - Error reading resource stream.

SAXException - Error parsing the resource stream.

See Also:

ResourceConfig

Smooks

public Smooks(InputStream resourceConfigStream)
       throws IOException,
              SAXException

Public constructor.

Adds the set of resources via the addConfigurations(java.io.InputStream).

Additional resource configurations can be added through calls to addConfigurations method set.

Parameters:

resourceConfigStream - XML resource configuration stream.

Throws:

IOException - Error reading resource stream.

SAXException - Error parsing the resource stream.

See Also:

ResourceConfig

Method Detail

setFilterSettings

public void setFilterSettings(FilterSettings filterSettings)

Set the filter settings for this Smooks instance.

Parameters:

filterSettings - The filter settings to be used.

setExports

public Smooks setExports(Exports exports)

Set the Exports for this Smooks instance.

Parameters:

exports - The exports that will be created by this Smooks instance.

setReaderConfig

public void setReaderConfig(ReaderConfigurator readerConfigurator)

Set the configuration for the reader to be used on this Smooks instance.

Parameters:

readerConfigurator - ReaderConfigurator instance.

setNamespaces

public void setNamespaces(Properties namespaces)

Set the namespace prefix-to-uri mappings to be used on this Smooks instance.

Parameters:

namespaces - The namespace prefix-to-uri mappings.

addVisitor

public ResourceConfig addVisitor(Visitor visitor)

Add a visitor instance to this Smooks instance.

This Visitor will be targeted at the root (#document) fragment.

Parameters:

visitor - The visitor implementation.

addVisitor

public ResourceConfig addVisitor(Visitor visitor,
                                 String targetSelector)

Add a visitor instance to this Smooks instance.

Parameters:

visitor - The visitor implementation.

targetSelector - The message fragment target selector.

addVisitor

@Deprecated
public ResourceConfig addVisitor(Visitor visitor,
                                 String targetSelector,
                                 String targetSelectorNS)

Deprecated.

Add a visitor instance to this Smooks instance.

Parameters:

visitor - The visitor implementation.

targetSelector - The message fragment target selector.

targetSelectorNS - The message fragment target selector namespace.

addVisitors

public void addVisitors(VisitorAppender visitorAppender)

Adds a Visitor to this Smooks via a VisitorAppender.

Parameters:

visitorAppender - the VisitorAppender

addConfiguration

public void addConfiguration(ResourceConfig resourceConfig)

Add a resource configuration to this Smooks instance.

These configurations do not overwrite previously added configurations. They are added to the list of configurations on this Smooks instance.

Parameters:

resourceConfig - The resource configuration to be added.

addConfigurations

public void addConfigurations(String resourceURI)
                       throws IOException,
                              SAXException

Add a set of resource configurations to this Smooks instance.

Uses the URIResourceLocator class to load the resource.

These configurations do not overwrite previously added configurations. They are added to the list of configurations on this Smooks instance.

Parameters:

resourceURI - The URI string for the resource configuration list. See URIResourceLocator.

Throws:

IOException - Error reading resource stream.

SAXException - Error parsing the resource stream.

addConfigurations

public void addConfigurations(String baseURI,
                              InputStream resourceConfigStream)
                       throws SAXException,
                              IOException

Add a set of resource configurations to this Smooks instance.

These configurations do not overwrite previously added configurations. They are added to the list of configurations on this Smooks instance.

The base URI is required for resolving resource imports. Just specify the location of the resource file.

Parameters:

baseURI - The base URI string for the resource configuration list. See URIResourceLocator.

resourceConfigStream - The resource configuration stream.

Throws:

IOException - Error reading resource stream.

SAXException - Error parsing the resource stream.

addConfigurations

public void addConfigurations(InputStream resourceConfigStream)
                       throws SAXException,
                              IOException

Add a set of resource configurations to this Smooks instance.

Calls addConfigurations(String, java.io.InputStream) with a baseURI of "./", which is the default base URI on all URIResourceLocator instances.

Parameters:

resourceConfigStream - The resource configuration stream.

Throws:

IOException - Error reading resource stream.

SAXException - Error parsing the resource stream.

createExecutionContext

public ExecutionContext createExecutionContext()

Create a ExecutionContext instance for use on this Smooks instance.

The created context is profile agnostic and should be used where profile based targeting is not in use.

The context returned from this method is used in subsequent calls to filterSource(ExecutionContext, javax.xml.transform.Source, javax.xml.transform.Result...) It allows access to the execution context instance before and after calls on this method. This means the caller has an opportunity to set and get data bound to the execution context (before and after the calls), providing the caller with a mechanism for interacting with the content filtering phases.

Returns:

Execution context instance.

createExecutionContext

public ExecutionContext createExecutionContext(String targetProfile)
                                        throws UnknownProfileMemberException

Create a ExecutionContext instance for use on this Smooks instance.

The created context is profile aware and should be used where profile based targeting is in use. In this case, the transfromation/analysis resources must be configured with profile targeting information.

The context returned from this method is used in subsequent calls to filterSource(ExecutionContext, javax.xml.transform.Source, javax.xml.transform.Result...). It allows access to the execution context instance before and after calls on this method. This means the caller has an opportunity to set and get data bound to the execution context (before and after the calls), providing the caller with a mechanism for interacting with the content filtering phases.

Parameters:

targetProfile - The target profile (base profile) on behalf of whom the filtering/serialisation filter is to be executed.

Returns:

Execution context instance.

Throws:

UnknownProfileMemberException - Unknown target profile.

filterSource

public void filterSource(Source source)
                  throws SmooksException

Filter the content in the supplied Source instance.

Not producing a Result.

Parameters:

source - The content Source.

Throws:

SmooksException - Failed to filter.

filterSource

public void filterSource(Source source,
                         Result... results)
                  throws SmooksException

Filter the content in the supplied Source instance, outputing data to the supplied Result instances.

Parameters:

source - The filter Source.

results - The filter Results.

Throws:

SmooksException - Failed to filter.

filterSource

public void filterSource(ExecutionContext executionContext,
                         Source source,
                         Result... results)
                  throws SmooksException

Filter the content in the supplied Source instance, outputing data to the supplied Result instances.

Parameters:

executionContext - The ExecutionContext for this filter operation. See createExecutionContext(String).

source - The filter Source.

results - The filter Results.

Throws:

SmooksException - Failed to filter.

getApplicationContext

public ApplicationContext getApplicationContext()

Get the Smooks ApplicationContext associated with this Smooks instance.

Returns:

The Smooks ApplicationContext.

close

public void close()

Close this Smooks instance and all associated resources.

Should result in the uninitialization of all allocated ContentHandler instances.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable