• Author: ID-TALEB Réda
• Creation date: 05 march 2022

This project implements a platform called FlopBox which is used to centralize the management of remote files stored in a user's FTP servers. The user will be able to interact with his various FTP servers through the FlopBox API and this by using the services offered by the Restful API. There are many services, among them the user can retrieve or/and send files to an FTP server, etc. FlopBox follows a Restful architectural style, it is built with Java JAX-RS API.

At the root level (where the pom.xml file exists), run these commands successively in a terminal:

Clean with:

$ mvn clean

Compile and generate the executable jar with:

$ mvn package

Run the jar (located at the root of the project) with:

java -jar target/flopbox-1.0-SNAPSHOT.jar

In order to test the API with Curl commands you can read the commands.md. All Curl commands are reported there.

.
├── application
│   └── Main.java
├── authentication
│   ├── AuthenticationFilter.java
│   └── PasswordEncryption.java
├── data
│   ├── DataBaseInfo.java
│   └── JsonDataBase.java
├── exceptions
│   ├── AliasAlreadyExistException.java
│   ├── AliasNotFoundException.java
│   ├── BadGatewayException.java
│   ├── BadRequestException.java
│   ├── CannotDiconnectFromFTPServerException.java
│   ├── CannotListDirectoryException.java
│   ├── CannotLoginException.java
│   ├── CannotLogoutFromFTPServerException.java
│   ├── ConflictResourceException.java
│   ├── CustomerAlreadyExistsException.java
│   ├── CustomerNotFoundException.java
│   ├── FTPServerAlreadyConnectedException.java
│   ├── FTPServerConnectionException.java
│   ├── IncorrectAuthenticationException.java
│   ├── InternalServerErrorException.java
│   ├── JSONFieldValueException.java
│   ├── NotFoundResourceException.java
│   ├── UnauthorizedUserException.java
│   ├── UnmatchedJSONKeysException.java
│   └── UnmatchedJSONValuesException.java
├── repository
│   ├── CustomerRepositoryImp.java
│   ├── CustomerRepository.java
│   ├── factory
│   │   ├── CustomerRepositoryFactory.java
│   │   ├── RepositoryFactory.java
│   │   └── ServerRepositoryFactory.java
│   ├── Repository.java
│   ├── ServerRepositoryImp.java
│   └── ServerRepository.java
├── resources
│   ├── CustomerResource.java
│   ├── FTPFileResource.java
│   ├── FTPServerResource.java
│   ├── ResourceImp.java
│   └── Resource.java
├── services
│   ├── customers
│   │   ├── CustomerEntity.java
│   │   └── CustomerService.java
│   ├── ftp_files
│   │   ├── AbstractFTPFileComponentEntity.java
│   │   ├── FTPDirectoryEntity.java
│   │   └── FTPFileEntity.java
│   ├── servers
│   │   ├── FTPFileService.java
│   │   ├── FTPServerEntity.java
│   │   ├── FTPServerService.java
│   │   └── FTPServerSession.java
│   └── Serviceable.java
└── utils
    ├── AllowedDataFields.java
    └── CustomJacksonMapperProvider.java

12 directories, 50 files

The FlopBox platform is developed in several architectural layers. This pattern is called Layered Architecture. This design pattern allows you to organize the API into several code units, each playing a specific role.

Here is a diagram summarizing the layered organization of the FlopBox platform:

• Client interaction layer

  This layer is to handle client requests sent over HTTP. This layer contains Controllers, which receive requests from clients, forward them to the Service layer, and return the results to clients. The data exchanged between the Controller and the client is in JSON format.

  • At this layer, a Resource interface is defined which will be used to define the methods for sending and receiving HTML requests to clients.

• Business layer

  This layer is to implement the basic logic of the API. The Serviceable interface allows to group the service classes used in this layer to implement all the business logic.

  • In this level, another design pattern is implemented. This is the composite. The abstract class AbstractFTPFileComponentEntity allows to model the tree structure of the directories of an FTP server.

• Persistence layer

  This layer consists of providing an interface to access the database. This layer contains a Repository interface which implements create, retrieve, update and delete (CRUD) operations.

  • Another design pattern used in this layer is the Abstract Factory. The RepositoryFactory interface allows you to create an instance of a repository without defining the "repositories" classes concretely at the Business layer level.

• Database layer

  This database layer is used to store domain objects (like CustomerEntity and FTPServerEntity). A JSON database is used at this level.

UML diagrams for each layer are available in the docs folder.