Minor refactor of logging API 19/28119/1
authorvempo <vitaliy.emporopulo@amdocs.com>
Sun, 14 Jan 2018 14:01:12 +0000 (16:01 +0200)
committervempo <vitaliy.emporopulo@amdocs.com>
Sun, 14 Jan 2018 14:01:12 +0000 (16:01 +0200)
Change-Id: I926ba95c7145eb98aade3f9009a252ad995a346d
Issue-ID: SDC-772
Signed-off-by: vempo <vitaliy.emporopulo@amdocs.com>
13 files changed:
openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/main/java/org/openecomp/sdc/logging/api/LoggerFactory.java
openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/main/java/org/openecomp/sdc/logging/api/LoggingContext.java
openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/main/java/org/openecomp/sdc/logging/api/ServiceBinder.java
openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/main/java/org/openecomp/sdc/logging/spi/LoggerCreationService.java [moved from openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/main/java/org/openecomp/sdc/logging/provider/LoggerCreationService.java with 95% similarity]
openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/main/java/org/openecomp/sdc/logging/spi/LoggingContextService.java [moved from openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/main/java/org/openecomp/sdc/logging/provider/LoggingContextService.java with 94% similarity]
openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/main/java/org/openecomp/sdc/logging/spi/LoggingServiceProvider.java [moved from openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/main/java/org/openecomp/sdc/logging/provider/LoggingServiceProvider.java with 96% similarity]
openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/test/java/org/openecomp/sdc/logging/api/LoggingContextTest.java
openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-core/src/main/java/org/openecomp/sdc/logging/slf4j/SLF4JLoggingServiceProvider.java
openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-core/src/main/resources/META-INF/services/org.openecomp.sdc.logging.spi.LoggingServiceProvider [moved from openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-core/src/main/resources/META-INF/services/org.openecomp.sdc.logging.provider.LoggingServiceProvider with 100% similarity]
openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-core/src/test/java/org/openecomp/sdc/logging/slf4j/BaseContextPropagationTest.java
openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-core/src/test/java/org/openecomp/sdc/logging/slf4j/CallableContextPropagationTest.java
openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-core/src/test/java/org/openecomp/sdc/logging/slf4j/LoggingContextTest.java
openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-core/src/test/java/org/openecomp/sdc/logging/slf4j/RunnableContextPropagationTest.java

index 542f709..f827fec 100644 (file)
@@ -16,7 +16,7 @@
 
 package org.openecomp.sdc.logging.api;
 
-import org.openecomp.sdc.logging.provider.LoggingContextService;
+import org.openecomp.sdc.logging.spi.LoggingContextService;
 
 import java.util.Objects;
 import java.util.concurrent.Callable;
@@ -59,12 +59,12 @@ public class LoggingContext {
         SERVICE.clear();
     }
 
-    public static Runnable toRunnable(Runnable runnable) {
-        return SERVICE.toRunnable(runnable);
+    public static Runnable copyToRunnable(Runnable runnable) {
+        return SERVICE.copyToRunnable(runnable);
     }
 
-    public static <V> Callable<V> toCallable(Callable<V> callable) {
-        return SERVICE.toCallable(callable);
+    public static <V> Callable<V> copyToCallable(Callable<V> callable) {
+        return SERVICE.copyToCallable(callable);
     }
 
     private static class NoOpLoggingContextService implements LoggingContextService {
@@ -95,13 +95,13 @@ public class LoggingContext {
         }
 
         @Override
-        public Runnable toRunnable(Runnable runnable) {
+        public Runnable copyToRunnable(Runnable runnable) {
             Objects.requireNonNull(runnable, "Runnable cannot be null");
             return runnable;
         }
 
         @Override
-        public <V> Callable<V> toCallable(Callable<V> callable) {
+        public <V> Callable<V> copyToCallable(Callable<V> callable) {
             Objects.requireNonNull(callable, "Callable cannot be null");
             return callable;
         }
index b16f394..e3c9ea0 100644 (file)
@@ -16,9 +16,9 @@
 
 package org.openecomp.sdc.logging.api;
 
-import org.openecomp.sdc.logging.provider.LoggerCreationService;
-import org.openecomp.sdc.logging.provider.LoggingContextService;
-import org.openecomp.sdc.logging.provider.LoggingServiceProvider;
+import org.openecomp.sdc.logging.spi.LoggerCreationService;
+import org.openecomp.sdc.logging.spi.LoggingContextService;
+import org.openecomp.sdc.logging.spi.LoggingServiceProvider;
 
 import java.util.Iterator;
 import java.util.Optional;
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.openecomp.sdc.logging.provider;
+package org.openecomp.sdc.logging.spi;
 
 import java.util.concurrent.Callable;
 
@@ -60,11 +60,11 @@ public interface LoggingContextService {
      * Copies logging context of current thread onto a {@link Runnable}, so that the context is available
      * when this {@link Runnable} runs in another thread.
      */
-    Runnable toRunnable(Runnable runnable);
+    Runnable copyToRunnable(Runnable runnable);
 
     /**
      * Copies logging context of current thread onto a {@link Callable}, so that the context is available
      * when this {@link Callable} runs in another thread
      */
-    <V> Callable<V> toCallable(Callable<V> callable);
+    <V> Callable<V> copyToCallable(Callable<V> callable);
 }
index 7899eeb..79252cd 100644 (file)
@@ -80,22 +80,22 @@ public class LoggingContextTest {
     @Test
     public void toRunnableReturnsSameInstance() {
         Runnable test = () -> { /* do nothing */ };
-        assertTrue(test == LoggingContext.toRunnable(test));
+        assertTrue(test == LoggingContext.copyToRunnable(test));
     }
 
     @Test(expectedExceptions = NullPointerException.class)
     public void throwNpeWhenToRunnableWithNull() {
-        LoggingContext.toRunnable(null);
+        LoggingContext.copyToRunnable(null);
     }
 
     @Test
     public void toCallableReturnsSameInstance() {
         Callable<String> test = () -> "";
-        assertTrue(test == LoggingContext.toCallable(test));
+        assertTrue(test == LoggingContext.copyToCallable(test));
     }
 
     @Test(expectedExceptions = NullPointerException.class)
     public void throwNpeWhenToCallableWithNull() {
-        LoggingContext.toCallable(null);
+        LoggingContext.copyToCallable(null);
     }
 }
\ No newline at end of file
index 015875b..d2fb0b0 100644 (file)
@@ -17,7 +17,7 @@
 package org.openecomp.sdc.logging.slf4j;
 
 import org.openecomp.sdc.logging.api.Logger;
-import org.openecomp.sdc.logging.provider.LoggingServiceProvider;
+import org.openecomp.sdc.logging.spi.LoggingServiceProvider;
 import org.slf4j.MDC;
 
 import java.util.Objects;
@@ -67,13 +67,13 @@ public class SLF4JLoggingServiceProvider implements LoggingServiceProvider {
     }
 
     @Override
-    public Runnable toRunnable(Runnable runnable) {
+    public Runnable copyToRunnable(Runnable runnable) {
         Objects.requireNonNull(runnable, "Runnable cannot be null");
         return new MDCRunnableWrapper(runnable);
     }
 
     @Override
-    public <V> Callable<V> toCallable(Callable<V> callable) {
+    public <V> Callable<V> copyToCallable(Callable<V> callable) {
         Objects.requireNonNull(callable, "Runnable cannot be null");
         return new MDCCallableWrapper<>(callable);
     }
index a430de7..636ff94 100644 (file)
@@ -17,7 +17,7 @@
 package org.openecomp.sdc.logging.slf4j;
 
 import org.openecomp.sdc.logging.api.LoggingContext;
-import org.openecomp.sdc.logging.provider.LoggingContextService;
+import org.openecomp.sdc.logging.spi.LoggingContextService;
 import org.testng.annotations.DataProvider;
 
 import java.util.concurrent.Callable;
@@ -81,13 +81,13 @@ public abstract class BaseContextPropagationTest {
         }
 
         @Override
-        public Runnable toRunnable(Runnable runnable) {
-            return LoggingContext.toRunnable(runnable);
+        public Runnable copyToRunnable(Runnable runnable) {
+            return LoggingContext.copyToRunnable(runnable);
         }
 
         @Override
-        public <V> Callable<V> toCallable(Callable<V> callable) {
-            return LoggingContext.toCallable(callable);
+        public <V> Callable<V> copyToCallable(Callable<V> callable) {
+            return LoggingContext.copyToCallable(callable);
         }
 
         @Override
index 5fad3f7..0c8de97 100644 (file)
@@ -16,7 +16,7 @@
 
 package org.openecomp.sdc.logging.slf4j;
 
-import org.openecomp.sdc.logging.provider.LoggingContextService;
+import org.openecomp.sdc.logging.spi.LoggingContextService;
 import org.testng.annotations.Test;
 
 import java.util.UUID;
@@ -46,7 +46,7 @@ public class CallableContextPropagationTest extends BaseContextPropagationTest {
         AtomicBoolean complete = new AtomicBoolean(false);
 
         // pass the callable to the context service first
-        execute(ctx.toCallable(() -> {
+        execute(ctx.copyToCallable(() -> {
             assertEquals(ctx.get(KEY), uuid, EXPECT_PROPAGATED_TO_CHILD);
             complete.set(true);
             return null;
@@ -65,7 +65,7 @@ public class CallableContextPropagationTest extends BaseContextPropagationTest {
         AtomicBoolean innerComplete = new AtomicBoolean(false);
 
         // should run with the context of main thread
-        Callable inner = ctx.toCallable(() -> {
+        Callable inner = ctx.copyToCallable(() -> {
             assertEquals(ctx.get(KEY), innerRandom, EXPECT_PROPAGATED_TO_CHILD);
             innerComplete.set(true);
             return null;
@@ -94,7 +94,7 @@ public class CallableContextPropagationTest extends BaseContextPropagationTest {
         assertNull(ctx.get(KEY), EXPECT_EMPTY);
 
         final AtomicBoolean complete = new AtomicBoolean(false);
-        execute(ctx.toCallable(() -> {
+        execute(ctx.copyToCallable(() -> {
             assertNull(ctx.get(KEY), EXPECT_EMPTY);
             complete.set(true);
             return null;
@@ -112,7 +112,7 @@ public class CallableContextPropagationTest extends BaseContextPropagationTest {
 
         AtomicBoolean innerComplete = new AtomicBoolean(false);
         // should run with the context of main thread
-        Callable inner = ctx.toCallable((() -> {
+        Callable inner = ctx.copyToCallable((() -> {
             assertEquals(ctx.get(KEY), innerRandom, EXPECT_PROPAGATED_TO_CHILD);
             innerComplete.set(true);
             return null;
@@ -141,7 +141,7 @@ public class CallableContextPropagationTest extends BaseContextPropagationTest {
 
         // should run with the context of main thread
         AtomicBoolean innerComplete = new AtomicBoolean(false);
-        Callable inner = ctx.toCallable(() -> {
+        Callable inner = ctx.copyToCallable(() -> {
             assertEquals(ctx.get(KEY), innerRandom, EXPECT_PROPAGATED_TO_CHILD);
             innerComplete.set(true);
             throw new IllegalArgumentException();
index 516a27f..e93c114 100644 (file)
@@ -33,22 +33,22 @@ public class LoggingContextTest {
 
     @Test
     public void returnMdcWrapperWhenToRunnableCalled() {
-        assertEquals(LoggingContext.toRunnable(() -> {}).getClass(), MDCRunnableWrapper.class);
+        assertEquals(LoggingContext.copyToRunnable(() -> {}).getClass(), MDCRunnableWrapper.class);
     }
 
     @Test(expectedExceptions = NullPointerException.class)
     public void throwNpeWhenToRunnableWithNull() {
-        LoggingContext.toRunnable(null);
+        LoggingContext.copyToRunnable(null);
     }
 
     @Test
     public void returnMdcWrapperWhenToCallableCalled() {
-        assertEquals(LoggingContext.toCallable(() -> "").getClass(), MDCCallableWrapper.class);
+        assertEquals(LoggingContext.copyToCallable(() -> "").getClass(), MDCCallableWrapper.class);
     }
 
     @Test(expectedExceptions = NullPointerException.class)
     public void throwNpeWhenToCallableWithNull() {
-        LoggingContext.toCallable(null);
+        LoggingContext.copyToCallable(null);
     }
 
     @Test
index a617abd..90d6cda 100644 (file)
@@ -16,7 +16,7 @@
 
 package org.openecomp.sdc.logging.slf4j;
 
-import org.openecomp.sdc.logging.provider.LoggingContextService;
+import org.openecomp.sdc.logging.spi.LoggingContextService;
 import org.testng.annotations.Test;
 
 import java.util.UUID;
@@ -65,7 +65,7 @@ public class RunnableContextPropagationTest extends BaseContextPropagationTest {
         AtomicBoolean complete = new AtomicBoolean(false);
 
         // pass the runnable to the context service first
-        Thread thread = new Thread(ctx.toRunnable(() -> {
+        Thread thread = new Thread(ctx.copyToRunnable(() -> {
             assertEquals(ctx.get(KEY), uuid, EXPECT_PROPAGATED_TO_CHILD);
             complete.set(true);
         }));
@@ -87,7 +87,7 @@ public class RunnableContextPropagationTest extends BaseContextPropagationTest {
         AtomicBoolean innerComplete = new AtomicBoolean(false);
 
         // should run with the context of main thread
-        Runnable inner = ctx.toRunnable(() -> {
+        Runnable inner = ctx.copyToRunnable(() -> {
             assertEquals(ctx.get(KEY), innerRandom, EXPECT_PROPAGATED_TO_CHILD);
             innerComplete.set(true);
         });
@@ -118,7 +118,7 @@ public class RunnableContextPropagationTest extends BaseContextPropagationTest {
         assertNull(ctx.get(KEY), EXPECT_EMPTY);
 
         final AtomicBoolean complete = new AtomicBoolean(false);
-        Runnable runnable = ctx.toRunnable(() -> {
+        Runnable runnable = ctx.copyToRunnable(() -> {
             assertNull(ctx.get(KEY), EXPECT_EMPTY);
             complete.set(true);
         });
@@ -140,7 +140,7 @@ public class RunnableContextPropagationTest extends BaseContextPropagationTest {
 
         AtomicBoolean innerComplete = new AtomicBoolean(false);
         // should run with the context of main thread
-        Runnable inner = ctx.toRunnable(() -> {
+        Runnable inner = ctx.copyToRunnable(() -> {
             assertEquals(ctx.get(KEY), innerRandom, EXPECT_PROPAGATED_TO_CHILD);
             innerComplete.set(true);
         });
@@ -171,7 +171,7 @@ public class RunnableContextPropagationTest extends BaseContextPropagationTest {
 
         // should run with the context of main thread
         AtomicBoolean innerComplete = new AtomicBoolean(false);
-        Runnable inner = ctx.toRunnable(() -> {
+        Runnable inner = ctx.copyToRunnable(() -> {
             assertEquals(ctx.get(KEY), innerRandom, EXPECT_PROPAGATED_TO_CHILD);
             innerComplete.set(true);
             throw new IllegalArgumentException();