Whats this?

Spring module to be used as dependency that pre-configures and initializes commonly used configurations and services. This would same boilerplate configuration as well as unify the logging mechanisim, making it easiser for log monitoring tools.

Overview

• API and Service Logging
• Thread Pool
• HTTP Client Service
• Email Sender & Listener Service
• API Authentication & Authorization
• Enables Spring Auctator and logs the Health Indicators

---

Authentication & Authorization

• Regarding Authorization, JwtRequestFilter is a OncePerRequestFilter that verifies that every request has a URI that maps to either PUBLIC role, or to one of the roles of the JWTPayload
  • Mapping URIs to ROLEs are done through the app properties, in the following format: ````
• Regarding Authentication, JWTService will be injected into the Plugin component, so the plugin controller or whatsoever service can handle issuing and/or verification of the JWT tokens without much implementation.
• JWT Key is set using app property: yoga1290.commons.jwt.secret

HTTP Clients Services

• Service Components must implement AbstractClientRequestService<RequestDTO, ResponseDTO>; where the RequestDTO and ResponseDTO are the expected DTO models send and received through the external REST API endpoint.
• Services will get AOP Logging by default, since the Abstract class implements the IService Marker Interface.
• Handles request headers authentication
• Validates the request and response bodies, using Bean Validation
• Sets MDC context map for AOP logging
• Sample/Example:

@Service
public class RecaptchClientService 
    extends AbstractClientRequestService<RecaptchRequestDTO, RecaptchResponseDTO> {


    public RecaptchClientService(
            @Value("${yoga1290.client-service.headerBearerToken:}")
            String headerBearerToken,
            RestTemplate restTemplate) {

        super(  new RecaptchResponse(),
                headerBearerToken, //or user,pass
                restTemplate);
    }

    public ResponseEntity<RecaptchResponseDTO> doRequest(/*...*/) {
        return this.doPost( requestUrl,
                            recaptchRequestDTO);
    }

}

Email Sender/Listener Service

• By default, Email Service gets injected but not enabled by default.
• Use App-Password, if the GMail has a 2MF

########## EMAIL SERVICE #############
email-service.enable=false # sender service; false by default
email-service.imap.enable=false # listener service; false by default
email-service.email=...
email-service.password=... # GMail App-Password if 2MF is set.

ThreadPool

• Configure thread pool for @Async processes using the provided properties, otherwise falls back to pre-configured values.
• be default, if they were not set; it gets initialized by values below:

################ THREAD-POOL ##############
yoga1290.commons.thread-pool.core-pool-size=50
yoga1290.commons.thread-pool.max-pool-size=50
yoga1290.commons.thread-pool.queue-capacity=10
yoga1290.commons.thread-pool.thread-name-prefix=thread-

API and Service Logging

• uses AOP to configure MDC context traceable map and produce logs across pointcuts for @Controller and @Service
• Preset values and properties:

################ LOGGING ##################
# SEE https://docs.spring.io/spring-boot/docs/3.2.x/reference/htmlsingle/#features.logging.custom-log-configuration
# SEE https://docs.spring.io/spring-boot/docs/3.2.x/reference/htmlsingle/#features.logging.file-output
###########################################
logging.file.name=${LOG_FILE:${HOSTNAME:localhost}}
logging.file.path=${LOG_PATH:logs}
log-pattern=%d{HH:mm:ss.SSS} [%thread] | %-5level %logger{36} | uri: %mdc{URI} | tansactionId: %mdc{TRANSACTION_ID} | %msg%n
#FILE_LOG_PATTERN
logging.pattern.file=${log-pattern}
#CONSOLE_LOG_PATTERN
logging.pattern.console=${log-pattern}
logging.logback.rollingpolicy.max-file-size=${LOGBACK_ROLLINGPOLICY_MAX_FILE_SIZE:5000}
logging.logback.rollingpolicy.total-size-cap=${LOGBACK_ROLLINGPOLICY_TOTAL_SIZE_CAP:50000}

Usage:

1. Install dependency:

• Manually install dependency to local repo via CLI:

mvn install:install-file \
    -Dfile=microkernel-core-system-3.3.2.jar \
    -DgroupId=yoga1290 \
    -DartifactId=microkernel-core-system \
    -Dversion=3.3.2

• Or, add repository to your pom.xml:

<project>
  <!-- ..... -->
  <!-- see https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#publishing-a-package -->
  <distributionManagement>
      <repository>
          <id>github</id>
          <name>GitHub Apache Maven Packages</name>
          <url>https://maven.pkg.github.com/yoga1290/microkernel-core-system</url>
      </repository>
  </distributionManagement>
</project>

• Another option would be to, clone this repo, and run: mvn clean install to install dependency to local .m2 Maven repository.

2. Add pom.xml dependency:

Add <dependency> into pom.xml of the disered app:

<dependency>
    <groupId>yoga1290</groupId>
    <artifactId>microkernel-core-system</artifactId>
    <version>1.0.0</version>
</dependency>
<!-- TBA: will add <repository> later on; gonna make use of github maven registry & github actions -->

3. Setup & Import Configurations:

To scan the required components/package, you will need to add this entrypoint class:

import yoga1290.commons.ImportCommons;
//...
@SpringBootApplication
@Import({ ImportCommons.class})
//..

CI/CD

GitHub Actions

• Currently I have a Github Action that triggers push-mvn-registry.sh per master push, which build the Maven dependency and then pushes it to GitHub-hosted Maven registry using a Docker container.
• Maven dependency gets published in the repo's Package page

References:

• Spring | Custom Logs Configuration
• Baeldung | Guide to Spring Email
• Your First Full Stack Application with Angular and Spring Boot
• DZone | Setting Up MDC Context With AOP in Spring Boot Applications
• Mkyong | package javax.validation.constraints does not exist
• Spring | Spring Security without the WebSecurityConfigurerAdapter