This repository includes a base application for other Java/Spring projects that has REST as their Architectural style, Oracle database and user authentication process performed with a JWT (Json Web Token).

This project also offers API documentation with swagger and exposes their entities with Spring Data Rest.

Running Application:

By default the application offers three profiles: dev, test and prod. Test profile uses embedded database H2 and others use Oracle.

There is also support for MongoDB. For that use the mongodb branch instead.

To run the app via terminal: mvn spring-boot:run -P[profile]

If a profile is not specified the test profile is used.

Based on application.properties app will use the following values: port = 8081, context = /app and servlet path = /web

The complete path will be localhost:8081/app/web/

Documentation:

Swagger will be available for any existing or new controller at localhost:8081/app/web/swagger-ui

Security:

All Spring Security related configuration is present in the WebAppSecurityConfiguration class.

This app has two authentication filters, one of them dedicated to login proccess and other related to perform authentication via JWT on every request for protected resources. The user information is stored in a database and retrieved during login process.

Login filter handles request to the URL /login (POST) that must present two parameters to this filter: a username and password and gives to the client app a valid JWT after a successful authentication on response header Authorization.

A valid JWT is created by class JwtWriterListener.

JWT filter hadles request for any protected resouces, that must present a valid JWT in the Authotization header (Bearer Token).

All resources defined as permitAll and anonymous in WebAppSecurityConfiguration are processed by Anonymous filter provided by Spring.

The postman collection and environment are availabe at /postman folder on source code.

Model:

As the goal of this project is to be used as basis for other applications there is only one Entity that is exposed via Spring Data Rest. Some operations are allowed only for authenticated users with USER role and others for users with ADMIN role. This protection is provided by using @PreAuthorize annotation with hasRole value.

All domain objects exposed with Spring Data Rest are available at localhost:8081/app/web/api/[domain-name]

Database:

This projects already defined to work with oracle database for dev and prod environment and to work with H2 for tests.

Exception Handling and Error Messages:

All exceptions are processed by WebAppErrorHandler, domain erros are based on AbstractWebAppException and the class WebAppErrorResponse constains useful data about the error itself. By default all implementations of AbstractWebAppExceptions should have @ResponseStatus annotation.