diff --git a/README.md b/README.md index 7ed7e70..876c65d 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,11 @@ -# Instructions for using the template - -## Introduction - -This template is based upon best practices and uses Spring Boot to implement -REST APIs. - -## Steps - -* clone the project and create a new repository -* replace all occurences of 'template' with your service name, 'Template' accordingly (mind the cases) -* import the project in your IDE -* run initial `gradlew build` - -**============ // todo: Ab hier die Doku überprüfen und ggf. ergänzen ==========** - -# Template -**// todo: Hier sollte das Projekt etwas beschrieben werden** +# OParl Service ## Git -The repository of ... is located under https://git.2martens.de/2martens/template-service.git +The repository of the OParl service is located under https://git.2martens.de/2martens/oparl-service.git It is partially encrypted with git-crypt and has to be decrypted first: ```bash -git-crypt unlock %USERPROFILE%/.git-crypt-key +git-crypt unlock %USERPROFILE%/.my-git-crypt-key ``` diff --git a/gradle.properties b/gradle.properties index 0e628ab..2c94855 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,4 +1,4 @@ -projectname=template-service +projectname=oparl-service projectgroup=de.twomartens projectSourceCompatibility=11 org.gradle.daemon=true diff --git a/template-server/template-server.gradle b/oparl-server/oparl-server.gradle similarity index 100% rename from template-server/template-server.gradle rename to oparl-server/oparl-server.gradle diff --git a/template-server/src/integration-test/java/de/twomartens/templateservice/TemplateServiceRestTests.java b/oparl-server/src/integration-test/java/de/twomartens/oparlservice/OParlServiceRestTests.java similarity index 86% rename from template-server/src/integration-test/java/de/twomartens/templateservice/TemplateServiceRestTests.java rename to oparl-server/src/integration-test/java/de/twomartens/oparlservice/OParlServiceRestTests.java index 5914dc0..ee6d7b3 100644 --- a/template-server/src/integration-test/java/de/twomartens/templateservice/TemplateServiceRestTests.java +++ b/oparl-server/src/integration-test/java/de/twomartens/oparlservice/OParlServiceRestTests.java @@ -1,8 +1,8 @@ -package de.twomartens.templateservice; +package de.twomartens.oparlservice; -import de.twomartens.templateservice.entity.Greeting; -import de.twomartens.templateservice.interceptors.RequestTypeInterceptor; -import de.twomartens.templateservice.interceptors.TraceIdInterceptor; +import de.twomartens.oparlservice.entity.Greeting; +import de.twomartens.oparlservice.interceptors.RequestTypeInterceptor; +import de.twomartens.oparlservice.interceptors.TraceIdInterceptor; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -17,7 +17,7 @@ import static org.springframework.boot.test.context.SpringBootTest.WebEnvironmen @SpringJUnitConfig @SpringBootTest(webEnvironment = RANDOM_PORT) -class TemplateServiceRestTests { +class OParlServiceRestTests { @Autowired private RestTemplate restTemplate; diff --git a/template-server/src/main/java/de/twomartens/templateservice/TemplateServiceApplication.java b/oparl-server/src/main/java/de/twomartens/oparlservice/OParlServiceApplication.java similarity index 61% rename from template-server/src/main/java/de/twomartens/templateservice/TemplateServiceApplication.java rename to oparl-server/src/main/java/de/twomartens/oparlservice/OParlServiceApplication.java index da90139..c98fae8 100644 --- a/template-server/src/main/java/de/twomartens/templateservice/TemplateServiceApplication.java +++ b/oparl-server/src/main/java/de/twomartens/oparlservice/OParlServiceApplication.java @@ -1,4 +1,4 @@ -package de.twomartens.templateservice; +package de.twomartens.oparlservice; import lombok.extern.slf4j.Slf4j; import org.springframework.boot.SpringApplication; @@ -10,20 +10,20 @@ import java.util.Optional; @Slf4j @SpringBootApplication @EnableScheduling -public class TemplateServiceApplication { +public class OParlServiceApplication { public static void main(String[] args) { log.info(">>> {}:{} <<<", getTitle(), getVersion()); - SpringApplication.run(TemplateServiceApplication.class, args); + SpringApplication.run(OParlServiceApplication.class, args); } private static String getTitle() { - return Optional.ofNullable(TemplateServiceApplication.class.getPackage().getImplementationTitle()) + return Optional.ofNullable(OParlServiceApplication.class.getPackage().getImplementationTitle()) .orElse("start"); } private static String getVersion() { - return Optional.ofNullable(TemplateServiceApplication.class.getPackage().getImplementationVersion()) + return Optional.ofNullable(OParlServiceApplication.class.getPackage().getImplementationVersion()) .orElse("snapshot"); } } diff --git a/template-server/src/main/java/de/twomartens/templateservice/actuator/AbstractHealthCheck.java b/oparl-server/src/main/java/de/twomartens/oparlservice/actuator/AbstractHealthCheck.java similarity index 90% rename from template-server/src/main/java/de/twomartens/templateservice/actuator/AbstractHealthCheck.java rename to oparl-server/src/main/java/de/twomartens/oparlservice/actuator/AbstractHealthCheck.java index 8b5ffb5..56c1c41 100644 --- a/template-server/src/main/java/de/twomartens/templateservice/actuator/AbstractHealthCheck.java +++ b/oparl-server/src/main/java/de/twomartens/oparlservice/actuator/AbstractHealthCheck.java @@ -1,7 +1,7 @@ -package de.twomartens.templateservice.actuator; +package de.twomartens.oparlservice.actuator; -import de.twomartens.templateservice.interceptors.RequestTypeInterceptor; -import de.twomartens.templateservice.interceptors.TraceIdInterceptor; +import de.twomartens.oparlservice.interceptors.RequestTypeInterceptor; +import de.twomartens.oparlservice.interceptors.TraceIdInterceptor; import lombok.extern.slf4j.Slf4j; import org.springframework.boot.actuate.health.Health; import org.springframework.boot.actuate.health.HealthIndicator; diff --git a/template-server/src/main/java/de/twomartens/templateservice/actuator/RestHealthCheck.java b/oparl-server/src/main/java/de/twomartens/oparlservice/actuator/RestHealthCheck.java similarity index 86% rename from template-server/src/main/java/de/twomartens/templateservice/actuator/RestHealthCheck.java rename to oparl-server/src/main/java/de/twomartens/oparlservice/actuator/RestHealthCheck.java index 02aef92..9919e6f 100644 --- a/template-server/src/main/java/de/twomartens/templateservice/actuator/RestHealthCheck.java +++ b/oparl-server/src/main/java/de/twomartens/oparlservice/actuator/RestHealthCheck.java @@ -1,8 +1,8 @@ -package de.twomartens.templateservice.actuator; +package de.twomartens.oparlservice.actuator; -import de.twomartens.templateservice.entity.Greeting; -import de.twomartens.templateservice.interceptors.RequestTypeInterceptor; -import de.twomartens.templateservice.interceptors.TraceIdInterceptor; +import de.twomartens.oparlservice.entity.Greeting; +import de.twomartens.oparlservice.interceptors.RequestTypeInterceptor; +import de.twomartens.oparlservice.interceptors.TraceIdInterceptor; import lombok.extern.slf4j.Slf4j; import org.springframework.boot.actuate.health.HealthIndicator; import org.springframework.boot.autoconfigure.web.ServerProperties; diff --git a/template-server/src/main/java/de/twomartens/templateservice/configs/TemplateServiceProperties.java b/oparl-server/src/main/java/de/twomartens/oparlservice/configs/OParlServiceProperties.java similarity index 66% rename from template-server/src/main/java/de/twomartens/templateservice/configs/TemplateServiceProperties.java rename to oparl-server/src/main/java/de/twomartens/oparlservice/configs/OParlServiceProperties.java index 9b527a4..4370b9e 100644 --- a/template-server/src/main/java/de/twomartens/templateservice/configs/TemplateServiceProperties.java +++ b/oparl-server/src/main/java/de/twomartens/oparlservice/configs/OParlServiceProperties.java @@ -1,4 +1,4 @@ -package de.twomartens.templateservice.configs; +package de.twomartens.oparlservice.configs; import lombok.Data; import org.springframework.boot.context.properties.ConfigurationProperties; @@ -6,8 +6,8 @@ import org.springframework.context.annotation.Configuration; @Data @Configuration -@ConfigurationProperties(prefix = "de.twomartens.templateservice") -public class TemplateServiceProperties { +@ConfigurationProperties(prefix = "de.twomartens.oparlservice") +public class OParlServiceProperties { private final Template template = new Template(); diff --git a/template-server/src/main/java/de/twomartens/templateservice/configs/WebConfig.java b/oparl-server/src/main/java/de/twomartens/oparlservice/configs/WebConfig.java similarity index 89% rename from template-server/src/main/java/de/twomartens/templateservice/configs/WebConfig.java rename to oparl-server/src/main/java/de/twomartens/oparlservice/configs/WebConfig.java index ba93e6b..8e75363 100644 --- a/template-server/src/main/java/de/twomartens/templateservice/configs/WebConfig.java +++ b/oparl-server/src/main/java/de/twomartens/oparlservice/configs/WebConfig.java @@ -1,7 +1,7 @@ -package de.twomartens.templateservice.configs; +package de.twomartens.oparlservice.configs; -import de.twomartens.templateservice.interceptors.RequestTypeInterceptor; -import de.twomartens.templateservice.interceptors.TraceIdInterceptor; +import de.twomartens.oparlservice.interceptors.RequestTypeInterceptor; +import de.twomartens.oparlservice.interceptors.TraceIdInterceptor; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.http.client.ClientHttpRequestInterceptor; diff --git a/template-server/src/main/java/de/twomartens/templateservice/control/GreetingController.java b/oparl-server/src/main/java/de/twomartens/oparlservice/control/GreetingController.java similarity index 80% rename from template-server/src/main/java/de/twomartens/templateservice/control/GreetingController.java rename to oparl-server/src/main/java/de/twomartens/oparlservice/control/GreetingController.java index 06f530a..9449f4a 100644 --- a/template-server/src/main/java/de/twomartens/templateservice/control/GreetingController.java +++ b/oparl-server/src/main/java/de/twomartens/oparlservice/control/GreetingController.java @@ -1,7 +1,7 @@ -package de.twomartens.templateservice.control; +package de.twomartens.oparlservice.control; -import de.twomartens.templateservice.entity.Greeting; -import de.twomartens.templateservice.service.GreetingService; +import de.twomartens.oparlservice.entity.Greeting; +import de.twomartens.oparlservice.service.GreetingService; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.ResponseBody; diff --git a/template-server/src/main/java/de/twomartens/templateservice/entity/Greeting.java b/oparl-server/src/main/java/de/twomartens/oparlservice/entity/Greeting.java similarity index 88% rename from template-server/src/main/java/de/twomartens/templateservice/entity/Greeting.java rename to oparl-server/src/main/java/de/twomartens/oparlservice/entity/Greeting.java index 20460eb..98708ff 100644 --- a/template-server/src/main/java/de/twomartens/templateservice/entity/Greeting.java +++ b/oparl-server/src/main/java/de/twomartens/oparlservice/entity/Greeting.java @@ -1,4 +1,4 @@ -package de.twomartens.templateservice.entity; +package de.twomartens.oparlservice.entity; import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; diff --git a/template-server/src/main/java/de/twomartens/templateservice/interceptors/RequestTypeInterceptor.java b/oparl-server/src/main/java/de/twomartens/oparlservice/interceptors/RequestTypeInterceptor.java similarity index 96% rename from template-server/src/main/java/de/twomartens/templateservice/interceptors/RequestTypeInterceptor.java rename to oparl-server/src/main/java/de/twomartens/oparlservice/interceptors/RequestTypeInterceptor.java index 27cebfd..8a263f0 100644 --- a/template-server/src/main/java/de/twomartens/templateservice/interceptors/RequestTypeInterceptor.java +++ b/oparl-server/src/main/java/de/twomartens/oparlservice/interceptors/RequestTypeInterceptor.java @@ -1,4 +1,4 @@ -package de.twomartens.templateservice.interceptors; +package de.twomartens.oparlservice.interceptors; import lombok.NoArgsConstructor; import org.slf4j.MDC; diff --git a/template-server/src/main/java/de/twomartens/templateservice/interceptors/TraceIdInterceptor.java b/oparl-server/src/main/java/de/twomartens/oparlservice/interceptors/TraceIdInterceptor.java similarity index 98% rename from template-server/src/main/java/de/twomartens/templateservice/interceptors/TraceIdInterceptor.java rename to oparl-server/src/main/java/de/twomartens/oparlservice/interceptors/TraceIdInterceptor.java index b262f35..7942284 100644 --- a/template-server/src/main/java/de/twomartens/templateservice/interceptors/TraceIdInterceptor.java +++ b/oparl-server/src/main/java/de/twomartens/oparlservice/interceptors/TraceIdInterceptor.java @@ -1,4 +1,4 @@ -package de.twomartens.templateservice.interceptors; +package de.twomartens.oparlservice.interceptors; import lombok.NoArgsConstructor; import org.slf4j.MDC; diff --git a/template-server/src/main/java/de/twomartens/templateservice/service/GreetingService.java b/oparl-server/src/main/java/de/twomartens/oparlservice/service/GreetingService.java similarity index 73% rename from template-server/src/main/java/de/twomartens/templateservice/service/GreetingService.java rename to oparl-server/src/main/java/de/twomartens/oparlservice/service/GreetingService.java index 3c8dd04..20bfdb7 100644 --- a/template-server/src/main/java/de/twomartens/templateservice/service/GreetingService.java +++ b/oparl-server/src/main/java/de/twomartens/oparlservice/service/GreetingService.java @@ -1,6 +1,6 @@ -package de.twomartens.templateservice.service; +package de.twomartens.oparlservice.service; -import de.twomartens.templateservice.configs.TemplateServiceProperties; +import de.twomartens.oparlservice.configs.OParlServiceProperties; import io.micrometer.core.instrument.Counter; import io.micrometer.core.instrument.MeterRegistry; import lombok.extern.slf4j.Slf4j; @@ -11,10 +11,10 @@ import org.springframework.stereotype.Service; public class GreetingService { private final MeterRegistry meterRegistry; - private final TemplateServiceProperties properties; + private final OParlServiceProperties properties; private final Counter counter; - public GreetingService(MeterRegistry meterRegistry, TemplateServiceProperties properties) { + public GreetingService(MeterRegistry meterRegistry, OParlServiceProperties properties) { this.meterRegistry = meterRegistry; this.properties = properties; counter = meterRegistry.counter("infodb.callCounter"); diff --git a/oparl-server/src/main/resources/application-prod.yaml b/oparl-server/src/main/resources/application-prod.yaml new file mode 100644 index 0000000..55c0c9c Binary files /dev/null and b/oparl-server/src/main/resources/application-prod.yaml differ diff --git a/oparl-server/src/main/resources/application-qs.yaml b/oparl-server/src/main/resources/application-qs.yaml new file mode 100644 index 0000000..55c0c9c Binary files /dev/null and b/oparl-server/src/main/resources/application-qs.yaml differ diff --git a/oparl-server/src/main/resources/application-test.yaml b/oparl-server/src/main/resources/application-test.yaml new file mode 100644 index 0000000..55c0c9c Binary files /dev/null and b/oparl-server/src/main/resources/application-test.yaml differ diff --git a/oparl-server/src/main/resources/application.yaml b/oparl-server/src/main/resources/application.yaml new file mode 100644 index 0000000..55c0c9c Binary files /dev/null and b/oparl-server/src/main/resources/application.yaml differ diff --git a/template-server/src/main/resources/log4j2.xml b/oparl-server/src/main/resources/log4j2.xml similarity index 100% rename from template-server/src/main/resources/log4j2.xml rename to oparl-server/src/main/resources/log4j2.xml diff --git a/template-server/src/test/java/de/twomartens/templateservice/control/GreetingControllerTests.java b/oparl-server/src/test/java/de/twomartens/oparlservice/control/GreetingControllerTests.java similarity index 92% rename from template-server/src/test/java/de/twomartens/templateservice/control/GreetingControllerTests.java rename to oparl-server/src/test/java/de/twomartens/oparlservice/control/GreetingControllerTests.java index 322cd7e..8c6429c 100644 --- a/template-server/src/test/java/de/twomartens/templateservice/control/GreetingControllerTests.java +++ b/oparl-server/src/test/java/de/twomartens/oparlservice/control/GreetingControllerTests.java @@ -1,6 +1,6 @@ -package de.twomartens.templateservice.control; +package de.twomartens.oparlservice.control; -import de.twomartens.templateservice.service.GreetingService; +import de.twomartens.oparlservice.service.GreetingService; import org.hamcrest.Matchers; import org.junit.jupiter.api.Test; import org.mockito.BDDMockito; diff --git a/template-server/src/test/java/de/twomartens/templateservice/service/GreetingServiceTest.java b/oparl-server/src/test/java/de/twomartens/oparlservice/service/GreetingServiceTest.java similarity index 79% rename from template-server/src/test/java/de/twomartens/templateservice/service/GreetingServiceTest.java rename to oparl-server/src/test/java/de/twomartens/oparlservice/service/GreetingServiceTest.java index 0c05e66..433fcb7 100644 --- a/template-server/src/test/java/de/twomartens/templateservice/service/GreetingServiceTest.java +++ b/oparl-server/src/test/java/de/twomartens/oparlservice/service/GreetingServiceTest.java @@ -1,6 +1,6 @@ -package de.twomartens.templateservice.service; +package de.twomartens.oparlservice.service; -import de.twomartens.templateservice.configs.TemplateServiceProperties; +import de.twomartens.oparlservice.configs.OParlServiceProperties; import io.micrometer.core.instrument.simple.SimpleMeterRegistry; import org.assertj.core.api.Assertions; import org.junit.jupiter.api.BeforeEach; @@ -17,10 +17,10 @@ class GreetingServiceTest { private GreetingService service; @Mock - private TemplateServiceProperties properties; + private OParlServiceProperties properties; @Mock - private TemplateServiceProperties.Template template; + private OParlServiceProperties.Template template; @BeforeEach void beforeEach() { diff --git a/settings.gradle b/settings.gradle index 0a744a9..1a318c7 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1,6 +1,6 @@ rootProject.name = projectname -include 'template-server' +include 'oparl-server' rootProject.children.each { subproject -> subproject.buildFileName = "${subproject.name}.gradle" diff --git a/template-server/src/main/resources/application-prod.yaml b/template-server/src/main/resources/application-prod.yaml deleted file mode 100644 index e24bd43..0000000 Binary files a/template-server/src/main/resources/application-prod.yaml and /dev/null differ diff --git a/template-server/src/main/resources/application-qs.yaml b/template-server/src/main/resources/application-qs.yaml deleted file mode 100644 index e24bd43..0000000 Binary files a/template-server/src/main/resources/application-qs.yaml and /dev/null differ diff --git a/template-server/src/main/resources/application-test.yaml b/template-server/src/main/resources/application-test.yaml deleted file mode 100644 index e24bd43..0000000 Binary files a/template-server/src/main/resources/application-test.yaml and /dev/null differ diff --git a/template-server/src/main/resources/application.yaml b/template-server/src/main/resources/application.yaml deleted file mode 100644 index e24bd43..0000000 Binary files a/template-server/src/main/resources/application.yaml and /dev/null differ