hibernate4.windup.xml

<?xml version="1.0"?>
<ruleset xmlns="http://windup.jboss.org/schema/jboss-ruleset" id="hibernate4" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://windup.jboss.org/schema/jboss-ruleset http://windup.jboss.org/schema/jboss-ruleset/windup-jboss-ruleset.xsd">
    <metadata>
        <description>
            This ruleset provides analysis for migration to Hibernate 5.x.
        </description>
        <dependencies>
            <addon id="org.jboss.windup.rules,windup-rules-javaee,2.4.0.Final" />
            <addon id="org.jboss.windup.rules,windup-rules-java,2.4.0.Final" />
        </dependencies>
        <sourceTechnology id="hibernate" versionRange="[4,5)" />
        <sourceTechnology id="eap" versionRange="[6,7)" />
        <targetTechnology id="hibernate" versionRange="[5,)" />
        <targetTechnology id="eap" versionRange="[7,8)" />
        <tag>hibernate</tag>
        <tag>configuration</tag>
    </metadata>
    <rules>
        <rule id="hibernate4-00001">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.addFile{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.addFile()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.MetadataSources#addFile` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00002">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.add({*})">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.add()" effort="1" category-id="optional">
                    <message>There is no direct replacement for method `org.hibernate.cfg.Configuration#add()`.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00003">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.addXML{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.addXML()" effort="1" category-id="optional">
                    <message>There is no direct replacement for method `org.hibernate.cfg.Configuration#addXML`.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00004">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.addCacheableFile{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.addCacheableFile()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.MetadataSources#addCacheableFile` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00005">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.addURL{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.addURL()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.MetadataSources#addURL` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00006">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.addInputStream{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.addInputStream()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.MetadataSources#addInputStream` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00007">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.addResource{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.addResource()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.MetadataSources#addResource` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00008">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.addClass{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.addClass()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.MetadataSources#addClass` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00009">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.addAnnotatedClass{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.addAnnotatedClass()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.MetadataSources#addAnnotatedClass` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00010">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.addPackage{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.addPackage()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.MetadataSources#addPackage` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00011">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.addJar{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.addJar()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.MetadataSources#addJar` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00012">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.addDirectory{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.addDirectory()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.MetadataSources#addDirectory` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00013">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.registerTypeContributor{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.registerTypeContributor()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.MetadataBuilder#applyTypes` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00014">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.registerTypeOverride{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.registerTypeOverride()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.MetadataBuilder#applyBasicType` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00015">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.setProperty{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.setProperty()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.registry.StandardServiceRegistryBuilder#applySetting` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00016">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.setProperties{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.setProperties()" effort="1" category-id="optional">
                    <message>There is no direct replacement.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00017">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.addProperties{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.addProperties()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.registry.StandardServiceRegistryBuilder#applySettings` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00018">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.setNamingStrategy{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.setNamingStrategy()" effort="1" category-id="optional">
                    <message>
                        Historically Hibernate provided just a singular contract for applying a "naming strategy".
                        Starting in 5.0 this has been split into 2 distinct contracts:

                        * ImplicitNamingStrategy - is used whenever a table or column is not explicitly named to determine the name to use.
                        * PhysicalNamingStrategy - is used to convert a "logical name" (either implicit or explicit) name of a table or column into a physical name (e.g. following corporate naming guidelines)

                        Use methods `org.hibernate.boot.MetadataBuilder#setImplicitNamingStrategy(ImplicitNamingStrategy implicitNamingStrategy)` or
                        `org.hibernate.boot.MetadataBuilder#setPhysicalNamingStrategy(PhysicalNamingStrategy physicalNamingStrategy)`
                        instead of `public Configuration setNamingStrategy(NamingStrategy namingStrategy)()`
                    </message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00021">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.{configure}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.configure()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.registry.StandardServiceRegistryBuilder#configure` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
            <where param="configure">
                <matches pattern="(configure\([^)]*\))" />
            </where>
        </rule>
        <rule id="hibernate4-00022">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.setInterceptor{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.setInterceptor()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.SessionFactoryBuilder#applyInterceptor` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00023">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.setEntityNotFoundDelegate{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.setEntityNotFoundDelegate()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.SessionFactoryBuilder#applyEntityNotFoundDelegate` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00024">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.setSessionFactoryObserver{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.setSessionFactoryObserver()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.SessionFactoryBuilder#addSessionFactoryObservers` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00025">
            <when>
                <javaclass references="org.hibernate.cfg.Configuration.setCurrentTenantIdentifierResolver{*}">
                    <location>METHOD_CALL</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Deprecated method org.hibernate.cfg.Configuration.setCurrentTenantIdentifierResolver()" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.SessionFactoryBuilder#applyCurrentTenantIdentifierResolver` instead.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#re-purposing-of-configuration"
                        title="Changes in Configuration for Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#hibernate_and_jpa_migration_changes"
                        title="Hibernate and JPA migration changes" />
                    <tag>hibernate</tag>
                    <tag>configuration</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00026">
            <when>
                <javaclass references="org.hibernate.metamodel.spi.{type}"/>
            </when>
            <perform>
                <hint title="Hibernate 5 - Moved method org.hibernate.metamodel.spi.{type}" effort="1" category-id="optional">
                    <message>Use `org.hibernate.boot.model.{type}` instead.</message>
                    <link title="Hibernate 5 - Other changes to classes/packages"
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#migration_hibernate_orm_changes_other_classes" />
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#type-handling"
                        title="Changes in Type handling for Hibernate 5" />
                    <tag>hibernate</tag>
                </hint>
            </perform>
            <where param="type">
                <matches pattern="(TypeContributor|TypeContributions)"/>
            </where>
        </rule>
        <rule id="hibernate4-00027">
            <when>
                <javaclass references="org.hibernate.cfg.AnnotationConfiguration"/>
            </when>
            <perform>
                <hint title="Hibernate 5 - Removed class org.hibernate.cfg.AnnotationConfiguration" effort="1" category-id="optional">
                    <message>
                    All functionality from `org.hibernate.cfg.AnnotationConfiguration` has been moved to `org.hibernate.cfg.Configuration`.
                    </message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#deprecations"
                        title="Removed or deprecated types in Hibernate 5" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#migration_hibernate_orm_changes_deprecations"
                        title="Removed and Deprecated Classes" />
                    <tag>hibernate</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00028">
            <when>
                <javaclass references="org.hibernate.id.{idclass}"/>
            </when>
            <perform>
                <hint title="Hibernate 5 - Removed deprecated class org.hibernate.id.{idclass}" effort="1" category-id="optional">
                    <message>Use `org.hibernate.id.enhanced.SequenceStyleGenerator` instead.</message>
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#migration_hibernate_orm_changes_deprecations"
                        title="Removed and Deprecated Classes" />
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#deprecations"
                        title="Removed or deprecated types in Hibernate 5" />
                    <tag>hibernate</tag>
                </hint>
            </perform>
            <where param="idclass">
                <matches pattern="(TableGenerator|TableHiLoGenerator|SequenceGenerator|SequenceIdentityGenerator|SequenceHiLoGenerator)" />
            </where>
        </rule>
        <rule id="hibernate4-00030">
            <when>
                <javaclass references="org.hibernate.hql.spi.{type}" />
            </when>
            <perform>
                <hint title="Hibernate 5 - Moved class org.hibernate.hql.spi.{type}" effort="1" category-id="optional">
                    <message>Hibernate 5 moved `org.hibernate.hql.spi.{type}` class to new `org.hibernate.hql.spi.id` package.</message>
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#misc"
                        title="Hibernate 5 Misc changes" />
                    <tag>hibernate</tag>
                </hint>
            </perform>
            <where param="type">
                <matches pattern="(MultiTableBulkIdStrategy|MultiTableBulkIdStrategy.DeleteHandler|MultiTableBulkIdStrategy.UpdateHandler|AbstractTableBasedBulkIdHandler|AbstractTableBasedBulkIdHandler.ProcessedWhereClause|TableBasedDeleteHandlerImpl|TableBasedUpdateHandlerImpl)" />
            </where>
        </rule>
        <rule id="hibernate4-00031">
            <when>
                <javaclass references="org.hibernate.hql.spi.PersistentTableBulkIdStrategy" />
            </when>
            <perform>
                <hint title="Hibernate 5 - Moved class org.hibernate.hql.spi.PersistentTableBulkIdStrategy" effort="1" category-id="optional">
                    <message>Hibernate 5 moved `org.hibernate.hql.spi.PersistentTableBulkIdStrategy` class to new `org.hibernate.hql.spi.id.persistent` package.</message>
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#migration_hibernate_orm_changes_miscellaneous"
                        title="Other Hibernate ORM 5 changes" />
                    <tag>hibernate</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00032">
            <when>
                <javaclass references="org.hibernate.hql.spi.TemporaryTableBulkIdStrategy" />
            </when>
            <perform>
                <hint title="Hibernate 5 - Replaced class org.hibernate.hql.spi.TemporaryTableBulkIdStrategy" effort="1" category-id="optional">
                    <message>Hibernate 5 replaced `org.hibernate.hql.spi.TemporaryTableBulkIdStrategy` class with `org.hibernate.hql.spi.id.global.GlobalTemporaryTableBulkIdStrategy` and `org.hibernate.hql.spi.id.local.LocalTemporaryTableBulkIdStrategy`.</message>
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#migration_hibernate_orm_changes_miscellaneous"
                        title="Other Hibernate ORM 5 changes" />
                    <tag>hibernate</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00033">
            <when>
                <javaclass references="org.hibernate.integrator.spi.Integrator">
                    <location>IMPLEMENTS_TYPE</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Changed interface org.hibernate.integrator.spi.Integrator" effort="1" category-id="optional">
                    <message>Hibernate 5 changed contract `org.hibernate.integrator.spi.Integrator` to account for bootstrap redesign.
                    Check if you implement method `integrate(Configuration configuration, SessionFactoryImplementor sessionFactory, SessionFactoryServiceRegistry serviceRegistry)` which is no longer there.
                    </message>
                    <link title="Hibernate 5 - Other changes to classes/packages"
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#migration_hibernate_orm_changes_other_classes" />
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#changedmoved-contracts"
                        title="Hibernate 5 Changed or Moved Contracts" />
                    <tag>hibernate</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00034">
            <when>
                <javaclass references="org.hibernate.engine.jdbc.spi.JdbcServices">
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Changed class org.hibernate.engine.jdbc.spi.JdbcServices" effort="1" category-id="optional">
                    <message>Hibernate 5 extracted new interface `org.hibernate.engine.jdbc.env.spi.JdbcEnvironment` from `org.hibernate.engine.jdbc.spi.JdbcServices`.</message>
                    <link title="Hibernate 5 - Other changes to classes/packages"
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#migration_hibernate_orm_changes_other_classes" />
                    <link
                        href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#changedmoved-contracts"
                        title="Hibernate 5 Changed or Moved Contracts" />
                     <link
                        href="https://docs.jboss.org/hibernate/orm/5.0/javadocs/index.html?org/hibernate/engine/jdbc/env/spi/JdbcEnvironment.html"
                        title="Hibernate 5 JdbcEnvironment new API" />
                    <tag>hibernate</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00035">
            <when>
                <javaclass references="org.hibernate.id.Configurable">
                    <location>IMPLEMENTS_TYPE</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - Changed signature org.hibernate.id.Configurable" effort="1" category-id="optional">
                    <message>Hibernate 5 changed the signature of `org.hibernate.id.Configurable#configure` method to accept `ServiceRegistry` rather than just `Dialect`</message>
                    <link title="Hibernate 5 - Other changes to classes/packages"
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#migration_hibernate_orm_changes_other_classes" />
                     <link
                        href="https://docs.jboss.org/hibernate/orm/5.0/javadocs/org/hibernate/id/Configurable.html#configure-org.hibernate.type.Type-java.util.Properties-org.hibernate.service.ServiceRegistry-"
                        title="Hibernate 5 Configurable API" />
                    <tag>hibernate</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00036">
            <when>
                <javaclass references="org.hibernate.id.PersistentIdentifierGenerator">
                    <location>IMPLEMENTS_TYPE</location>
                </javaclass>
            </when>
            <perform>
                <hint title="Hibernate 5 - PersistentIdentifierGenerator implementations need to implement ExportableProducer#registerExportables" effort="1" category-id="optional">
                    <message>Since Hibernate 5, The `org.hibernate.id.PersistentIdentifierGenerator` extends new `org.hibernate.boot.model.relational.ExportableProducer` interface which will affect all `org.hibernate.id.PersistentIdentifierGenerator` implementations.
                    Therefore you need to implement additionally `ExportableProducer#registerExportables(org.hibernate.boot.model.relational.Database database)` method.</message>
                    <link title="HIbernate 5 - Other changes to classes/packages"
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#migration_hibernate_orm_changes_other_classes" />
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#migration_hibernate_orm_changes_miscellaneous"
                        title="Hibernate 5 Changed or Moved Contracts" />
                     <link
                        href="https://docs.jboss.org/hibernate/orm/5.0/javadocs/org/hibernate/boot/model/relational/ExportableProducer.html#registerExportables-org.hibernate.boot.model.relational.Database-"
                        title="Hibernate 5 ExportableProducer API" />
                    <tag>hibernate</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00037">
            <when>
                <javaclass references="org.hibernate.envers.configuration.AuditConfiguration" />
            </when>
            <perform>
                <hint title="Hibernate 5 - Removed class org.hibernate.envers.configuration.AuditConfiguration" effort="1" category-id="optional">
                    <message>Hibernate 5 removed `AuditConfiguration` in preference for new `org.hibernate.envers.boot.internal.EnversService`.</message>
                    <link
                        href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#migration_hibernate_orm_changes_miscellaneous"
                        title="Other Hibernate ORM 5 changes" />
                     <link
                        href="https://docs.jboss.org/hibernate/orm/5.0/javadocs/index.html?org/hibernate/envers/boot/internal/EnversService.html"
                        title="Hibernate 5 EnversService API" />
                    <tag>hibernate</tag>
                </hint>
            </perform>
        </rule>
        <rule id="hibernate4-00038">
            <when>
                <or>
                    <javaclass references="org.hibernate.spatial.dialect.{spatial}">
                        <location>INHERITANCE</location>
                    </javaclass>
                    <javaclass references="org.hibernate.spatial.JTSGeometryJavaTypeDescriptor">
                        <location>INHERITANCE</location>
                    </javaclass>
                    <javaclass references="org.hibernate.spatial.GeolatteGeometryJavaTypeDescriptor">
                        <location>INHERITANCE</location>
                    </javaclass>
                    <javaclass references="org.hibernate.type.descriptor.java.{javatype}">
                        <location>INHERITANCE</location>
                    </javaclass>
                    <javaclass references="org.hibernate.type.descriptor.sql.{sqltype}">
                        <location>INHERITANCE</location>
                    </javaclass>
                    <javaclass references="org.hibernate.type.descriptor.converter.AttributeConverterSqlTypeDescriptorAdapter">
                        <location>INHERITANCE</location>
                    </javaclass>
                    <javaclass references="org.hibernate.type.PostgresUUIDType.PostgresUUIDSqlTypeDescriptor">
                        <location>INHERITANCE</location>
                    </javaclass>
                </or>
            </when>
            <perform>
                <hint
                    title="Hibernate 5 - Registration needed for built-in implementations of org.hibernate.type.descriptor.sql.SqlTypeDescriptor"
                    effort="1" category-id="optional">
                    <message>Built-in implementations of `org.hibernate.type.descriptor.sql.SqlTypeDescriptor` and `org.hibernate.type.descriptor.java.JavaTypeDescriptor` no longer
                        auto-register themselves with `org.hibernate.type.descriptor.sql.SqlTypeDescriptorRegistry` and `org.hibernate.type.descriptor.java.JavaTypeDescriptorRegistry`.
                        Applications using custom `SqlTypeDescriptor`/`JavaTypeDescriptor` implementations which extends the built-in ones and
                        rely on that behavior should be updated to call `SqlTypeDescriptorRegistry#addDescriptor` or `JavaTypeDescriptorRegistry#addDescriptor` themselves.
                     This warning is important especially for users of Hibernate 4.3.</message>
                    <link href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/migration_guide/#migration_hibernate_orm_changes_type_handling"
                        title="Hibernate 5 Type Handling" />
                    <link
                        href="https://docs.jboss.org/hibernate/orm/5.0/javadocs/index.html?org/hibernate/type/descriptor/sql/SqlTypeDescriptorRegistry.html"
                        title="Hibernate 5 javadoc for SqlTypeDescriptorRegistry#addDescriptor" />
                    <link href="https://docs.jboss.org/hibernate/orm/5.0/javadocs/index.html?org/hibernate/type/descriptor/java/JavaTypeDescriptorRegistry.html" title="Hibernate 5 javadoc for JavaTypeDescriptorRegistry#addDescriptor" />
                    <tag>hibernate</tag>
                </hint>
            </perform>
            <where param="spatial">
                <matches
                    pattern="(mysql.MySQLGeometryTypeDescriptor | h2geodb.GeoDBGeometryTypeDescriptor | postgis.PGGeometryTypeDescriptor | oracle.SDOGeometryTypeDescriptor | sqlserver.SqlServer2008GeometryTypeDescriptor)" />
            </where>
            <where param="javatype">
                <matches
                    pattern="(AbstractTypeDescriptor|BigDecimalTypeDescriptor|BigIntegerTypeDescriptor|BlobTypeDescriptor|BooleanTypeDescriptor|ByteArrayTypeDescriptor|ByteTypeDescriptor|CalendarDateTypeDescriptor|CalendarTimeTypeDescriptor|CalendarTypeDescriptor|CharacterArrayTypeDescriptor|CharacterTypeDescriptor|ClassTypeDescriptor|ClobTypeDescriptor|CurrencyTypeDescriptor|DateTypeDescriptor|DoubleTypeDescriptor|DurationJavaDescriptor|EnumJavaTypeDescriptor|FloatTypeDescriptor|InstantJavaDescriptor|IntegerTypeDescriptor|JavaTypeDescriptorRegistry.FallbackJavaTypeDescriptor|JdbcDateTypeDescriptor|JdbcTimestampTypeDescriptor|JdbcTimeTypeDescriptor|LocalDateTimeJavaDescriptor|LocalDateJavaDescriptor|LocaleTypeDescriptor|LocalTimeJavaDescriptor|LongTypeDescriptor|NClobTypeDescriptor|OffsetDateTimeJavaDescriptor|OffsetTimeJavaDescriptor|PrimitiveByteArrayTypeDescriptor|PrimitiveCharacterArrayTypeDescriptor|SerializableTypeDescriptor|ShortTypeDescriptor|StringTypeDescriptor|TimeZoneTypeDescriptor|UrlTypeDescriptor|UUIDTypeDescriptor|ZonedDateTimeJavaDescriptor)" />
            </where>
            <where param="sqltype">
                <matches
                    pattern="(BigIntTypeDescriptor|BinaryTypeDescriptor|BitTypeDescriptor|BlobTypeDescriptor|BooleanTypeDescriptor|CharTypeDescriptor|ClobTypeDescriptor|DateTypeDescriptor|DecimalTypeDescriptor|DoubleTypeDescriptor|FloatTypeDescriptor|IntegerTypeDescriptor|LongNVarcharTypeDescriptor|LongVarbinaryTypeDescriptor|LongVarcharTypeDescriptor|NCharTypeDescriptor|NClobTypeDescriptor|NumericTypeDescriptor|NVarcharTypeDescriptor|RealTypeDescriptor|SmallIntTypeDescriptor|SqlTypeDescriptorRegistry.ObjectSqlTypeDescriptor|TimestampTypeDescriptor|TimeTypeDescriptor|TinyIntTypeDescriptor|VarbinaryTypeDescriptor|VarcharTypeDescriptor)" />
            </where>
        </rule>
        <rule id="hibernate4-00039">
            <when>
                <filecontent filename="{*}.{extension}" pattern="org.hibernate.dialect.Oracle12cDialect" as="config_files"/>
                <javaclass references="javax.persistence.Entity" as="java_entities">
                    <location>ANNOTATION</location>
                </javaclass>
                <javaclass references="java.lang.Byte[]" from="java_entities" as="mappings">
                    <location>RETURN_TYPE</location>
                </javaclass>
                <javaclass references="byte[]" from="java_entities" as="mappings2">
                    <location>RETURN_TYPE</location>
                </javaclass>
            </when>
            <perform>
                <iteration over="mappings">
                    <hint title="Hibernate 5  - Oracle12cDialect maps byte[] and Byte[] to BLOB" effort="1" category-id="mandatory">
                        <message>
                            Previous versions of Hibernate have mapped `byte[]` and `Byte[]` to Oracle’s `LONG RAW` data type (via the JDBC `LONGVARBINARY` type). Oracle have deprecated the `LONG RAW` data type for many releases - possibly as far back as 8i.

                            Therefore it was decided to start having Hibernate map `byte[]` and `Byte[]` to `BLOB` for Oracle.

                            However, in the interest of backwards compatibility and not breaking existing applications it was also decided to limit this change to just the `Oracle12cDialect`. So starting in 5.1 applications using `Oracle12cDialect` and implicitly mapping `byte[]` and `Byte[]` values will start seeing those handled as `BLOB` data rather than `LONG RAW` data.
                            For existing applications that want to continue to use `Oracle12cDialect` and still continue to implicitly map `byte[]` and `Byte[]` attributes to `LONG RAW`, there is a new configuration setting you can use to enable that: `hibernate.dialect.oracle.prefer_longvarbinary`, which is `false `by default (map to `BLOB`).
                        </message>
                        <link href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#migration-from-503final-to-508final" title="Oracle Byte Array Mapping Changes"/>
                        <tag>Hibernate</tag>
                    </hint>
                </iteration>
                <iteration over="mappings2">
                    <hint title="Hibernate 5  - Oracle12cDialect maps byte[] and Byte[] to BLOB" effort="1" category-id="mandatory">
                        <message>
                            Previous versions of Hibernate have mapped `byte[]` and `Byte[]` to Oracle’s `LONG RAW` data type (via the JDBC `LONGVARBINARY` type). Oracle have deprecated the `LONG RAW` data type for many releases - possibly as far back as 8i.

                            Therefore it was decided to start having Hibernate map `byte[]` and `Byte[]` to `BLOB` for Oracle.

                            However, in the interest of backwards compatibility and not breaking existing applications it was also decided to limit this change to just the `Oracle12cDialect`. So starting in 5.1 applications using `Oracle12cDialect` and implicitly mapping `byte[]` and `Byte[]` values will start seeing those handled as `BLOB` data rather than `LONG RAW` data.
                            For existing applications that want to continue to use `Oracle12cDialect` and still continue to implicitly map `byte[]` and `Byte[]` attributes to `LONG RAW`, there is a new configuration setting you can use to enable that: `hibernate.dialect.oracle.prefer_longvarbinary`, which is `false `by default (map to `BLOB`).
                        </message>
                        <link href="https://github.com/hibernate/hibernate-orm/blob/5.0/migration-guide.adoc#migration-from-503final-to-508final" title="Oracle Byte Array Mapping Changes"/>
                        <tag>Hibernate</tag>
                    </hint>
                </iteration>
            </perform>
            <where param="extension">
                <matches pattern="(java|properties|xml)"/>
            </where>
        </rule>
        <!--https://issues.jboss.org/browse/WINDUPRULE-385-->
        <rule id="hibernate4-00040">
            <when>
                <!-- check if the dialect is one of the special ones -->
                <xmlfile matches="//s:property[@name='hibernate.dialect' and windup:matches(@value, 'org.hibernate.dialect.{param_dialects}')]" as="dialects_used">
                    <namespace prefix="s" uri="http://xmlns.jcp.org/xml/ns/persistence"/>
                </xmlfile>
                <!-- check if we are calling the setFirstResult method of one of the Query class -->
                <javaclass references="{param_classes_setfirstresult}.setFirstResult(int)" >
                        <location>METHOD_CALL</location>
                    </javaclass>
            </when>
            <perform>
                <iteration over="dialects_used">
                    <hint title="Hibernate 5.3 - Dialects not supporting Limit Offset" effort="1" category-id="mandatory">
                        <message>If the migration is from JBoss EAP 6 or Hibernate 4 then the dialect {param_dialects} does not support limit offset therefore as `setFirstResult` is used then `hibernate.legacy_limit_handler=true` is mandatory.</message>
                        <link title="Red Hat JBoss EAP 7.2: Migrating from Hibernate ORM 4.3 to Hibernate ORM 5.3" href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.2/html-single/migration_guide/#migrating_from_hibernate_5_1_to_5_3"/>
                        <tag>hibernate</tag>
                    </hint>
                </iteration>
            </perform>
            <where param="param_classes_setfirstresult">
                <matches pattern="javax.persistence.Query|org.hibernate.Query|org.hibernate.Criteria"/>
            </where>
            <where param="param_dialects">
                <matches pattern="Cache71Dialect|DB2390Dialect|InformixDialect|IngresDialect|RDMSOS2200Dialect|SQLServerDialect|TimesTenDialect"/>
            </where>
        </rule>
    </rules>
</ruleset>