Panda-Application

A little bit more advanced Web application with Managed Beans, Servlets WebFilters, JSF and Hibernate, deployed on TomEE.

PANDA (Package Acceptance and National Delivery Application) is a platform for package deliveries, which is a fast-rising Start-Up, which lacks a web application. You have been employed by the KFC (Kung-Fu-Chicken) Corporation to implement a web platform for PANDA.

Setup

Tested on Windows 8/10 x64

Versions

Java 11.0.2
Maven 3.6.0
Maven Compiler 3.8.0
MySQL with mysql-connector-java 8.0.15
hibernate-core 5.4.1.Final
Apache TomEE 8.0.0.M2 webprofile

Other tools:

ModelMapper
Jargon2 - Fluent Java API for Argon2 password hashing

Environment configuration

System and IDE should be configured to use:

This files should be present in TomEE\lib folder

Project configuration

pom.xml - project setup - dependencies, compile, packaging
beans.xml - default setup with bean-discovery-mode="all"

<?xml version="1.0" encoding="UTF-8"?>
<beans
        xmlns="http://xmlns.jcp.org/xml/ns/javaee"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee 
                      http://xmlns.jcp.org/xml/ns/javaee/beans_1_1.xsd"
        bean-discovery-mode="all">
</beans>

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         id="WebApp_ID" version="4.0">

    <!-- Welcome page -->
    <welcome-file-list>
        <welcome-file>faces/view/index.xhtml</welcome-file>
    </welcome-file-list>

    <!-- JSF mapping -->
    <servlet>
        <servlet-name>Faces Servlet</servlet-name>
        <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <!-- Map these files with JSF -->
    <servlet-mapping>
        <servlet-name>Faces Servlet</servlet-name>
        <url-pattern>*.xhtml</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>Faces Servlet</servlet-name>
        <url-pattern>*.jsf</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>Faces Servlet</servlet-name>
        <url-pattern>*.faces</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>Faces Servlet</servlet-name>
        <url-pattern>/faces/*</url-pattern>
    </servlet-mapping>
</web-app>

persistence.xml - persistence unit setup. Using transaction-type="RESOURCE_LOCAL"

<?xml version="1.0" encoding="UTF-8"?>
<persistence xmlns="http://java.sun.com/xml/ns/persistence"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://java.sun.com/xml/ns/persistence
             http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd"
             version="2.0">

    <persistence-unit name="pandaPU" transaction-type="RESOURCE_LOCAL">
        <properties>
            <property name="hibernate.connection.url" value="jdbc:mysql://localhost:3306/panda_db?createDatabaseIfNotExist=true&amp;useSSL=false&amp;serverTimezone=UTC" />
            <property name="hibernate.connection.driver_class" value="com.mysql.jdbc.Driver" />
            <property name="hibernate.hbm2ddl.auto" value="update"/>
            <property name="hibernate.connection.username" value="....."/>
            <property name="hibernate.connection.password" value="*****"/>
            <property name="hibernate.dialect" value="org.hibernate.dialect.MySQL5Dialect"/>
            <property name="hibernate.show_sql" value="true" />
            <property name="hibernate.format_sql" value="true" />
        </properties>
    </persistence-unit>
</persistence>

Creating beans of external classes by @Produces annotation Example

public class ApplicationBeanConfiguration {

    @Produces
    public ModelMapper modelMapper() {
        return new ModelMapper();
    }

    @Produces
    public EntityManager entityManager() {
        return Persistence.createEntityManagerFactory(AppConstants.PERSISTENCE_UNIT)
                .createEntityManager();
    }
}

Use of Jargon2 for password hashing

Configuration / Usage

public class UserServiceImpl implements UserService {

    private final UserRepository userRepository;
    private final ModelMapper modelMapper;
    private final PasswordHasher passwordHasher;
    
    // ...
    
     @Override
    public void register(UserServiceModel serviceModel) {
        User user = this.modelMapper.map(serviceModel, User.class);
        String encodedHash = passwordHasher.encodedHash(serviceModel.getPassword().toCharArray());
        user.setPassword(encodedHash);
        this.setUserRole(user);

        this.userRepository.save(user);
    }
    
    @Override
    public UserServiceModel login(UserServiceModel serviceModel) {
        User user = userRepository.findByUsername(serviceModel.getUsername());

        char[] passwordCharArr = serviceModel.getPassword().toCharArray();
        if (user == null || !passwordHasher.verifyEncoded(user.getPassword(), passwordCharArr)) {
            return null;
        }

        return this.modelMapper.map(user, UserServiceModel.class);
    }
    //...

The Database of the PANDA application support 3 entities:

User

Has an Id – a UUID String
Has an Username
Has a Password
Has an Email
Has an Role – can be one of the following values (“User”, “Admin”)

Package

Has an Id – a UUID String
Has a Description – a string.
Has a Weight – a floating-point number.
Has a Shipping Address – a string.
Has a Status – can be one of the following values (“Pending”, “Shipped”, “Delivered”, “Acquired”)
Has an Estimated Delivery Date – A LocalDateTime object.
Has a Recipient – a User object.

Receipt

Has an Id – a UUID String
Has a Fee – a decimal number.
Has an Issued On – a LocalDateTime object.
Has a Recipient – a User object.
Has a Package – a Package object.

Project Functionality

Users

The first registered User should be assigned a role – "Admin". Every User after that, should have a role – "User". Users have Packages, which are created and controlled for them, by an Administrator. Users can view Details about their own Packages. When a Package is delivered, a User can acquire it, at which point a Receipt is created with that Package and that User. Users can view their Receipts, and details about each Receipt. Administrators (role = "Admin") are essentially like normal Users. They can also have Packages, which are delivered, acquired and they also have Receipts. Administrators can also create Packages for a specific User.

They can also view all Pending Packages, and they can Ship them.
They can also view all Shipped Packages, and they can Deliver them.
They can also view all Delivered Packages, and they can view Details about them.

The application provide Guest (not logged in) users with the functionality to:

Login
Register
View the Guest Index page

The application provide Users (logged in) with the functionality to:

Logout
View their Packages
View details about a Package
View their Receipts
View details about a Receipt

The application provide Admins (logged in, with role - Admin) with the functionality to:

Logout
View their Packages
View details about a Package
View their Receipts
View details about a Receipt
View all Pending Packages
View all Shipped Packages
View all Delivered Packages
View details about all Delivered Packages
Ship Packages
Deliver Packages

Packages

When Packages are created, they are created with a Description, a Weight, a Shipping Address and a Recipient User.

Upon creation, the Status of a Package should be set to Pending.
Upon creation, the Estimated Delivery Date of a Package should be set to NULL.

Pending Packages

A Pending Package, can be Shipped by an Administrator, by clicking on the [Ship] button from the Pending Packages Page. At that moment the Package Status becomes "Shipped" and the Estimated Delivery Date is to be set to a random of 20-40 days from then.

All Pending Packages are presented on the Pending Packages Page.
A User can view his Pending Packages on his Index Page in the Pending rectangular block.
A User can view details about each one of his Pending Packages from his Index Page, by clicking on the [Details] button.

Shipped Packages

A Shipped Package, can be Delivered by an Administrator, by clicking on the [Deliver] button from the Shipped Packages Page. At that moment the Package Status becomes "Delivered".

All Shipped Packages are presented on the Shipped Packages Page.
A User can view his Shipped Packages on his Index Page in the Shipped rectangular block.
A User can view details about each one of his Shipped Packages from his Index Page, by clicking on the [Details] button.

Delivered Packages

A Delivered Package, can be Acquired by the Package’s Recipient, by clicking on the [Acquire] button from his Index Page. At that moment the Package Status becomes "Acquired" and a Receipt is generated to the User for that Package. All Delivered Packages are presented on the Delivered Packages Page. A User can view his Delivered Packages on his Index Page in the Delivered rectangular block. A User can Acquire each one of his Delivered Packages from his Index Page, by clicking on the [Acquire] button.

NOTE: The INDEX PAGE visualizes ONLY the CURRENTLY LOGGED IN USER / ADMIN’s PACKAGES. NOTE: Acquired Packages are viewable only by Administrators on the Delivered Packages Page. NOTE: Administrators can view details about ALL Delivered / Acquired Packages from the Delivered Packages Page, by clicking on the [Details] button.

Receipts

Receipts are just data entities. They are created when a Package is Acquired by its Recipient User. A Receipt should be created with a Package and a Recipient User. Upon creation, a Receipt’s Fee should be set to the Package’s Weight multiplied (*) by 2.67. Upon creation, a Receipt’s IssuedOn should be set to the current moment.

Security Configurations - mainly access requirements

Guest (not logged in) users can access Index page and functionality.
Guest (not logged in) users can access Login page and functionality.
Guest (not logged in) users can access Register page and functionality.

Guest WebFilter

@WebFilter({
        "/faces/view/home.xhtml",
        "/faces/view/receipts.xhtml",
        "/faces/view/receipts/*"
})
public class GuestUserFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        // ...
    }
}

Users (logged in) can access User LoggedIn Index page and functionality.
Users (logged in) can access User Package Details page and functionality.
Users (logged in) can access User Receipts page and functionality.
Users (logged in) can access User Receipt Details page and functionality.
Users (logged in) can access User Package Acquire functionality.
Users (logged in) can access Logout functionality.

User WebFilter

@WebFilter({
        "/faces/view/register.xhtml",
        "/faces/view/login.xhtml",
        "/faces/view/index.xhtml",
        "/"
})
public class LoggedInUserFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        // ...
    }
}

Admins (logged in) can access every functionality a normal logged in User can.
Admins (logged in) can access Admin LoggedIn Index page and functionality.
Admins (logged in) can access the Admin Package Create page and functionality.
Admins (logged in) can access the Admin Pending Packages page and functionality.
Admins (logged in) can access the Admin Shipped Packages page and functionality.
Admins (logged in) can access the Admin Delivered Packages page and functionality.
Admins (logged in) can access the Admin Package Ship functionality.
Admins (logged in) can access the Admin Package Deliver functionality.

Admin WebFilter

@WebFilter({
        "/faces/view/packages/create.xhtml",
        "/faces/view/packages/delivered.xhtml",
        "/faces/view/packages/pending.xhtml",
        "/faces/view/packages/shipped.xhtml"
})
public class LoggedInUserFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        // ...
    }
}

Technologies

Java - JDK11

Built With

Maven - Dependency Management

Version

1.0-SNAPSHOT

Author

Ivelin DImitrov

License

This project is licensed under the MIT License - see the LICENSE.md file for details

ivelin1936/Panda-Application