From 8db5b1fd7e0272c4c308816e6beaa206612ba554 Mon Sep 17 00:00:00 2001 From: q3769 Date: Tue, 21 Mar 2023 12:00:14 -0500 Subject: [PATCH] rename --- README.md | 30 +++++++++---------- pom.xml | 16 +++++----- .../META-INF/services/elf4j.spi.LoggerFactory | 2 +- .../{impl => provider}/IntegrationTest.java | 4 +-- .../{impl => provider}/SampleUsageTest.java | 2 +- src/test/resources/elf4j-test.properties | 1 - 6 files changed, 27 insertions(+), 28 deletions(-) rename src/test/java/elf4j/{impl => provider}/IntegrationTest.java (96%) rename src/test/java/elf4j/{impl => provider}/SampleUsageTest.java (99%) diff --git a/README.md b/README.md index 8c6a77a..1900130 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# elf4j-impl +# elf4j-provider -A native log service provider implementation of [ELF4J](https://github.com/elf4j/elf4j) (Easy Logging Facade for Java), -and a complete drop-in logging solution for any Java application +A native log _service provider_ implementation of [ELF4J](https://github.com/elf4j/elf4j) (Easy Logging Facade for +Java), and a complete drop-in logging solution for any Java application ## User Story -As an application developer using ELF4J for logging, I want to have the option of using a runtime log service -provider that natively implements the [API and SPI](https://github.com/elf4j/elf4j#service-interface-and-access-api) of +As an application developer using the ELF4J logging facade, I want to have the option of using a runtime log _service +provider_ that natively implements the [API and SPI](https://github.com/elf4j/elf4j#service-interface-and-access-api) of ELF4J. ## Prerequisite @@ -17,9 +17,9 @@ Java 8 or better * Guiding principle: Reasonable default and Pareto's 80/20 rule -* This is simply a packaging unit of the [elf4j-impl-core](https://github.com/elf4j/elf4j-impl-core) logging library, - using the Java [Service Provider Framework](https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html) - mechanism. See [elf4j-impl-core](https://github.com/elf4j/elf4j-impl-core) for implementation detail. +* This is simply a packaging unit of the [elf4j-engine](https://github.com/elf4j/elf4j-engine), using the + Java [Service Provider Framework](https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html) mechanism. + See [elf4j-engine](https://github.com/elf4j/elf4j-engine) for implementation details. ## Features @@ -50,7 +50,7 @@ Java 8 or better ## Get It... -[![Maven Central](https://img.shields.io/maven-central/v/io.github.elf4j/elf4j-impl.svg?label=Maven%20Central)](https://central.sonatype.com/search?smo=true&q=pkg%253Amaven%252Fio.github.elf4j%252Felf4j-impl) +[![Maven Central](https://img.shields.io/maven-central/v/io.github.elf4j/elf4j-provider.svg?label=Maven%20Central)](https://central.sonatype.com/search?smo=true&q=pkg%253Amaven%252Fio.github.elf4j%252Felf4j-provider) ## Use It... @@ -67,7 +67,7 @@ this provider implementation as a runtime-scope dependency in Maven or other bui io.github.elf4j - elf4j-impl + elf4j-provider runtime ... @@ -76,7 +76,7 @@ this provider implementation as a runtime-scope dependency in Maven or other bui In case of multiple ELF4J service providers in classpath, pick this one like so: ``` -java -Delf4j.logger.factory.fqcn="elf4j.impl.core.NativeLoggerFactory" MyApplication +java -Delf4j.logger.factory.fqcn="elf4j.engine.NativeLoggerFactory" MyApplication ``` More details [here](https://github.com/elf4j/elf4j#no-op-by-default). @@ -129,11 +129,11 @@ See ELF4J facade [usage sample](https://github.com/elf4j/elf4j#for-logging-servi * Output samples * Line-based Default ``` - 2023-03-14T21:21:33.118-05:00 INFO [main] elf4j.impl.core.IntegrationTest$defaultLogger - Hello, world! + 2023-03-14T21:21:33.118-05:00 INFO [main] elf4j.provider.core.IntegrationTest$defaultLogger - Hello, world! ``` * JSON Default (one-line, minified, no thread or caller detail) ```json - {"timestamp":"2023-03-14T21:21:33.1180212-05:00","level":"INFO","callerClass":"elf4j.impl.core.IntegrationTest$defaultLogger","message":"Hello, world!"} + {"timestamp":"2023-03-14T21:21:33.1180212-05:00","level":"INFO","callerClass":"elf4j.providerider.core.IntegrationTest$defaultLogger","message":"Hello, world!"} ``` * JSON Custom (pretty print, with thread and caller detail) ```json @@ -145,7 +145,7 @@ See ELF4J facade [usage sample](https://github.com/elf4j/elf4j#for-logging-servi "id": 1 }, "callerDetail": { - "className": "elf4j.impl.core.IntegrationTest$defaultLogger", + "className": "elf4j.providerider.core.IntegrationTest$defaultLogger", "methodName": "hey", "lineNumber": 41, "fileName": "IntegrationTest.java" @@ -164,7 +164,7 @@ See ELF4J facade [usage sample](https://github.com/elf4j/elf4j#for-logging-servi ### This override the default global level level=info ### These override level of all caller classes included the specified package - #level@elf4j.impl=error + #level@elf4j.providerider=error level@org.springframework=warn ### Any writer is optional, default to a single standard writer if no writer configured writer1=standard diff --git a/pom.xml b/pom.xml index d122de9..c204d11 100644 --- a/pom.xml +++ b/pom.xml @@ -30,14 +30,14 @@ 4.0.0 io.github.elf4j - elf4j-impl - 1.0.1 + elf4j-provider + 2.0.0 jar - elf4j-impl + elf4j-provider Native logging service provider implementation of ELF4J (Easy Logging Facade For Java) - https://github.com/elf4j/elf4j-impl + https://github.com/elf4j/elf4j-provider MIT License @@ -45,12 +45,12 @@ - https://github.com/elf4j/elf4j-impl/tree/main + https://github.com/elf4j/elf4j-provider/tree/main - scm:git:git://github.com:elf4j/elf4j-impl.git + scm:git:git://github.com:elf4j/elf4j-provider.git - scm:git:ssh://github.com:elf4j/elf4j-impl.git + scm:git:ssh://github.com:elf4j/elf4j-provider.git @@ -67,7 +67,7 @@ io.github.elf4j - elf4j-impl-core + elf4j-engine 1.0.0 diff --git a/src/main/resources/META-INF/services/elf4j.spi.LoggerFactory b/src/main/resources/META-INF/services/elf4j.spi.LoggerFactory index 3a0aae1..8df603a 100644 --- a/src/main/resources/META-INF/services/elf4j.spi.LoggerFactory +++ b/src/main/resources/META-INF/services/elf4j.spi.LoggerFactory @@ -23,5 +23,5 @@ # # -elf4j.impl.core.NativeLoggerFactory +elf4j.engine.NativeLoggerFactory #elf4j.util.NoopLoggerFactory \ No newline at end of file diff --git a/src/test/java/elf4j/impl/IntegrationTest.java b/src/test/java/elf4j/provider/IntegrationTest.java similarity index 96% rename from src/test/java/elf4j/impl/IntegrationTest.java rename to src/test/java/elf4j/provider/IntegrationTest.java index 3a738ca..feb8f0b 100644 --- a/src/test/java/elf4j/impl/IntegrationTest.java +++ b/src/test/java/elf4j/provider/IntegrationTest.java @@ -23,10 +23,10 @@ * */ -package elf4j.impl; +package elf4j.provider; import elf4j.Logger; -import elf4j.impl.core.NativeLogger; +import elf4j.engine.NativeLogger; import org.junit.jupiter.api.Nested; import org.junit.jupiter.api.Test; diff --git a/src/test/java/elf4j/impl/SampleUsageTest.java b/src/test/java/elf4j/provider/SampleUsageTest.java similarity index 99% rename from src/test/java/elf4j/impl/SampleUsageTest.java rename to src/test/java/elf4j/provider/SampleUsageTest.java index 9bc15b9..428a40f 100644 --- a/src/test/java/elf4j/impl/SampleUsageTest.java +++ b/src/test/java/elf4j/provider/SampleUsageTest.java @@ -23,7 +23,7 @@ * */ -package elf4j.impl; +package elf4j.provider; import elf4j.Logger; import org.junit.jupiter.api.Nested; diff --git a/src/test/resources/elf4j-test.properties b/src/test/resources/elf4j-test.properties index fc95ba0..672ef8b 100644 --- a/src/test/resources/elf4j-test.properties +++ b/src/test/resources/elf4j-test.properties @@ -28,7 +28,6 @@ ### This override the default global level level=info ### These override level of all caller classes included the specified package -#level@elf4j.impl=error level@org.springframework=warn ### Any writer is optional, default to a single standard writer if no writer configured writer1=standard