org.milyn.routing.io

Class OutputStreamRouter

java.lang.Object

org.milyn.routing.io.OutputStreamRouter

All Implemented Interfaces:

ContentHandler, DOMElementVisitor, DOMVisitAfter, DOMVisitBefore, DOMVisitor, Consumer, SAXVisitAfter, SAXVisitBefore, SAXVisitor, Visitor

@VisitAfterIf(condition="!parameters.containsKey(\'visitBefore\') || parameters.visitBefore.value != \'true\'")
 @VisitBeforeIf(condition="!parameters.containsKey(\'visitAfter\') || parameters.visitAfter.value != \'true\'")
public class OutputStreamRouter
extends Object
implements DOMElementVisitor, SAXVisitBefore, SAXVisitAfter, Consumer

OutputStreamRouter is a fragment Visitor (DOM/SAX) that can be used to route context beans (BeanContext beans) an OutputStream.

An OutputStreamRouter is used in combination with a concreate implementation of AbstractOutputStreamResource, for example a FileOutputStreamResource. Example configuration:

<resource-config selector="orderItem">
    <resource>org.milyn.routing.io.OutputStreamRouter</resource>
    <param name="resourceName">refToResource</param>
    <param name="beanId">orderItem</param>
</resource-config>

Description of configuration properties:

• beanId is key used search the execution context for the content to be written the OutputStream
• resourceName is a reference to a previously configured AbstractOutputStreamResource
• encoding is the encoding used when writing a characters to file

Since:

1.0

Author:

Daniel Bevenius

Constructor Summary

Constructors

Constructor and Description
OutputStreamRouter()

Method Summary

Modifier and Type	Method and Description
boolean	consumes(Object object) Does this consumer consume the specified named object.
String	getResourceName()
void	initialize()
void	visitAfter(Element element, ExecutionContext executionContext) Visit the supplied element after visiting its child elements.
void	visitAfter(SAXElement element, ExecutionContext executionContext) Visit the supplied element after visiting its child elements.
void	visitBefore(Element element, ExecutionContext executionContext) Visit the supplied element before visiting its child elements.
void	visitBefore(SAXElement element, ExecutionContext executionContext) Visit the supplied element before visiting its child elements.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputStreamRouter

public OutputStreamRouter()

Method Detail

initialize

@Initialize
public void initialize()
                            throws SmooksConfigurationException

Throws:

SmooksConfigurationException

consumes

public boolean consumes(Object object)

Description copied from interface: Consumer

Does this consumer consume the specified named object.

The named object would be a product of a Producer that is executing on the same element. The consumer should only return false if it knows for certain that it doesn't consumer the specified named object. If uncertain, it should error on the side of saying that it does consume the object.

Specified by:

consumes in interface Consumer

Parameters:

object - The product representation

Returns:

True if the consumer consumes the specified product, otherwise false.

visitBefore

public void visitBefore(Element element,
                        ExecutionContext executionContext)
                 throws SmooksException

Description copied from interface: DOMVisitBefore

Visit the supplied element before visiting its child elements.

Specified by:

visitBefore in interface DOMVisitBefore

Parameters:

element - The DOM element being visited.

executionContext - Request relative instance.

Throws:

SmooksException - Element processing failure.

visitAfter

public void visitAfter(Element element,
                       ExecutionContext executionContext)
                throws SmooksException

Description copied from interface: DOMVisitAfter

Visit the supplied element after visiting its child elements.

Specified by:

visitAfter in interface DOMVisitAfter

Parameters:

element - The DOM element being visited.

executionContext - Request relative instance.

Throws:

SmooksException - Element processing failure.

visitBefore

public void visitBefore(SAXElement element,
                        ExecutionContext executionContext)
                 throws SmooksException,
                        IOException

Description copied from interface: SAXVisitBefore

Visit the supplied element before visiting its child elements.

Specified by:

visitBefore in interface SAXVisitBefore

Parameters:

element - The SAX element being visited.

executionContext - Execution context.

Throws:

SmooksException - Event processing failure.

IOException - Error writing event to output writer.

visitAfter

public void visitAfter(SAXElement element,
                       ExecutionContext executionContext)
                throws SmooksException,
                       IOException

Description copied from interface: SAXVisitAfter

Visit the supplied element after visiting its child elements.

Specified by:

visitAfter in interface SAXVisitAfter

Parameters:

element - The SAX element being visited.

executionContext - Execution context.

Throws:

SmooksException - Event processing failure.

IOException - Error writing event to output writer.

getResourceName

public String getResourceName()