org.milyn.routing.basic

Class FragmentSerializer

java.lang.Object

org.milyn.routing.basic.FragmentSerializer

All Implemented Interfaces:

ContentHandler, DOMVisitAfter, DOMVisitBefore, DOMVisitor, Producer, SAXVisitAfter, SAXVisitBefore, SAXVisitor, VisitLifecycleCleanable, Visitor

public class FragmentSerializer
extends Object
implements SAXVisitBefore, SAXVisitAfter, DOMVisitBefore, DOMVisitAfter, Producer, VisitLifecycleCleanable

Basic message fragment serializer.

Author:

tom.fennelly@jboss.com

Constructor Summary

Constructors

Constructor and Description
FragmentSerializer()

Method Summary

Modifier and Type	Method and Description
void	executeVisitLifecycleCleanup(Fragment fragment, ExecutionContext executionContext) Cleanup the resources allocated by this resource for the specified ExecutionContext.
Set<? extends Object>	getProducts() Get the set of products produced by this producer instance.
FragmentSerializer	setBindTo(String bindTo) Set the bind-to beanId for the serialized fragment.
FragmentSerializer	setChildContentOnly(boolean childContentOnly) Set whether or not the child content only should be serialized.
FragmentSerializer	setOmitXMLDeclaration(boolean omitXMLDeclaration) Omit the XML Declaration from the serialized fragments.
FragmentSerializer	setRetain(boolean retain) Retain the fragment bean in the BeanContext after it's creating fragment has been processed.
void	visitAfter(Element element, ExecutionContext executionContext) Visit the supplied element after visiting its child elements.
void	visitAfter(SAXElement saxElement, 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 saxElement, 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

FragmentSerializer

public FragmentSerializer()

Method Detail

setBindTo

@ConfigParam
public FragmentSerializer setBindTo(String bindTo)

Set the bind-to beanId for the serialized fragment.

Parameters:

bindTo - The bind-to beanId for the serialized fragment.

Returns:

this instance.

setOmitXMLDeclaration

@ConfigParam(defaultVal="false")
public FragmentSerializer setOmitXMLDeclaration(boolean omitXMLDeclaration)

Omit the XML Declaration from the serialized fragments.

Parameters:

omitXMLDeclaration - True if the XML declaration is to be omitted, otherwise false.

Returns:

this instance.

setChildContentOnly

@ConfigParam(defaultVal="false")
public FragmentSerializer setChildContentOnly(boolean childContentOnly)

Set whether or not the child content only should be serialized.

This variable is, by default, false.

Parameters:

childContentOnly - True if the child content only (exclude the targeted element itself), otherwise false.

Returns:

this instance.

setRetain

@ConfigParam(defaultVal="false")
public FragmentSerializer setRetain(boolean retain)

Retain the fragment bean in the BeanContext after it's creating fragment has been processed.

Parameters:

retain - True if the fragment bean is to be retained in the BeanContext, otherwise false.

Returns:

this instance.

getProducts

public Set<? extends Object> getProducts()

Description copied from interface: Producer

Get the set of products produced by this producer instance.

Specified by:

getProducts in interface Producer

Returns:

The set the set of products produced by this producer instance.

visitBefore

public void visitBefore(SAXElement saxElement,
                        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:

saxElement - 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 saxElement,
                       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:

saxElement - The SAX element being visited.

executionContext - Execution context.

Throws:

SmooksException - Event processing failure.

IOException - Error writing event to output writer.

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.

executeVisitLifecycleCleanup

public void executeVisitLifecycleCleanup(Fragment fragment,
                                         ExecutionContext executionContext)

Description copied from interface: VisitLifecycleCleanable

Cleanup the resources allocated by this resource for the specified ExecutionContext.

Executes the cleanup at the end of the fragment visit.

Specified by:

executeVisitLifecycleCleanup in interface VisitLifecycleCleanable

Parameters:

fragment - The fragment.

executionContext - The ExecutionContext.