Feature/michael/shared contract module

pom.xml

@@ -13,6 +13,7 @@
         <module>server</module>
         <module>registry-server-runner</module>
         <module>spring-utils</module>
+        <module>server-contract</module>
     </modules>
 
     <properties>

server-contract/pom.xml

@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>com.michael</groupId>
+        <artifactId>service-container-parent</artifactId>
+        <version>1.0.0</version>
+    </parent>
+
+    <artifactId>contract</artifactId>
+
+    <properties>
+        <maven.compiler.source>23</maven.compiler.source>
+        <maven.compiler.target>23</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>com.michael</groupId>
+                <artifactId>service-container-server-bom</artifactId>
+                <version>${project.version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.hibernate.validator</groupId>
+            <artifactId>hibernate-validator</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-params</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+        </dependency>
+    </dependencies>
+
+</project>

server/src/main/java/com/michael/container/validation/annotation/HttpUrl.java → server-contract/src/main/java/com/michael/contract/resources/validations/annotations/HttpUrl.java

@@ -1,6 +1,6 @@
-package com.michael.container.validation.annotation;
+package com.michael.contract.resources.validations.annotations;
 
-import com.michael.container.validation.handler.HttpUrlValidationHandler;
+import com.michael.contract.resources.validations.handlers.HttpUrlValidationHandler;
 import jakarta.validation.Constraint;
 import jakarta.validation.Payload;
 import jakarta.validation.constraints.NotNull;

server/src/main/java/com/michael/container/heartbeat/enums/HeartbeatEvent.java → server-contract/src/main/java/com/michael/contract/resources/validations/enums/HeartbeatEvent.java

@@ -1,4 +1,4 @@
-package com.michael.container.heartbeat.enums;
+package com.michael.contract.resources.validations.enums;
 
 public enum HeartbeatEvent {
   FOUND("Heartbeat Found"),

server/src/main/java/com/michael/container/registry/enums/Status.java → server-contract/src/main/java/com/michael/contract/resources/validations/enums/Status.java

@@ -1,4 +1,4 @@
-package com.michael.container.registry.enums;
+package com.michael.contract.resources.validations.enums;
 
 import java.util.Set;
 

server/src/main/java/com/michael/container/registry/enums/Tag.java → server-contract/src/main/java/com/michael/contract/resources/validations/enums/Tag.java

@@ -1,4 +1,4 @@
-package com.michael.container.registry.enums;
+package com.michael.contract.resources.validations.enums;
 
 public enum Tag {
   LANGUAGE,

server/src/main/java/com/michael/container/validation/handler/HttpUrlValidationHandler.java → server-contract/src/main/java/com/michael/contract/resources/validations/handlers/HttpUrlValidationHandler.java

@@ -1,6 +1,6 @@
-package com.michael.container.validation.handler;
+package com.michael.contract.resources.validations.handlers;
 
-import com.michael.container.validation.annotation.HttpUrl;
+import com.michael.contract.resources.validations.annotations.HttpUrl;
 import jakarta.validation.ConstraintValidator;
 import jakarta.validation.ConstraintValidatorContext;
 import java.net.URI;

server/src/main/java/com/michael/container/heartbeat/model/HeartbeatRequest.java → server-contract/src/main/java/com/michael/contract/resources/validations/requests/HeartbeatRequest.java

@@ -1,6 +1,6 @@
-package com.michael.container.heartbeat.model;
+package com.michael.contract.resources.validations.requests;
 
-import com.michael.container.validation.annotation.HttpUrl;
+import com.michael.contract.resources.validations.annotations.HttpUrl;
 import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotNull;
 

server/src/main/java/com/michael/container/registry/model/RegisterServiceRequest.java → server-contract/src/main/java/com/michael/contract/resources/validations/requests/RegisterServiceRequest.java

@@ -1,12 +1,12 @@
-package com.michael.container.registry.model;
+package com.michael.contract.resources.validations.requests;
 
-import com.michael.container.registry.enums.Tag;
-import com.michael.container.validation.annotation.HttpUrl;
+import com.michael.contract.resources.validations.annotations.HttpUrl;
+import com.michael.contract.resources.validations.enums.Tag;
 import io.swagger.v3.oas.annotations.media.Schema;
-import jakarta.annotation.Nullable;
 import jakarta.validation.constraints.NotNull;
 import java.util.Map;
 import java.util.Set;
+import org.springframework.lang.Nullable;
 
 public record RegisterServiceRequest(
     @NotNull

server/src/main/java/com/michael/container/registry/model/RemoveServiceRequest.java → server-contract/src/main/java/com/michael/contract/resources/validations/requests/RemoveServiceRequest.java

@@ -1,6 +1,6 @@
-package com.michael.container.registry.model;
+package com.michael.contract.resources.validations.requests;
 
-import com.michael.container.validation.annotation.HttpUrl;
+import com.michael.contract.resources.validations.annotations.HttpUrl;
 import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotNull;
 

server/src/main/java/com/michael/container/registry/model/UpdateStatusRequest.java → server-contract/src/main/java/com/michael/contract/resources/validations/requests/UpdateStatusRequest.java

@@ -1,7 +1,7 @@
-package com.michael.container.registry.model;
+package com.michael.contract.resources.validations.requests;
 
-import com.michael.container.registry.enums.Status;
-import com.michael.container.validation.annotation.HttpUrl;
+import com.michael.contract.resources.validations.annotations.HttpUrl;
+import com.michael.contract.resources.validations.enums.Status;
 import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotNull;
 

server-contract/src/main/java/com/michael/contract/resources/validations/responses/HeartbeatResponse.java

@@ -0,0 +1,6 @@
+package com.michael.contract.resources.validations.responses;
+
+import com.michael.contract.resources.validations.enums.HeartbeatEvent;
+import org.springframework.lang.NonNull;
+
+public record HeartbeatResponse(@NonNull HeartbeatEvent event, @NonNull String description) {}

server/src/main/java/com/michael/container/registry/model/RegisterServiceResponse.java → server-contract/src/main/java/com/michael/contract/resources/validations/responses/RegisterServiceResponse.java

@@ -1,7 +1,7 @@
-package com.michael.container.registry.model;
+package com.michael.contract.resources.validations.responses;
 
-import com.michael.container.registry.enums.Status;
-import com.michael.container.registry.enums.Tag;
+import com.michael.contract.resources.validations.enums.Status;
+import com.michael.contract.resources.validations.enums.Tag;
 import java.util.Map;
 import java.util.Set;
 import org.springframework.lang.NonNull;

server/src/test/java/com/michael/container/validation/handler/HttpHttpUrlValidationHandlerTest.java → server-contract/src/test/java/com/michael/contract/resources/validations/handlers/HttpUrlValidationHandlerTest.java

@@ -1,4 +1,4 @@
-package com.michael.container.validation.handler;
+package com.michael.contract.resources.validations.handlers;
 
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.extension.ExtendWith;

server/pom.xml

@@ -102,6 +102,12 @@
             <version>1.0.0</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>com.michael</groupId>
+            <artifactId>contract</artifactId>
+            <version>1.0.0</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
     <build>
         <plugins>

server/src/main/java/com/michael/container/health/routines/HealthCheckRoutine.java

@@ -1,6 +1,6 @@
 package com.michael.container.health.routines;
 
-import static com.michael.container.registry.enums.Status.STATUSES_TO_SKIP_HEARTBEAT;
+import static com.michael.contract.resources.validations.enums.Status.STATUSES_TO_SKIP_HEARTBEAT;
 
 import com.google.common.collect.Lists;
 import com.michael.container.annotations.SkipIfAutomationEnvironment;

server/src/main/java/com/michael/container/health/service/HealthCheckService.java

@@ -4,8 +4,8 @@
 import com.michael.container.health.exception.HealthCheckInvalidException;
 import com.michael.container.health.repositories.HealthQueueRepository;
 import com.michael.container.registry.cache.entity.HealthQueueEntity;
-import com.michael.container.registry.enums.Status;
 import com.michael.container.registry.model.StatusChangeEvent;
+import com.michael.contract.resources.validations.enums.Status;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.ExecutorService;

server/src/main/java/com/michael/container/heartbeat/controller/HeartbeatController.java

@@ -1,8 +1,8 @@
 package com.michael.container.heartbeat.controller;
 
-import com.michael.container.heartbeat.model.HeartbeatRequest;
-import com.michael.container.heartbeat.model.HeartbeatResponse;
 import com.michael.container.heartbeat.service.HeartbeatService;
+import com.michael.contract.resources.validations.requests.HeartbeatRequest;
+import com.michael.contract.resources.validations.responses.HeartbeatResponse;
 import com.michael.spring.utils.logger.annotations.ExecutionTime;
 import io.swagger.v3.oas.annotations.Operation;
 import jakarta.validation.Valid;

server/src/main/java/com/michael/container/heartbeat/service/HeartbeatService.java

@@ -1,10 +1,11 @@
 package com.michael.container.heartbeat.service;
 
-import com.michael.container.heartbeat.enums.HeartbeatEvent;
-import com.michael.container.heartbeat.model.HeartbeatRequest;
-import com.michael.container.heartbeat.model.HeartbeatResponse;
 import com.michael.container.registry.cache.crud.CrudRegistry;
-import com.michael.container.registry.model.RegisterServiceResponse;
+import com.michael.contract.resources.validations.enums.HeartbeatEvent;
+import com.michael.contract.resources.validations.enums.Status;
+import com.michael.contract.resources.validations.requests.HeartbeatRequest;
+import com.michael.contract.resources.validations.responses.HeartbeatResponse;
+import com.michael.contract.resources.validations.responses.RegisterServiceResponse;
 import jakarta.annotation.Nonnull;
 import org.springframework.stereotype.Service;
 
@@ -22,7 +23,7 @@ public HeartbeatService(CrudRegistry crudRegistry) {
    * If the application is not found in the registry, this method responds with {@link HeartbeatEvent#RE_REGISTER}.
    * If the application is found, it refreshes the Time-to-Live (TTL) of the service in the registry and returns
    * {@link HeartbeatEvent#FOUND}. Additionally, the service is transitioned from either the {@link com.michael.container.registry.enums.Status#STARTING}
-   * or {@link com.michael.container.registry.enums.Status#DOWN} state to {@link com.michael.container.registry.enums.Status#HEALTHY}.
+   * or {@link Status#DOWN} state to {@link Status#HEALTHY}.
    * </p>
    *
    * @param heartbeatRequest the {@link HeartbeatRequest} containing details about the service

server/src/main/java/com/michael/container/notifications/enums/StatusStateEvent.java

@@ -1,6 +1,6 @@
 package com.michael.container.notifications.enums;
 
-import com.michael.container.registry.enums.Status;
+import com.michael.contract.resources.validations.enums.Status;
 import jakarta.annotation.Nonnull;
 import java.util.Optional;
 

server/src/main/java/com/michael/container/notifications/fsm/status/FailState.java

@@ -4,10 +4,10 @@
 import com.michael.container.notifications.enums.StatusStateEvent;
 import com.michael.container.notifications.model.ServiceNotificationRequest;
 import com.michael.container.notifications.service.NotificationService;
-import com.michael.container.registry.enums.Status;
 import com.michael.container.registry.model.StatusChangeEvent;
-import com.michael.container.registry.model.UpdateStatusRequest;
 import com.michael.container.registry.service.ServiceRegistryService;
+import com.michael.contract.resources.validations.enums.Status;
+import com.michael.contract.resources.validations.requests.UpdateStatusRequest;
 import jakarta.annotation.Nonnull;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.stereotype.Component;

server/src/main/java/com/michael/container/notifications/fsm/status/StatusChangeOrchestrator.java

@@ -2,8 +2,8 @@
 
 import com.michael.container.notifications.enums.StatusStateEvent;
 import com.michael.container.registry.cache.entity.InstanceEntity;
-import com.michael.container.registry.enums.Status;
 import com.michael.container.registry.model.StatusChangeEvent;
+import com.michael.contract.resources.validations.enums.Status;
 import jakarta.annotation.Nonnull;
 import java.util.Map;
 import java.util.Set;

server/src/main/java/com/michael/container/notifications/service/RegisterNotificationService.java

@@ -8,7 +8,7 @@
 import com.michael.container.notifications.repositories.PendingServiceNotificationQueueRepository;
 import com.michael.container.registry.cache.crud.CrudRegistry;
 import com.michael.container.registry.cache.entity.PendingServiceNotificationEntity;
-import com.michael.container.registry.model.RegisterServiceResponse;
+import com.michael.contract.resources.validations.responses.RegisterServiceResponse;
 import com.michael.spring.utils.logger.annotations.ExecutionTime;
 import jakarta.annotation.Nonnull;
 import java.util.Set;

server/src/main/java/com/michael/container/registry/cache/crud/CrudRegistry.java

@@ -5,11 +5,11 @@
 import com.michael.container.registry.cache.entity.InstanceEntity;
 import com.michael.container.registry.cache.repositories.ApplicationRepository;
 import com.michael.container.registry.cache.repositories.InstanceRepository;
-import com.michael.container.registry.enums.Status;
 import com.michael.container.registry.model.DeregisterEvent;
-import com.michael.container.registry.model.RegisterServiceResponse;
 import com.michael.container.registry.model.StatusChangeEvent;
 import com.michael.container.utils.ContainerConstants;
+import com.michael.contract.resources.validations.enums.Status;
+import com.michael.contract.resources.validations.responses.RegisterServiceResponse;
 import jakarta.annotation.Nonnull;
 import java.util.HashMap;
 import java.util.HashSet;

server/src/main/java/com/michael/container/registry/cache/entity/InstanceEntity.java

@@ -1,8 +1,8 @@
 package com.michael.container.registry.cache.entity;
 
-import com.michael.container.registry.enums.Status;
-import com.michael.container.registry.enums.Tag;
 import com.michael.container.utils.ContainerConstants;
+import com.michael.contract.resources.validations.enums.Status;
+import com.michael.contract.resources.validations.enums.Tag;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;

server/src/main/java/com/michael/container/registry/cache/listener/key/ExpiredKeyListener.java

@@ -2,8 +2,8 @@
 
 import com.michael.container.distributed.election.enums.MethodAccess;
 import com.michael.container.registry.enums.Key;
-import com.michael.container.registry.model.RemoveServiceRequest;
 import com.michael.container.registry.service.ServiceRegistryService;
+import com.michael.contract.resources.validations.requests.RemoveServiceRequest;
 import java.util.Set;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;

server/src/main/java/com/michael/container/registry/controller/ServiceRegistryController.java

@@ -1,10 +1,10 @@
 package com.michael.container.registry.controller;
 
-import com.michael.container.registry.model.RegisterServiceRequest;
-import com.michael.container.registry.model.RegisterServiceResponse;
-import com.michael.container.registry.model.RemoveServiceRequest;
-import com.michael.container.registry.model.UpdateStatusRequest;
 import com.michael.container.registry.service.ServiceRegistryService;
+import com.michael.contract.resources.validations.requests.RegisterServiceRequest;
+import com.michael.contract.resources.validations.requests.RemoveServiceRequest;
+import com.michael.contract.resources.validations.requests.UpdateStatusRequest;
+import com.michael.contract.resources.validations.responses.RegisterServiceResponse;
 import com.michael.spring.utils.logger.annotations.ExecutionTime;
 import io.swagger.v3.oas.annotations.Operation;
 import jakarta.validation.Valid;

server/src/main/java/com/michael/container/registry/mapper/InstanceEntityToRegisterServiceResponseMapper.java

@@ -1,7 +1,7 @@
 package com.michael.container.registry.mapper;
 
 import com.michael.container.registry.cache.entity.InstanceEntity;
-import com.michael.container.registry.model.RegisterServiceResponse;
+import com.michael.contract.resources.validations.responses.RegisterServiceResponse;
 import jakarta.annotation.Nonnull;
 import org.springframework.core.convert.converter.Converter;
 import org.springframework.stereotype.Component;

server/src/main/java/com/michael/container/registry/mapper/RegisterServiceRequestToRegisterServiceResponseMapper.java

@@ -1,8 +1,8 @@
 package com.michael.container.registry.mapper;
 
-import com.michael.container.registry.enums.Status;
-import com.michael.container.registry.model.RegisterServiceRequest;
-import com.michael.container.registry.model.RegisterServiceResponse;
+import com.michael.contract.resources.validations.enums.Status;
+import com.michael.contract.resources.validations.requests.RegisterServiceRequest;
+import com.michael.contract.resources.validations.responses.RegisterServiceResponse;
 import jakarta.annotation.Nonnull;
 import java.util.HashMap;
 import java.util.HashSet;

server/src/main/java/com/michael/container/registry/mapper/RegisterServiceResponseToInstanceEntityMapper.java

@@ -1,7 +1,7 @@
 package com.michael.container.registry.mapper;
 
 import com.michael.container.registry.cache.entity.InstanceEntity;
-import com.michael.container.registry.model.RegisterServiceResponse;
+import com.michael.contract.resources.validations.responses.RegisterServiceResponse;
 import jakarta.annotation.Nonnull;
 import org.springframework.core.convert.converter.Converter;
 import org.springframework.stereotype.Component;

server/src/main/java/com/michael/container/registry/model/StatusChangeEvent.java

@@ -1,6 +1,6 @@
 package com.michael.container.registry.model;
 
-import com.michael.container.registry.enums.Status;
+import com.michael.contract.resources.validations.enums.Status;
 import jakarta.annotation.Nonnull;
 import jakarta.annotation.Nullable;
 

server/src/main/java/com/michael/container/registry/service/ServiceRegistryService.java

@@ -1,10 +1,10 @@
 package com.michael.container.registry.service;
 
 import com.michael.container.registry.cache.crud.CrudRegistry;
-import com.michael.container.registry.model.RegisterServiceRequest;
-import com.michael.container.registry.model.RegisterServiceResponse;
-import com.michael.container.registry.model.RemoveServiceRequest;
-import com.michael.container.registry.model.UpdateStatusRequest;
+import com.michael.contract.resources.validations.requests.RegisterServiceRequest;
+import com.michael.contract.resources.validations.requests.RemoveServiceRequest;
+import com.michael.contract.resources.validations.requests.UpdateStatusRequest;
+import com.michael.contract.resources.validations.responses.RegisterServiceResponse;
 import jakarta.annotation.Nonnull;
 import java.util.HashSet;
 import java.util.Map;

server/src/test/java/com/michael/container/health/routines/HealthCheckRoutineTest.java

@@ -7,7 +7,7 @@
 import com.michael.container.registry.cache.entity.ApplicationEntity;
 import com.michael.container.registry.cache.entity.InstanceEntity;
 import com.michael.container.registry.cache.repositories.ApplicationRepository;
-import com.michael.container.registry.enums.Status;
+import com.michael.contract.resources.validations.enums.Status;
 import java.util.Collections;
 import java.util.Set;
 import org.junit.jupiter.api.Test;