com.mulesoft.tools.migration.step.util

Class XmlDslUtils

java.lang.Object

com.mulesoft.tools.migration.step.util.XmlDslUtils

public final class XmlDslUtils
extends Object

Provides reusable methods for common migration scenarios.

Since:

1.0.0

Author:

Mulesoft Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static org.jdom2.Namespace	CORE_EE_NAMESPACE
static String	CORE_EE_NS_URI
static org.jdom2.Namespace	CORE_NAMESPACE
static String	EE_NAMESPACE_NAME
static String	EE_NAMESPACE_SCHEMA

Method Summary

Modifier and Type	Method and Description
static void	addCompatibilityNamespace(org.jdom2.Document document) Add the required compatibility namespace declaration on document.
static void	addElementAfter(org.jdom2.Element newElement, org.jdom2.Element element) Add new element after some existing element.
static void	addElementBefore(org.jdom2.Element newElement, org.jdom2.Element element) Add new element before some existing element.
static void	addElementsAfter(Collection<? extends org.jdom2.Content> newElements, org.jdom2.Element element) Add new element after some existing element.
static void	addMigrationAttributeToElement(org.jdom2.Element element, org.jdom2.Attribute attribute)
static org.jdom2.Element	addOutboundPropertySetter(String propertyName, org.jdom2.Element element, ApplicationModel model, org.jdom2.Element after)
static void	addTopLevelElement(org.jdom2.Element element, org.jdom2.Document document) Add new top level element after all the existing ones.
static String	changeDefault(String oldDefaultValue, String newDefaultValue, String currentValue) Migrate a field for which the default value was changed.
static boolean	copyAttributeIfPresent(org.jdom2.Element source, org.jdom2.Element target, String attributeName)
static boolean	copyAttributeIfPresent(org.jdom2.Element source, org.jdom2.Element target, String attributeName, boolean removeSource)
static boolean	copyAttributeIfPresent(org.jdom2.Element source, org.jdom2.Element target, String sourceAttributeName, String targetAttributeName)
static boolean	copyAttributeIfPresent(org.jdom2.Element source, org.jdom2.Element target, String sourceAttributeName, String targetAttributeName, boolean removeSource)
static void	createErrorHandlerParent(org.jdom2.Element element)
static org.jdom2.Document	generateDocument(Path filePath) Return JDOM document from a file path.
static org.jdom2.Element	getFlow(org.jdom2.Element processor)
static org.jdom2.Element	getFlowExceptionHandlingElement(org.jdom2.Element flow)
static boolean	isErrorHanldingElement(org.jdom2.Element element)
static boolean	isMuleConfigFile(String fileName, Path appBasePath)
static boolean	isTopLevelElement(org.jdom2.Element element)
static void	migrateEnrichers(org.jdom2.Element object, ExpressionMigrator expressionMigrator, CompatibilityResolver<String> resolver, ApplicationModel model, MigrationReport report)
static void	migrateExpression(org.jdom2.Attribute attr, ExpressionMigrator exprMigrator) Assuming the value of attr is an expression, migrate it and update the value.
static void	migrateOperationStructure(ApplicationModel appModel, org.jdom2.Element object, MigrationReport report) Add the required compatibility elements to the flow for a migrated operation to work correctly.
static void	migrateOperationStructure(ApplicationModel appModel, org.jdom2.Element object, MigrationReport report, boolean outputsAttributes, ExpressionMigrator expressionMigrator, CompatibilityResolver resolver)
static void	migrateOperationStructure(ApplicationModel appModel, org.jdom2.Element object, MigrationReport report, boolean outputsAttributes, ExpressionMigrator expressionMigrator, CompatibilityResolver resolver, boolean consumeStreams) Add the required compatibility elements to the flow for a migrated operation to work correctly.
static void	migrateRedeliveryPolicyChildren(org.jdom2.Element redeliveryPolicy, MigrationReport report)
static void	migrateSourceStructure(ApplicationModel appModel, org.jdom2.Element object, MigrationReport report) Add the required compatibility elements to the flow for a migrated source to work correctly.
static void	migrateSourceStructure(ApplicationModel appModel, org.jdom2.Element object, MigrationReport report, boolean expectsOutboundProperties, boolean consumeStreams) Add the required compatibility elements to the flow for a migrated source to work correctly.
static org.jdom2.Element	setText(org.jdom2.Element element, String text) Sets the given text on the given element, wrapping it in a CDATA for readability if it contains special characters.

Methods inherited from class java.lang.Object

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

Field Detail

CORE_NAMESPACE

public static final org.jdom2.Namespace CORE_NAMESPACE

EE_NAMESPACE_NAME

public static final String EE_NAMESPACE_NAME

See Also:

Constant Field Values

CORE_EE_NS_URI

public static final String CORE_EE_NS_URI

See Also:

Constant Field Values

CORE_EE_NAMESPACE

public static final org.jdom2.Namespace CORE_EE_NAMESPACE

EE_NAMESPACE_SCHEMA

public static final String EE_NAMESPACE_SCHEMA

See Also:

Constant Field Values

Method Detail

setText

public static org.jdom2.Element setText(org.jdom2.Element element,
                                        String text)

Sets the given text on the given element, wrapping it in a CDATA for readability if it contains special characters.

Parameters:

element -

text -

Returns:

migrateExpression

public static void migrateExpression(org.jdom2.Attribute attr,
                                     ExpressionMigrator exprMigrator)

Assuming the value of attr is an expression, migrate it and update the value.

Parameters:

attr - the attribute containing the expression to migrate

exprMigrator - the migrator for the expressions

changeDefault

public static String changeDefault(String oldDefaultValue,
                                   String newDefaultValue,
                                   String currentValue)

Migrate a field for which the default value was changed.

Parameters:

oldDefaultValue -

newDefaultValue -

currentValue -

Returns:

the value to set in the new version, or null if currentValue is already the new default.

migrateSourceStructure

public static void migrateSourceStructure(ApplicationModel appModel,
                                          org.jdom2.Element object,
                                          MigrationReport report)

Add the required compatibility elements to the flow for a migrated source to work correctly.

migrateSourceStructure

public static void migrateSourceStructure(ApplicationModel appModel,
                                          org.jdom2.Element object,
                                          MigrationReport report,
                                          boolean expectsOutboundProperties,
                                          boolean consumeStreams)

Add the required compatibility elements to the flow for a migrated source to work correctly.

migrateOperationStructure

public static void migrateOperationStructure(ApplicationModel appModel,
                                             org.jdom2.Element object,
                                             MigrationReport report)

Add the required compatibility elements to the flow for a migrated operation to work correctly.

migrateOperationStructure

public static void migrateOperationStructure(ApplicationModel appModel,
                                             org.jdom2.Element object,
                                             MigrationReport report,
                                             boolean outputsAttributes,
                                             ExpressionMigrator expressionMigrator,
                                             CompatibilityResolver resolver)

migrateOperationStructure

public static void migrateOperationStructure(ApplicationModel appModel,
                                             org.jdom2.Element object,
                                             MigrationReport report,
                                             boolean outputsAttributes,
                                             ExpressionMigrator expressionMigrator,
                                             CompatibilityResolver resolver,
                                             boolean consumeStreams)

Add the required compatibility elements to the flow for a migrated operation to work correctly.

migrateEnrichers

public static void migrateEnrichers(org.jdom2.Element object,
                                    ExpressionMigrator expressionMigrator,
                                    CompatibilityResolver<String> resolver,
                                    ApplicationModel model,
                                    MigrationReport report)

addOutboundPropertySetter

public static org.jdom2.Element addOutboundPropertySetter(String propertyName,
                                                          org.jdom2.Element element,
                                                          ApplicationModel model,
                                                          org.jdom2.Element after)

migrateRedeliveryPolicyChildren

public static void migrateRedeliveryPolicyChildren(org.jdom2.Element redeliveryPolicy,
                                                   MigrationReport report)

addCompatibilityNamespace

public static void addCompatibilityNamespace(org.jdom2.Document document)

Add the required compatibility namespace declaration on document.

copyAttributeIfPresent

public static boolean copyAttributeIfPresent(org.jdom2.Element source,
                                             org.jdom2.Element target,
                                             String attributeName)

Parameters:

source - the element to remove the attribute from

target - the element to add the element to

attributeName - the name of the attribute to move from source to target

Returns:

true if the attribute was present on source, false otherwise

copyAttributeIfPresent

public static boolean copyAttributeIfPresent(org.jdom2.Element source,
                                             org.jdom2.Element target,
                                             String sourceAttributeName,
                                             String targetAttributeName)

Parameters:

source - the element to remove the attribute from

target - the element to add the element to

sourceAttributeName - the name of the attribute to remove from source

targetAttributeName - the name of the attribute to add to target

Returns:

true if the attribute was present on source, false otherwise

copyAttributeIfPresent

public static boolean copyAttributeIfPresent(org.jdom2.Element source,
                                             org.jdom2.Element target,
                                             String attributeName,
                                             boolean removeSource)

Parameters:

source - the element to remove the attribute from

target - the element to add the element to

attributeName - the name of the attribute to move from source to target

Returns:

true if the attribute was present on source, false otherwise

copyAttributeIfPresent

public static boolean copyAttributeIfPresent(org.jdom2.Element source,
                                             org.jdom2.Element target,
                                             String sourceAttributeName,
                                             String targetAttributeName,
                                             boolean removeSource)

Parameters:

source - the element to remove the attribute from

target - the element to add the element to

sourceAttributeName - the name of the attribute to remove from source

targetAttributeName - the name of the attribute to add to target

Returns:

true if the attribute was present on source, false otherwise

addElementBefore

public static void addElementBefore(org.jdom2.Element newElement,
                                    org.jdom2.Element element)

Add new element before some existing element.

Parameters:

newElement -

element -

addElementAfter

public static void addElementAfter(org.jdom2.Element newElement,
                                   org.jdom2.Element element)

Add new element after some existing element.

Parameters:

newElement -

element -

addElementsAfter

public static void addElementsAfter(Collection<? extends org.jdom2.Content> newElements,
                                    org.jdom2.Element element)

Add new element after some existing element.

Parameters:

newElement -

element -

getFlow

public static org.jdom2.Element getFlow(org.jdom2.Element processor)

isTopLevelElement

public static boolean isTopLevelElement(org.jdom2.Element element)

createErrorHandlerParent

public static void createErrorHandlerParent(org.jdom2.Element element)

addMigrationAttributeToElement

public static void addMigrationAttributeToElement(org.jdom2.Element element,
                                                  org.jdom2.Attribute attribute)

isErrorHanldingElement

public static boolean isErrorHanldingElement(org.jdom2.Element element)

getFlowExceptionHandlingElement

public static org.jdom2.Element getFlowExceptionHandlingElement(org.jdom2.Element flow)

addTopLevelElement

public static void addTopLevelElement(org.jdom2.Element element,
                                      org.jdom2.Document document)

Add new top level element after all the existing ones.

Parameters:

element -

document -

generateDocument

public static org.jdom2.Document generateDocument(Path filePath)
                                           throws org.jdom2.JDOMException,
                                                  IOException

Return JDOM document from a file path.

Parameters:

filePath -

Returns:

the jdom document.

Throws:

org.jdom2.JDOMException

IOException

isMuleConfigFile

public static boolean isMuleConfigFile(String fileName,
                                       Path appBasePath)