`<perform>` syntax

Operations available in the perform section of the rule include the classification of application resources, in-line hints for migration steps, links to migration information, and project lineitem reporting. Because XML rules are modeled after the Java-based rule add-ons, links to JavaDocs for the related Java classes are provided for a better understanding of how they behave.

You can view the complete XML rule schema.

The following sections describe the more common XML rule perform actions.

<classification> syntax

Summary

The <classification> element is used to identify or classify application resources that match the rule. It provides a title that is displayed in the report, a level of effort, and it can also provide links to additional information about how to migrate this resource classification. For a better understanding of the <classification> action, see the JavaDoc for the Classification class.

The following is an example of a rule that classifies a resource as a WebLogic EAR application deployment descriptor file.

<rule id="XmlWebLogicRules_10vvyf">
    <when>
        <xmlfile as="default" matches="/*[local-name()='weblogic-application']"></xmlfile>
    </when>
    <perform>
        <iteration>
            <classification title="Weblogic EAR Application Descriptor" effort="3"/>
        </iteration>
    </perform>
</rule>

<classification> element attributes

Attribute name Type Description

Attribute name	Type	Description
title	STRING	The title given to this resource. This attribute is required. title="JBoss Seam Components"
effort	BYTE	The level of effort assigned to this resource. effort="2"
category-id	STRING	A reference to a category as defined in `{ProductShortName}_HOME/rules/migration-core/core.windup.categories.xml`. The default categories are `mandatory`, `optional`, `potential`, and `information`. category-id="mandatory"
of	VARIABLE_NAME	Create a new classification for the given reference. of="MySeamRule"

title

STRING

The title given to this resource. This attribute is required.

title="JBoss Seam Components"

effort

BYTE

The level of effort assigned to this resource.

effort="2"

category-id

STRING

A reference to a category as defined in {ProductShortName}_HOME/rules/migration-core/core.windup.categories.xml. The default categories are mandatory, optional, potential, and information.

category-id="mandatory"

VARIABLE_NAME

Create a new classification for the given reference.

of="MySeamRule"

<classification> child elements

Child element Description

Child element	Description
<link>	Provides a link URI and text title for additional information. `<classification title="Websphere Startup Service" effort="4"> <link href="http://docs.oracle.com/javaee/6/api/javax/ejb/Singleton.html" title="EJB3.1 Singleton Bean"/> <link href="http://docs.oracle.com/javaee/6/api/javax/ejb/Startup.html" title="EJB3.1 Startup Bean"/> </classification>`
<tag>	Provides additional custom information for the classification. `<tag>Seam3</tag>`
<description>	Description of this resource `<description>JBoss Seam components must be replaced</description>`

<link>

Provides a link URI and text title for additional information.

<classification title="Websphere Startup Service" effort="4">
   <link href="http://docs.oracle.com/javaee/6/api/javax/ejb/Singleton.html" title="EJB3.1 Singleton Bean"/>
   <link href="http://docs.oracle.com/javaee/6/api/javax/ejb/Startup.html" title="EJB3.1 Startup Bean"/>
</classification>

<tag>

Provides additional custom information for the classification.

<tag>Seam3</tag>

Description of this resource

<description>JBoss Seam components must be replaced</description>

<link> syntax

Summary

The <link> element is used in classifications or hints to provide links to informational content. For a better understanding of the <link> action, see the JavaDoc for the Link class.

The following is an example of a rule that creates links to additional information.

<rule id="SeamToCDIRules_2fmb">
    <when>
        <javaclass references="org.jboss.seam.{*}" as="default"/>
    </when>
    <perform>
        <iteration>
            <classification title="SEAM Component" effort="1">
                <link href="http://www.seamframework.org/Seam3/Seam2ToSeam3MigrationNotes" title="Seam 2 to Seam 3 Migration Notes"/>
                <link href="http://docs.jboss.org/weld/reference/latest/en-US/html/example.html" title="JSF Web Application Example"/>
                <link href="http://docs.jboss.org/weld/reference/latest/en-US/html/contexts.html" title="JBoss Context Documentation"/>
                <link href="http://www.andygibson.net/blog/tutorial/cdi-conversations-part-2/" title="CDI Conversations Blog Post"/>
            </classification>
        </iteration>
    </perform>
</rule>

<link> element attributes

Attribute Name	Type	Description
href	URI	The URI for the referenced link. href="https://access.redhat.com/articles/1249423"
title	STRING	A title for the link. title="Migrate WebLogic Proprietary Servlet Annotations"

Attribute Name

Type

Description

href

URI

The URI for the referenced link.

href="https://access.redhat.com/articles/1249423"

title

STRING

A title for the link.

title="Migrate WebLogic Proprietary Servlet Annotations"

<hint> syntax

Summary

The <hint> element is used to provide a hint or inline information about how to migrate a section of code. For a better understanding of the <hint> action, see the JavaDoc for the Hint class.

The following is an example of a rule that creates a hint.

<rule id="WebLogicWebServiceRules_8jyqn">
    <when>
        <javaclass references="weblogic.wsee.connection.transport.http.HttpTransportInfo.setUsername({*})" as="default">
            <location>METHOD</location>
        </javaclass>
    </when>
    <perform>
        <iteration>
            <hint title="Proprietary web-service" category-id="mandatory" effort="3">
                <message>Replace proprietary web-service authentication with JAX-WS standards.</message>
                <link href="http://java-x.blogspot.com/2009/03/invoking-web-services-through-proxy.html" title="JAX-WS Proxy Password Example"/>
            </hint>
        </iteration>
    </perform>
</rule>

<hint> element attributes

Attribute name Type Description

Attribute name	Type	Description
title	STRING	Title this hint using the specified string. This attribute is required. title="JBoss Seam Component Hint"
category-id	STRING	A reference to a category as defined in `{ProductShortName}_HOME/rules/migration-core/core.windup.categories.xml`. The default categories are `mandatory`, `optional`, `potential`, and `information`. category-id="mandatory"
in	VARIABLE_NAME	Create a new Hint in the FileLocationModel resolved by the given variable. in="Foo"
effort	BYTE	The level of effort assigned to this resource. effort="2"

title

STRING

Title this hint using the specified string. This attribute is required.

title="JBoss Seam Component Hint"

category-id

STRING

A reference to a category as defined in {ProductShortName}_HOME/rules/migration-core/core.windup.categories.xml. The default categories are mandatory, optional, potential, and information.

category-id="mandatory"

VARIABLE_NAME

Create a new Hint in the FileLocationModel resolved by the given variable.

in="Foo"

effort

BYTE

The level of effort assigned to this resource.

effort="2"

<hint> child elements

Child element Description

Child element	Description
<message>	A message describing the migration hint. `<message>EJB 2.0 is deprecated</message>`
<link>	Identify or classify links to informational content. `<link href="http://docs.oracle.com/javaee/6/api/" title="Java Platform, Enterprise Edition 6 API Specification" />`
<tag>	Define a custom tag for this `hint`. `<tag>Needs review</tag>`
<quickfix>	Contains information to be used by the {PluginName} to perform quick fixes when the rule condition is met. `<quickfix name="slink-qf" type="REPLACE"> <replacement>h:link</replacement> <search>s:link</search> </quickfix>`

A message describing the migration hint.

<message>EJB 2.0 is deprecated</message>

<link>

Identify or classify links to informational content.

<link href="http://docs.oracle.com/javaee/6/api/" title="Java Platform, Enterprise Edition 6
API Specification" />

<tag>

Define a custom tag for this hint.

<tag>Needs review</tag>

Contains information to be used by the {PluginName} to perform quick fixes when the rule condition is met.

<quickfix name="slink-qf" type="REPLACE">
    <replacement>h:link</replacement>
    <search>s:link</search>
</quickfix>

<xslt> syntax

Summary

The <xslt> element specifies how to transform an XML file. For a better understanding of the <xslt> action, see the JavaDoc for the XSLTTransformation class.

The following is an example of rule that defines an XSLT action.

<rule id="XmlWebLogicRules_6bcvk">
    <when>
        <xmlfile as="default" matches="/weblogic-ejb-jar"/>
    </when>
    <perform>
        <iteration>
            <classification title="Weblogic EJB XML" effort="3"/>
            <xslt title="JBoss EJB Descriptor (Windup-Generated)" template="transformations/xslt/weblogic-ejb-to-jboss.xsl" extension="-jboss.xml"/>
        </iteration>
    </perform>
</rule>

<xslt> element attributes

Attribute Name	Type	Description
title	STRING	Sets the title for this XSLTTransformation in the report. This attribute is required. title="XSLT Transformed Output"
of	STRING	Create a new transformation for the given reference. of="testVariable_instance"
extension	STRING	Sets the extension for this XSLTTransformation. This attribute is required. extension="-result.html"
template	STRING	Sets the XSL template. This attribute is required. template="simpleXSLT.xsl"
effort	BYTE	The level of effort required for the transformation.

Attribute Name

Type

Description

title

STRING

Sets the title for this XSLTTransformation in the report. This attribute is required.

title="XSLT Transformed Output"

STRING

Create a new transformation for the given reference.

of="testVariable_instance"

extension

STRING

Sets the extension for this XSLTTransformation. This attribute is required.

extension="-result.html"

template

STRING

Sets the XSL template. This attribute is required.

template="simpleXSLT.xsl"

effort

BYTE

The level of effort required for the transformation.

<xslt> child elements

Child element Description

Child element	Description
<xslt-parameter>	Specify XSLTTransformation parameters as property value pairs `<xslt-parameter property="title" value="EJB Transformation"/>`

<xslt-parameter>

Specify XSLTTransformation parameters as property value pairs

<xslt-parameter property="title" value="EJB Transformation"/>

<lineitem> syntax

Summary

The <lineitem> element is used to provide general migration requirements for the application, such as the need to replace deprecated libraries or the need to resolve potential class loading issues. This information is displayed on the project or application overview page. For a better understanding of the <lineitem> action, see the JavaDoc for the LineItem class.

The following is an example of a rule that creates a lineitem message.

<rule id="weblogic_servlet_annotation_1000">
    <when>
        <javaclass references="weblogic.servlet.annotation.WLServlet" as="default">
            <location>ANNOTATION</location>
        </javaclass>
    </when>
    <perform>
        <hint effort="1">
            <message>Replace the proprietary WebLogic @WLServlet annotation with the Java EE 6 standard @WebServlet annotation.</message>
            <link href="https://access.redhat.com/articles/1249423" title="Migrate WebLogic Proprietary Servlet Annotations" />
            <lineitem message="Proprietary WebLogic @WLServlet annotation found in file."/>
        </hint>
    </perform>
</rule>

<lineitem> element attributes

Attribute Name	Type	Description
message	STRING	A lineitem message. message="Proprietary code found."

Attribute Name

Type

Description

message

STRING

A lineitem message.

message="Proprietary code found."

<iteration> syntax

Summary

The <iteration> element specifies to iterate over an implicit or explicit variable defined within the rule. For a better understanding of the <iteration> action, see the JavaDoc for the Iteration class.

The following is an example of a rule that performs an iteration.

<rule id="jboss-eap5-xml-19000">
    <when>
        <xmlfile as="jboss-app" matches="/jboss-app"/>
        <xmlfile as="jboss-app-no-DTD" matches="/jboss-app" public-id=""/>
    </when>
    <perform>
        <iteration over="jboss-app">
            <classification title="JBoss application Descriptor" effort="5"/>
        </iteration>
        <iteration over="jboss-app-no-DTD">
            <classification title="JBoss application descriptor with missing DTD" effort="5"/>
        </iteration>
        <iteration over="jboss-app-no-DTD">
            <xslt title="JBoss application descriptor - JBoss 5 (Windup-generated)" template="transformations/xslt/jboss-app-to-jboss5.xsl" extension="-jboss5.xml"/>
        </iteration>
    </perform>
</rule>

<iteration> element attributes

Attribute name	Type	Description
over	VARIABLE_NAME	Iterate over the condition identified by this VARIABLE_NAME. over="jboss-app"

Attribute name

Type

Description

over

VARIABLE_NAME

Iterate over the condition identified by this VARIABLE_NAME.

over="jboss-app"

<iteration> child elements

Child Element Description

Child Element	Description
<iteration>	Child elements include a `when` condition, along with the actions `iteration`, `classification`, `hint`, `xslt`, `lineitem`, and `otherwise`.

Child elements include a when condition, along with the actions iteration, classification, hint, xslt, lineitem, and otherwise.

<perform> syntax

<classification> syntax

Summary

<classification> element attributes

<classification> child elements

<link> syntax

Summary

<link> element attributes

<hint> syntax

Summary

<hint> element attributes

<hint> child elements

<xslt> syntax

Summary

<xslt> element attributes

<xslt> child elements

<lineitem> syntax

Summary

<lineitem> element attributes

<iteration> syntax

Summary

<iteration> element attributes

<iteration> child elements

`<perform>` syntax