Package org.broadleafcommerce.common.extensibility.context.merge

Class MergeManager

java.lang.Object

org.broadleafcommerce.common.extensibility.context.merge.MergeManager

public class MergeManager
extends Object

This class manages all xml merge interactions with callers. It is responsible for not only loading the handler configurations, but also for cycling through the handlers in a prioritized fashion and exporting the final merged document.

Author:

jfischer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MERGE_DEFINITION_SYSTEM_PROPERTY	Additional merge points may be added by the caller.

Constructor Summary

Constructors

Constructor	Description
MergeManager()

Method Summary

Modifier and Type	Method	Description
ResourceInputStream	merge(ResourceInputStream stream1, ResourceInputStream stream2)	Merge 2 xml document streams together into a final resulting stream.
protected void	removeItemsMatchingKey(String firstKey, Properties props)	Removes all keys that share the same number.
protected void	removeSkipMergeComponents(Properties props, String componentName)	Examines the properties file for an entry with an id equal to the component that we want to ignore and then removes all keys that have the same number (e.g. if xpath.28 is the key then handler.28, xpath.28, and priority.28 will all be removed).
protected void	removeSkippedMergeComponents(Properties props)
String	serialize(InputStream in)
protected void	setHandlers(Properties props)

Methods inherited from class java.lang.Object

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

Field Details

MERGE_DEFINITION_SYSTEM_PROPERTY

public static final String MERGE_DEFINITION_SYSTEM_PROPERTY

Additional merge points may be added by the caller. Also default merge points may be overriden to change their current behavior. This is accomplished by specifying the system property denoted by the key MergeManager.MERGE_DEFINITION_SYSTEM_PROPERTY with a value stating the fully qualified path of user-created property file. Please refer to the default properties file located at org/broadleafcommerce/profile/extensibility/context/merge/default.properties for more details.

See Also:

• Constant Field Values

Constructor Details

MergeManager

public MergeManager()
             throws MergeManagerSetupException

Throws:

MergeManagerSetupException

Method Details

removeSkippedMergeComponents

protected void removeSkippedMergeComponents(Properties props)
                                     throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

removeSkipMergeComponents

protected void removeSkipMergeComponents(Properties props,
 String componentName)

Examines the properties file for an entry with an id equal to the component that we want to ignore and then removes all keys that have the same number (e.g. if xpath.28 is the key then handler.28, xpath.28, and priority.28 will all be removed).

Parameters:

props -

componentName -

removeItemsMatchingKey

protected void removeItemsMatchingKey(String firstKey,
 Properties props)

Removes all keys that share the same number. (e.g. if xpath.28 is the key then handler.28, xpath.28, and priority.28 will all be removed).

Parameters:

firstKey -

props -

merge

public ResourceInputStream merge(ResourceInputStream stream1,
 ResourceInputStream stream2)
                          throws MergeException

Merge 2 xml document streams together into a final resulting stream. During the merge, various merge business rules are followed based on configuration defined for various merge points.

Parameters:

stream1 -

stream2 -

Returns:

the stream representing the merged document

Throws:

MergeException

setHandlers

protected void setHandlers(Properties props)
                    throws ClassNotFoundException,
IllegalAccessException,
InstantiationException

Throws:

ClassNotFoundException

IllegalAccessException

InstantiationException

serialize

public String serialize(InputStream in)