12. Tutorials

12.1. Creating a new application

12.1.1. Running the archetype

In order to create a new application you must use the archetype provided by devon4j which uses the maven archetype functionality.

To create a new application, you should have installed devonfw IDE. You can choose between 2 alternatives, create it from command line or, in more visual manner, within eclipse.

From command Line

To create a new devon4j application from command line, you can simply run the following command:

devon java create com.example.application.sampleapp

For low-level creation you can also manually call this command:

mvn -DarchetypeVersion=3.1.0 -DarchetypeGroupId=com.devonfw.java.templates -DarchetypeArtifactId=devon4j-template-server archetype:generate -DgroupId=com.example.application -DartifactId=sampleapp -Dversion=1.0.0-SNAPSHOT -Dpackage=com.devonfw.application.sampleapp

Further providing additional properties (using -D parameter) you can customize the generated app:

Table 34. Options for app template
property comment example

dbType

Choose the type of RDBMS to use (hana, oracle, mssql, postgresql, mariadb, mysql, etc.)

-DdbTpye=postgresql

batch

Option to add an batch module

-Dbatch=batch

earProjectName

Option to add an EAR module with the given name

-DearProjectName=ear

From Eclipse
After that, you should follow this Eclipse steps to create your application:
  • Create a new Maven Project.

  • Choose the devon4j-template-server archetype, just like the image.

Select archetype
  • Fill the Group Id, Artifact Id, Version and Package for your project. If you want to add an EAR generation mechanism to your project, you should fill the property earProjectName with the value Artifact Id + "-ear". For example, "sampleapp-ear". If you only want WAR generation, you can remove the property earProjectName.

Configure archetype
  • Finish the Eclipse assistant and you are ready to start your project.

12.1.2. What is generated

The application template (archetype) generates a Maven multi-module project. It has the following modules:

  • api: module with the API (REST service interfaces, transferobjects, datatypes, etc.) to be imported by other apps as a maven dependency in order to invoke and consume the offered (micro)services.

  • core: maven module containing the core of the application.

  • batch: optional module for batch(es)

  • server: module that bundles the entire app (core with optional batch) as a WAR file.

  • ear: optional maven module is responsible to packaging the application as a EAR file.

The toplevel pom.xml of the generated project has the following features:

  • Properties definition: Spring-boot version, Java version, etc.

  • Modules definition for the modules (described above)

  • Dependency management: define versions for dependencies of the technology stack that are recommended and work together in a compatible way.

  • Maven plugins with desired versions and configuration

  • Profiles for test stages

Core Module

Core module contains the base classes and the base configuration for the application. We are going to describe each Java file and each XML configuration file that archetype has generated.

Java

Those are the different Java files contained in each package:

  • general.common

File Description

api.ApplicationEntity.java

Abstract interface for a MutableGenericEntity of this application.

api.BinaryObject.java

Interface for a BinaryObject.

api.NlsBundleApplicationRoot.java

NlsBundle for this application.

api.Usermanagement.java

Interface to get a user from its login.

api.UserProfile.java

Interface for the profile of a logged user.

api.exception.ApplicationBusinessException.java

Abstract business main exception.

api.exception.ApplicationException.java

Abstract main exception.

api.exception.ApplicationTechnicalException.java

Abstract technical main exception.

api.exception.NoActiveUserException.java

Manage exceptions when user require to be logged in.

api.to.AbstractCto.java

Abstract class for Composite Transfer Object.

api.to.AbstractEto.java

Abstract class for Entity Transfer Object.

api.to.AbstractTo.java

Abstract class for a plain Transfer Object.

api.to.SearchCriteriaTo.java

Abstract class for a Transfer Object with the criteria for a search query.

api.to.UserProfileTo.java

.

base.AbstractBeanMapperSupport.java

Provides access to the BeanMapper.

impl.security.ApplicationAuthenticationProvider.java

Responsible for the security aspects of authentication.

impl.security. PrincipalAccessControlProviderImpl.java

Implementation of PrincipalAccessControlProvider.

  • general.dataaccess

File Description

api.ApplicationPersistenceEntity.java

Abstract Entity for all Entities with an id and a version field.

api.dao.ApplicationDao.java

Interface for all DAOs of the application.

api.dao.ApplicationRevisionedDao.java

Interface for all revisioned DAOs of the application.

  • general.logic

File Description

api.UseCase.java

Annotation to mark all use-cases.

base.AbstractUc.java

Abstract base class for any use case in the application.

  • general.service.impl.rest

File Description

ApplicationAccessDeniedHandler.java

Class to manage denied access.

ApplicationObjectMapperFactory.java

MappingFactory class to resolve polymorphic conflicts within the application.

SecurityRestServiceImpl.java

Class that represents REST service for security.

Resources

Those are the different XML files contained in resources folder:

  • db

Test

Those are different Java files to serve as base classes in testing:

  • general.common

File Description

AbstractSpringIntegrationTest.java

.

PermissionCheckTest.java

Test to check if all relevant methods in use case implementations have permission checks.

Server Module

This module is contains two files:

  • logback.xml: This file is in the resources folder and it is the responsible to configure the log.

  • pom.xml: This file has Maven configuration for packaging the application as a WAR. Also, this file has a profile to package the Javascript client ZIP file into the WAR.

EAR Module

This module only contains a pom.xml file to packaging the application as EAR from the WAR generated.

12.1.3. Database configuration and creation

Including driver installation if oracle or other db is required.

Last updated 2020-03-28 00:06:08 UTC