7.1. Organising the Folder Structure

After a template-based project has been created, its folder structure will need to be rearranged to suit Spring 4. In the NetBeans 8.2 environment, the steps would be as follows:

  1. Delete the index.html file

  2. Create the WEB-INF folder inside the Web Pages folder

  3. Create the jsp, jspf and resources folders inside the WEB-INF folder

  4. Create the js and CSS folders inside the resources folder

  5. Create the index.jsp file inside the jsp folder

The new structure of the folders should look like this:

fbdevgd30 java 001 en

Figure 43. Folder structure for the template-based project

The WEB-INF/jsp folder will contain jsp pages and the jspf folder will contain page fragments that will be added to other pages using the following directive:

  1. <%@ include file ="<filename>" %>

The resources folder is used to store static web resources — the WEB-INF/resources/css folder for cascading style sheet files, the WEB-INF/resources/fonts folder for font files, the WEB-INF/resources/js folder for JavaScript files and third-party JavaScript libraries.

Now, we modify the pom.xml file and add the general properties of the application, dependencies on library packages (Spring MVC, Jaybird, JDBC pool, JOOQ) and the properties of the JDBC connection.

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  7.     <groupId>ru.ibase</groupId>
  8.     <artifactId>fbjavaex</artifactId>
  9.     <version>1.0-SNAPSHOT</version>
  10.     <packaging>war</packaging>
  12.     <name>Firebird Java Example</name>
  14.     <properties>
  15.         <endorsed.dir>${project.build.directory}/endorsed</endorsed.dir>
  16.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  17.         <spring.version>4.3.20.RELEASE</spring.version>
  18.         <jackson.version>2.9.7</jackson.version>
  19.         <jooq.version>3.9.2</jooq.version>
  20.         <jstl.version>1.2</jstl.version>
  21.         <javax.servlet.version>3.0.1</javax.servlet.version>
  22.         <jaybird.version>3.0.5</jaybird.version>
  23.         <db.url>jdbc:firebirdsql://localhost/examples</db.url>
  24.         <db.driver>org.firebirdsql.jdbc.FBDriver</db.driver>
  25.         <db.username>SYSDBA</db.username>
  26.         <db.password>masterkey</db.password>
  27.     </properties>
  30.     <dependencies>
  31.         <dependency>
  32.             <groupId>javax</groupId>
  33.             <artifactId>javaee-web-api</artifactId>
  34.             <version>7.0</version>
  35.             <scope>provided</scope>
  36.         </dependency>
  38.         <dependency>
  39.             <groupId>javax.servlet</groupId>
  40.             <artifactId>javax.servlet-api</artifactId>
  41.             <version>${javax.servlet.version}</version>
  42.             <scope>provided</scope>
  43.         </dependency>
  45.         <dependency>
  46.             <groupId>jstl</groupId>
  47.             <artifactId>jstl</artifactId>
  48.             <version>${jstl.version}</version>
  49.         </dependency>
  51.         <!-- Working with JSON -->
  52.         <dependency>
  53.             <groupId>com.fasterxml.jackson.core</groupId>
  54.             <artifactId>jackson-core</artifactId>
  55.             <version>${jackson.version}</version>
  56.         </dependency>
  58.         <dependency>
  59.             <groupId>com.fasterxml.jackson.core</groupId>
  60.             <artifactId>jackson-annotations</artifactId>
  61.             <version>${jackson.version}</version>
  62.         </dependency>
  64.         <dependency>
  65.             <groupId>com.fasterxml.jackson.core</groupId>
  66.             <artifactId>jackson-databind</artifactId>
  67.             <version>${jackson.version}</version>
  68.         </dependency>
  70.         <!-- Spring -->
  72.         <dependency>
  73.             <groupId>org.springframework</groupId>
  74.             <artifactId>spring-core</artifactId>
  75.             <version>${spring.version}</version>
  76.         </dependency>
  78.         <dependency>
  79.             <groupId>org.springframework</groupId>
  80.             <artifactId>spring-web</artifactId>
  81.             <version>${spring.version}</version>
  82.         </dependency>
  84.         <dependency>
  85.             <groupId>org.springframework</groupId>
  86.             <artifactId>spring-webmvc</artifactId>
  87.             <version>${spring.version}</version>
  88.         </dependency>
  90.         <dependency>
  91.             <groupId>org.springframework</groupId>
  92.             <artifactId>spring-context</artifactId>
  93.             <version>${spring.version}</version>
  94.         </dependency>
  96.         <dependency>
  97.             <groupId>org.springframework</groupId>
  98.             <artifactId>spring-jdbc</artifactId>
  99.             <version>${spring.version}</version>
  100.         </dependency>
  102.         <!-- JDBC -->
  104.         <dependency>
  105.             <groupId>org.firebirdsql.jdbc</groupId>
  106.             <artifactId>jaybird-jdk18</artifactId>
  107.             <version>${jaybird.version}</version>
  108.         </dependency>
  110.         <!-- Connection pool -->
  112.         <dependency>
  113.             <groupId>commons-dbcp</groupId>
  114.             <artifactId>commons-dbcp</artifactId>
  115.             <version>1.4</version>
  116.         </dependency>
  118.         <!-- jOOQ -->
  120.         <dependency>
  121.             <groupId>org.jooq</groupId>
  122.             <artifactId>jooq</artifactId>
  123.             <version>${jooq.version}</version>
  124.         </dependency>
  126.         <dependency>
  127.             <groupId>org.jooq</groupId>
  128.             <artifactId>jooq-meta</artifactId>
  129.             <version>${jooq.version}</version>
  130.         </dependency>
  132.         <dependency>
  133.             <groupId>org.jooq</groupId>
  134.             <artifactId>jooq-codegen</artifactId>
  135.             <version>${jooq.version}</version>
  136.         </dependency>
  138.         <!-- Testing -->
  139.         <dependency>
  140.             <groupId>junit</groupId>
  141.             <artifactId>junit</artifactId>
  142.             <version>4.12</version>
  143.             <type>jar</type>
  144.             <scope>test</scope>
  145.         </dependency>
  147.         <dependency>
  148.             <groupId>org.springframework</groupId>
  149.             <artifactId>spring-test</artifactId>
  150.             <version>${spring.version}</version>
  151.             <scope>test</scope>
  152.         </dependency>
  154.     </dependencies>
  156.     <build>
  158.         <plugins>
  159.             <plugin>
  160.                 <groupId>org.eclipse.jetty</groupId>
  161.                 <artifactId>jetty-maven-plugin</artifactId>
  162.                 <version>9.4.12.v20180830</version>
  163.             </plugin>
  164.             <plugin>
  165.                 <groupId>org.apache.maven.plugins</groupId>
  166.                 <artifactId>maven-compiler-plugin</artifactId>
  167.                 <version>3.8.0</version>
  168.                 <configuration>
  169.                     <source>1.8</source>
  170.                     <target>1.8</target>
  171.                     <compilerArguments>
  172.                         <endorseddirs>${endorsed.dir}</endorseddirs>
  173.                     </compilerArguments>
  174.                 </configuration>
  175.             </plugin>
  176.             <plugin>
  177.                 <groupId>org.apache.maven.plugins</groupId>
  178.                 <artifactId>maven-war-plugin</artifactId>
  179.                 <version>3.2.2</version>
  180.                 <configuration>
  181.                     <failOnMissingWebXml>false</failOnMissingWebXml>
  182.                 </configuration>
  183.             </plugin>
  184.             <plugin>
  185.                 <groupId>org.apache.maven.plugins</groupId>
  186.                 <artifactId>maven-dependency-plugin</artifactId>
  187.                 <version>3.1.1</version>
  188.                 <executions>
  189.                     <execution>
  190.                         <phase>validate</phase>
  191.                         <goals>
  192.                             <goal>copy</goal>
  193.                         </goals>
  194.                         <configuration>
  195.                             <outputDirectory>${endorsed.dir}</outputDirectory>
  196.                             <silent>true</silent>
  197.                             <artifactItems>
  198.                                 <artifactItem>
  199.                                     <groupId>javax</groupId>
  200.                                     <artifactId>javaee-endorsed-api</artifactId>
  201.                                     <version>7.0</version>
  202.                                     <type>jar</type>
  203.                                 </artifactItem>
  204.                             </artifactItems>
  205.                         </configuration>
  206.                     </execution>
  207.                 </executions>
  208.             </plugin>
  209.         </plugins>
  210.     </build>
  211. </project>
What is a POM?

A Project Object Model or POM is the fundamental unit of work in Maven. It is an XML file that contains information about the project and configuration details used by Maven to build the project. More details can be found at https://maven.apache.org/guides/introduction/introduction-to-the-pom.

After all the necessary dependencies have been fulfilled, a reload of the POM is recommended, to load all the necessary libraries and avoid errors that might otherwise occur while you are working on the project. This is how it is done in NetBeans:

fbdevgd30 java 002 en

Figure 44. Reloading the POM from NetBeans