45. Converting the project to Gradle

1. The process

 1. Create a new folder in the WorkSpace (MyWorkspace) for instance AEVaadin-20-01

2. Copy these files and folders from the last post project VaadinGradle02

  Files: build.gradle, gradle.properties, LICENSE (optional), README.md

  Folders: frontend, src.

3. Now import an existing gradle project , and select the folder (for instance in this example P0-AEVaadin-19-04). Select gradle version 6.6 7.1.1and the Java home

Perhaps there can be error. So review the Java Build Path in properties, and select the correct JDK 

Verify that the gradle.properties has this content:

#vaadinVersion=19.0.4  //Not used

vaadinVersion=20.0.6

Refresh project F5 

Gradle-> Regresh gradle poject

A. Now to see if it works change int the file build.gradle the variable productionMode to false and:

1. From Gradle Tasks tab -> "Your Project Name" -> build -> (clean and then build) and verify that the war was generated

2. Run as Run on Server and verify it runs

B. Now repeat the proces to see if it can generate the war file for production. Change in the build.gradle file the  variable  productionMode to false and:

1. From Gradle Tasks tab -> "Your Project Name" -> build -> (clean and then build) and verify that the war was generated

2. Copy the war to aTomvat webapp folder and try to deploy it

Here is an example of working build.gradle

// New in the Vaadin starting project version 19+
buildscript {
    repositories {
        maven { setUrl("https://maven.vaadin.com/vaadin-prereleases") }
    }
}

plugins {
    id 'war'                                 //Generate a ".war" file
    id 'org.gretty' version '3.0.4'
    //id 'com.vaadin' version '20.0.0.alpha6'
    id 'com.vaadin' version '20.0.6'
    id 'java-library'  // only to admit "api" instead of "0.
}

defaultTasks("clean", "build")

repositories {
    mavenCentral()
    maven { url = "https://maven.vaadin.com/vaadin-addons" }

    jcenter() // jcenter is deprecated, however the Gretty plugin still uses stuff from jcenter: https://github.com/gretty-gradle-plugin/gretty/issues/192
}



project.war.destinationDirectory = file("$rootDir/../mytargets")  
project.archivesBaseName = 'p-aevaadin' 
project.version = '2.0'

gretty {
    contextPath = "/"  // it points to https://localhost:8080/
    servletContainer = "jetty9.4"
}


// The following pnpmEnable = true is not needed as pnpm is used by default,
// this is just an example of how to configure the Gradle Vaadin Plugin:
// for more configuraion options please see: https://vaadin.com/docs/latest/guide/start/gradle/#all-options
vaadin {
    pnpmEnable = true
    productionMode = false  //Not included in the starting-project generation 
    optimizeBundle = true
}

dependencies {
    // $vaadinVersion" is defined in gradle.properties
    implementation enforcedPlatform("com.vaadin:vaadin-bom:$vaadinVersion")

    // Vaadin
    //implementation("com.vaadin:vaadin-core")
    implementation("com.vaadin:vaadin")
    implementation("com.vaadin:vaadin-cdi")
    
    
    
    //providedCompile "javax.servlet:javax.servlet-api:3.1.0"   //generated by starting-project
    
    //Use only or jakarta.servet or jakarta.platform but not both at the same time --> genarate errors : The package jakarta.mail is accessible from more than one module: <unnamed>, jakarta.mail
    providedCompile "jakarta.servlet:jakarta.servlet-api:5.0.0" //replace javax by jakarta !!!!! 
    //providedCompile "jakarta.platform:jakarta.jakartaee-api:9.0.0" //replace javax by jakarta !!!!! 

    providedCompile "jakarta.annotation:jakarta.annotation-api:2.0.0"
    providedCompile "jakarta.activation:jakarta.activation-api:2.0.1"
    
    implementation "com.sun.activation:jakarta.activation:2.0.1"
    

    // logging
    // currently we are logging through the SLF4J API to SLF4J-Simple. See src/main/resources/simplelogger.properties file for the logger configuration
    implementation "org.slf4j:slf4j-simple:1.7.30"
    
    //=============LOMBOK BEGIN ============================
    // Not generated by the Vaadin starting-project
    compileOnly 'org.projectlombok:lombok:1.18.20'
    annotationProcessor 'org.projectlombok:lombok:1.18.20'
	
    testCompileOnly 'org.projectlombok:lombok:1.18.20'
    testAnnotationProcessor 'org.projectlombok:lombok:1.18.20'
    //=============LOMBOK END ==============================
    
	// This dependency is for local jars in the folder mylibs
    //implementation files(
    api files(
    	'../mytargets/a-annotations-1.0.jar', 
    	'../mytargets/a-basic-utils-1.0.jar', 
    	'../mytargets/a-report-utils-1.0.jar',
    	'../mytargets/b-base-control-model-1.0.jar', 
    	'../mytargets/b-other-utils-1.0.jar',
    	'../mytargets/c-dao-1.0.jar',
    	'../mytargets/c-model-aytos-1.0.jar',
    	//'../mytargets/c-model-castilla-1.0.jar',
    	//'../mytargets/c-model-eni-1.0.jar',
    	'../mytargets/c-model-gexflow-1.0.jar',
    	//'../mytargets/c-model-orve-1.0.jar',
    	'../mytargets/c-vaadin-basic-1.0.jar' )      
    
    implementation "org.jboss.weld.servlet:weld-servlet-shaded:3.1.7.Final"
    
    implementation "org.javassist:javassist:3.27.0-GA"
    
    /* HIbernate */
    implementation "org.hibernate:hibernate-core:5.4.31.Final"
    implementation "org.hibernate:hibernate-envers:5.4.31.Final"
    //implementation "org.hibernate:hibernate-testing:5.4.31.Final"
    implementation "org.hibernate:hibernate-validator:7.0.1.Final" 
    
    /*DB Drivers */
    runtimeOnly "com.h2database:h2:1.4.200"
    implementation "org.postgresql:postgresql:42.2.20"
    implementation "net.sourceforge.jtds:jtds:1.3.1"
    
    /* Apache CMIS */
    implementation "org.apache.chemistry.opencmis:chemistry-opencmis-client-impl:1.1.0"
    
    /* JASPER REPORTS */
    implementation "net.sf.jasperreports:jasperreports:6.16.0"
    /* IText VELL pero el vol jasper reports*/
    implementation "com.lowagie:itext:2.1.7"
    implementation "com.itextpdf:itext7-core:7.1.15"  //Falta "type pom" ?????
    
}

2. File structure

Important locations:

src/main/webapp/META-INF/context.xml (For JNDI pool of connections)

src/main/resources/META-INF/presistence.xml 

src/main/resources/META-INF/services/com.vaadin.flow.server.VaadinServiceInitListener

frontend/styles

frontend/font-awesome

gradle.build

gradle.properties

src
   |->main
   |   |->webapp
   |   |   |->WEB-INF       Not used (can be deleted)
   |   |   |   |->beans.xml Not used 
   |   |   |->skins
   |   |   |   |->ui
   |   |   |   |->content
   |   |   |->META-INF
   |   |   |   |>context.xml (JNDI pool of connections)
   |   |   |->imgs
   |   |   |   |->enterprise (or any particular folder with images)
   |   |   |->icons
   |   |   |   |->flags (or any particular folder with icons)
   |   |->resources
   |   |   |->view (in yaml or any partiular folder with some info)
   |   |   |->reports (or any partiular folder with jasper reports)
   |   |   |->readme (or any partiular folder with some info)
   |   |   |->properties (property files)
   |   |   |->META-INF
   |   |   |   |->services
   |   |   |      |->com.vaadin.flow.server.VaadinServiceInitListener
   |   |   |   |->persistence.xml
   |   |   |->i18n (all teh internationalization resources)
   |   |   |   |->file_en.properties ; file_es.properties
   |   |   |->docs (any doc )
   |   |   |->simplelogger.properties
   |   |->java 
   |   |   |->ui
   |   |   |->openadmin
   |->test
frontend
   |->tone-edu (test with js)
   |   |->tone-test.js
   |->three-edu (test with js)
   |   |->three-test.js
   |->apex-charts (test with js)
   |   |->apex-charts-test.js
   |->styles (all the css defined)
   |   |->my-defined.css.css
   |->src (empty)
   |->generated
   |   |->vaadin.ts
   |->font-awesome
   |   |->webfonts, svgs, sprites, scss, metadata, less, js, css..
gradle.properties
build.gradle

44. Using Gradle. The starting project from Vaadin (2). Adjusting the buid.gradle file

 1. The build.gradle file

Here is the generated file with some add-ons for:

• using Lombok facilities to reduce boilerplate
• migrating from javax to Jakarta

// New in the Vaadin starting project version 19+
buildscript {
    repositories {
        maven { setUrl("https://maven.vaadin.com/vaadin-prereleases") }
    }
}

plugins {
    id 'war'                                 //Generate a ".war" file
    id 'org.gretty' version '3.0.4'
    id 'com.vaadin' version '20.0.0.alpha6' '20.0.6' //Change
}

defaultTasks("clean", "build")

repositories {
    mavenCentral()

    maven { url = "https://maven.vaadin.com/vaadin-addons" }
    jcenter() // jcenter is deprecated, however the Gretty plugin still uses stuff from jcenter: https://github.com/gretty-gradle-plugin/gretty/issues/192
}

// Optional versioning and output folder

project.war.destinationDirectory = file("$rootDir/../mytargets")  
project.archivesBaseName = 'p-aevaadin' 
project.version = '2.0'

// For enabling the generation of the ".war" file 
// This entry is Not generated in the starting-project generation 
// Usually used for production
/*
war {
	enabled = true
}
*/

gretty {
    contextPath = "/"  // it points to https://localhost:8080/
    servletContainer = "jetty9.4"
}

// The following pnpmEnable = true is not needed as pnpm is used by default,
// this is just an example of how to configure the Gradle Vaadin Plugin:
// for more configuraion options please see: https://vaadin.com/docs/latest/guide/start/gradle/#all-options
vaadin {
    //pnpmEnable = true
    //productionMode = true  //Not included in the starting-project generation 

    optimizeBundle= "true" //Change

}

dependencies {
    implementation enforcedPlatform("com.vaadin:vaadin-bom:$vaadinVersion")

    // Vaadin
    //implementation("com.vaadin:vaadin-core")

    implementation("com.vaadin:vaadin")       //Change
    implementation("com.vaadin:vaadin-cdi")   //Change 

    //Use only or jakarta.servet or jakarta.platform but not both at the same time --> genarate errors : The package jakarta.mail is accessible from more than one module: <unnamed>, jakarta.mail
    //providedCompile "javax.servlet:javax.servlet-api:3.1.0"   //generated by starting-project
    providedCompile "jakarta.servlet:jakarta.servlet-api:5.0.0" //replace javax by jakarta !!!!! 

    // logging

    // currently we are logging through the SLF4J API to SLF4J-Simple. See src/main/resources/simplelogger.properties file for the logger configuration
    implementation "org.slf4j:slf4j-simple:1.7.30"
    
    //=============LOMBOK BEGIN ============================
    // Not generated by the Vaadin starting-project
    compileOnly 'org.projectlombok:lombok:1.18.20'
    annotationProcessor 'org.projectlombok:lombok:1.18.20'
	
    testCompileOnly 'org.projectlombok:lombok:1.18.20'
    testAnnotationProcessor 'org.projectlombok:lombok:1.18.20'
    //=============LOMBOK END ==============================

    //=============MY PERSDONAL DEPENDENCIES============================

    / This dependency is for local jars in the folder mylibs
    //implementation files(
    api files(
    	'../mytargets/a-annotations-1.0.jar', 
    	'../mytargets/a-basic-utils-1.0.jar', 
    	'../mytargets/a-report-utils-1.0.jar',
    	'../mytargets/b-base-control-model-1.0.jar', 
    	'../mytargets/b-other-utils-1.0.jar',
    	'../mytargets/c-dao-1.0.jar',
    	'../mytargets/c-model-aytos-1.0.jar',
    	'../mytargets/c-model-gexflow-1.0.jar',
    	'../mytargets/c-vaadin-basic-1.0.jar' )      
    
    implementation "org.jboss.weld.servlet:weld-servlet-shaded:3.1.7.Final"
    
    implementation "org.javassist:javassist:3.27.0-GA"
    
    /* HIbernate */
    implementation "org.hibernate:hibernate-core:5.4.31.Final"
    implementation "org.hibernate:hibernate-envers:5.4.31.Final"
    implementation "org.hibernate:hibernate-validator:7.0.1.Final" 
    
    /*DB Drivers */
    runtimeOnly "com.h2database:h2:1.4.200"
    implementation "org.postgresql:postgresql:42.2.20"
    implementation "net.sourceforge.jtds:jtds:1.3.1"
    
    /* Apache CMIS */
    implementation "org.apache.chemistry.opencmis:chemistry-opencmis-client-impl:1.1.0"
    
    /* JASPER REPORTS */
    implementation "net.sf.jasperreports:jasperreports:6.16.0"
    /* IText VELL pero el vol jasper reports*/
    implementation "com.lowagie:itext:2.1.7"
    implementation "com.itextpdf:itext7-core:7.1.15"  //Falta "type pom" ?????
    
    
    providedCompile "jakarta.activation:jakarta.activation-api:2.0.1"
    
    implementation "com.sun.activation:jakarta.activation:2.0.1"

    //=============MY PERSDONAL DEPENDENCIES END============================

}

2. Run in Tomcat

• Create the Tomcat 9 server, (using for instance the Servers Window)
• Make sure Jetty is not running (press any key in the Console window and click the red square button if active)
• Right-Click the project Run As-> Run On Server
• Wait a moment and it works in

http://localhost:8080/VaadinGradle02/

IMPORTANT: The context is now VaadinGradle02 and not "/" as in jetty

3. Create the war file

1. Uncomment these lines:  (Should be commented!!)

    war {

       enabled = true

  }

and uncomment this one too.

   productionmode = true  (If you do not choose the correct version, the production of the war may fail!!)

If you don't uncomment the line of the "production mode=true", the generated war will only work in the computer you have developed the war, as the war is able to find the source code for debugging, but the war will be looking for the source code if you deploy it in another computer and it will stop execution!

2.  In the Gradle Tasks window, open the build folder and double-click the war task

3. Now the war file is in the build/libs folder

4. If you have choosed the option project.war.destinationDirectory = file("$rootDir/../mytargets")
then the output will be in mytargets directory!

 

43. Using Gradle. The starting project from Vaadin (1)

This super-useful Vaadin guide is applied. Eclipse is used. These are the  main steps:

1. Create a Vaadin 19+ Gradle Project

The starter project is in https://github.com/vaadin/base-starter-gradle. 

Click in the branches to select master branch

Click in the master branch

Verify that the master branch is selected and download the project

Download ZIP

Now open the zip and copy the "base-starter-gradle-master" folder to an Eclipse Workspace, and change the name for instance to VaadinGradle02

Now from Eclipse click in File->Import->Gradle(folder)->Existing Gradle Project. 

You get a welcome window

Click Next

Select  Gradle 6.6 Gradle 7.1.1 and a jdk15 compatible and click Next

Now in the last window click Finish.

and in the Project Explorer you can see:

2. Verify the Java version

Now you should change the java version if it is not 15 (in this case it is java 13)

In the Project Explorer, right-click the project and in Properties select Java BUild Path. In my case it points Java version 13

Click on the JRE line and click Edit.

Change all to Java v15

 

then click on Apply and Close Button

3. Compile and Execute the project

1. Right-click on the project and select Gradle -> Refresh Gradle Project

2. Optionally in the Gradle Tasks window open the build folder and double click the build task. This task, although is not necessary, may show possible errors. 

3. In the Gradle Tasks window open the gretty folder and double click in the appRun task

4. After a while open a browser and point to http://localhost:8080/  and here is the result

5. To stop the server, goto to the Console window in Eclipse and press any key

4. Run on Tomcat (problems with gretty version >3.04)

1. Make sure you have installed a Tomcat 9 in the servers window

2. In the Gradle Tasks window open the build folder and double click the build task.

3. Right-click the project and Run AS -> Run on Server 

4. Open a Chrome tab and point to http://localhost:8080/VaadinGradle02/

5. Solving problems (Vaadin 22.0.4)

1. Add procutionMode = false and optimizedBundle = true to the vaadin section (lines 30-31)

2. Delete file settings.gradle and change line 11 as shown

3. Line 39-40 migrate from "javax" to "jakarta" packages

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

buildscript { repositories { maven { setUrl("https://maven.vaadin.com/vaadin-prereleases") } maven { url "https://plugins.gradle.org/m2/" } } } plugins { id 'war' id 'org.gretty' version '3.0.6' id 'com.vaadin' version "${vaadinVersion}" } defaultTasks("build") repositories { mavenCentral() } gretty { contextPath = "/" servletContainer = "jetty9.4" } // The following pnpmEnable = true is not needed as pnpm is used by default, // this is just an example of how to configure the Gradle Vaadin Plugin: // for more configuraion options please see: https://vaadin.com/docs/latest/guide/start/gradle/#all-options vaadin { pnpmEnable = true productionMode = false //1.Ximo optimizeBundle = true //2.Ximo } dependencies { implementation enforcedPlatform("com.vaadin:vaadin-bom:$vaadinVersion") // Vaadin implementation("com.vaadin:vaadin-core") //providedCompile "javax.servlet:javax.servlet-api:3.1.0" //3.a.Ximo compileOnly 'jakarta.servlet:jakarta.servlet-api:5.0.0' //3.b.Ximo // logging // currently we are logging through the SLF4J API to SLF4J-Simple. See src/main/resources/simplelogger.properties file for the logger configuration implementation "org.slf4j:slf4j-simple:1.7.30" }