refactor: extract api-lib to avoid extensions depending on api-core (#4819)

Author: ndr-brt

core/common/lib/api-lib/build.gradle.kts

@@ -0,0 +1,31 @@
+/*
+ *  Copyright (c) 2025 Cofinity-X
+ *
+ *  This program and the accompanying materials are made available under the
+ *  terms of the Apache License, Version 2.0 which is available at
+ *  https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *
+ *  Contributors:
+ *       Cofinity-X - initial API and implementation
+ *
+ */
+
+plugins {
+    `java-library`
+}
+
+dependencies {
+    api(project(":spi:common:core-spi"))
+
+    implementation(project(":core:common:lib:validator-lib"))
+    implementation(libs.swagger.annotations.jakarta)
+
+    testImplementation(project(":core:common:junit"))
+    testImplementation(project(":core:common:lib:json-ld-lib"))
+    testImplementation(project(":core:common:lib:query-lib"))
+    testImplementation(project(":core:common:lib:transform-lib"))
+}
+
+

extensions/common/api/api-core/src/main/java/org/eclipse/edc/api/model/ApiCoreSchema.java core/common/lib/api-lib/src/main/java/org/eclipse/edc/api/model/ApiCoreSchema.java

@@ -23,27 +23,27 @@ dependencies {
     // core dependencies
     api(project(":core:common:boot"))
     api(project(":core:common:connector-core"))
+    api(project(":core:common:edr-store-core"))
     api(project(":core:common:token-core"))
     api(project(":core:control-plane:control-plane-core"))
-    api(project(":core:common:edr-store-core"))
-    api(project(":data-protocols:dsp"))
     api(project(":core:data-plane-selector:data-plane-selector-core"))
-
+    api(project(":data-protocols:dsp"))
 
     // extension dependencies
     api(project(":extensions:common:configuration:configuration-filesystem"))
     api(project(":extensions:common:auth:auth-tokenbased"))
     api(project(":extensions:common:auth:auth-configuration"))
     api(project(":extensions:common:auth:auth-delegated"))
+    api(project(":extensions:common:api:api-core"))
+    api(project(":extensions:common:api:api-observability"))
+    api(project(":extensions:common:api:control-api-configuration"))
+    api(project(":extensions:common:api:version-api"))
+    api(project(":extensions:common:http"))
     api(project(":extensions:control-plane:api:management-api"))
     api(project(":extensions:control-plane:transfer:transfer-data-plane-signaling"))
     api(project(":extensions:data-plane-selector:data-plane-selector-api"))
     api(project(":extensions:data-plane-selector:data-plane-selector-control-api"))
     api(project(":extensions:data-plane:data-plane-signaling:data-plane-signaling-client"))
-    api(project(":extensions:common:api:api-observability"))
-    api(project(":extensions:common:api:control-api-configuration"))
-    api(project(":extensions:common:api:version-api"))
-    api(project(":extensions:common:http"))
     api(project(":extensions:control-plane:callback:callback-event-dispatcher"))
     api(project(":extensions:control-plane:callback:callback-http-dispatcher"))
     api(project(":extensions:control-plane:edr:edr-store-receiver"))
@@ -54,4 +54,4 @@ dependencies {
 
 edcBuild {
 
-}
+}

extensions/common/api/api-core/src/main/java/org/eclipse/edc/api/model/IdResponse.java core/common/lib/api-lib/src/main/java/org/eclipse/edc/api/model/IdResponse.java

@@ -26,10 +26,12 @@ dependencies {
     api(project(":core:common:token-core"))
     api(project(":core:data-plane:data-plane-core"))
 
-
     // extension dependencies
+    api(project(":extensions:common:api:api-core"))
+    api(project(":extensions:common:api:api-observability"))
     api(project(":extensions:common:api:control-api-configuration"))
     api(project(":extensions:common:configuration:configuration-filesystem"))
+    api(project(":extensions:common:http"))
     api(project(":extensions:common:json-ld"))
     api(project(":extensions:control-plane:api:control-plane-api-client"))
     api(project(":extensions:data-plane:data-plane-self-registration"))
@@ -39,6 +41,5 @@ dependencies {
     api(project(":extensions:data-plane:data-plane-signaling:data-plane-signaling-api"))
     api(project(":extensions:data-plane:data-plane-iam"))
     api(project(":extensions:data-plane-selector:data-plane-selector-client"))
-    api(project(":extensions:common:api:api-observability"))
-    api(project(":extensions:common:http"))
+
 }

extensions/common/api/api-core/src/main/java/org/eclipse/edc/api/transformer/JsonObjectFromCallbackAddressTransformer.java core/common/lib/api-lib/src/main/java/org/eclipse/edc/api/transformer/JsonObjectFromCallbackAddressTransformer.java

@@ -26,8 +26,8 @@ dependencies {
     api(project(":core:common:connector-core"))
     api(project(":core:common:token-core"))
 
-
     // extension dependencies
+    api(project(":extensions:common:api:api-core"))
     api(project(":extensions:common:http"))
     api(project(":extensions:common:json-ld"))
     api(project(":extensions:common:api:api-observability"))
@@ -38,4 +38,4 @@ dependencies {
     api(project(":extensions:common:iam:identity-trust:identity-trust-sts:identity-trust-sts-accounts-api"))
     api(project(":extensions:common:iam:identity-trust:identity-trust-sts:identity-trust-sts-core"))
     api(project(":extensions:common:iam:identity-trust:identity-trust-sts:identity-trust-sts-embedded"))
-}
+}

extensions/common/api/api-core/src/main/java/org/eclipse/edc/api/transformer/JsonObjectFromIdResponseTransformer.java core/common/lib/api-lib/src/main/java/org/eclipse/edc/api/transformer/JsonObjectFromIdResponseTransformer.java

@@ -22,6 +22,7 @@ dependencies {
     api(project(":spi:common:web-spi"))
     api(project(":spi:common:json-ld-spi"))
 
+    implementation(project(":core:common:lib:api-lib"))
     implementation(project(":core:common:lib:transform-lib"))
     implementation(project(":core:common:lib:util-lib"))
     implementation(project(":core:common:lib:validator-lib"))

extensions/common/api/api-core/src/main/java/org/eclipse/edc/api/transformer/JsonObjectToCallbackAddressTransformer.java core/common/lib/api-lib/src/main/java/org/eclipse/edc/api/transformer/JsonObjectToCallbackAddressTransformer.java

@@ -18,9 +18,9 @@ plugins {
 }
 
 dependencies {
+    api(project(":spi:common:auth-spi"))
     api(project(":spi:common:web-spi"))
     api(project(":spi:control-plane:transfer-spi"))
-    implementation(project(":extensions:common:api:api-core"))
     implementation(project(":extensions:common:http:lib:jersey-providers-lib"))
 
     testImplementation(project(":core:common:junit"))

extensions/common/api/api-core/src/main/java/org/eclipse/edc/api/validation/DataAddressValidator.java core/common/lib/api-lib/src/main/java/org/eclipse/edc/api/validation/DataAddressValidator.java

@@ -18,15 +18,15 @@ plugins {
 }
 
 dependencies {
+    api(project(":spi:common:auth-spi"))
     api(project(":spi:common:json-ld-spi"))
     api(project(":spi:common:web-spi"))
     api(project(":spi:control-plane:contract-spi"))
 
-    implementation(project(":extensions:common:api:lib:management-api-lib"))
-    implementation(project(":extensions:common:http:lib:jersey-providers-lib"))
-    implementation(project(":extensions:common:api:api-core"))
     implementation(project(":core:common:lib:transform-lib"))
     implementation(project(":core:control-plane:control-plane-transform"))
+    implementation(project(":extensions:common:api:lib:management-api-lib"))
+    implementation(project(":extensions:common:http:lib:jersey-providers-lib"))
 
     testImplementation(project(":core:common:junit"))
     testImplementation(project(":core:common:lib:json-ld-lib"))

extensions/common/api/api-core/src/test/java/org/eclipse/edc/api/model/ApiCoreSchemaTest.java core/common/lib/api-lib/src/test/java/org/eclipse/edc/api/model/ApiCoreSchemaTest.java

@@ -19,7 +19,9 @@ plugins {
 }
 
 dependencies {
-    implementation(project(":extensions:common:api:api-core"))
+    api(project(":spi:common:boot-spi"))
+    api(project(":spi:common:json-ld-spi"))
+    api(project(":spi:common:web-spi"))
 
     implementation(libs.jakarta.rsApi)
 

extensions/common/api/api-core/src/test/java/org/eclipse/edc/api/transformer/JsonObjectFromCallbackAddressTransformerTest.java core/common/lib/api-lib/src/test/java/org/eclipse/edc/api/transformer/JsonObjectFromCallbackAddressTransformerTest.java

@@ -29,6 +29,7 @@ dependencies {
     testImplementation(project(":core:data-plane:data-plane-core"))
     testImplementation(project(":core:data-plane-selector:data-plane-selector-core"))
     testImplementation(project(":extensions:control-plane:api:control-plane-api"))
+    testImplementation(project(":extensions:common:api:api-core"))
     testImplementation(project(":extensions:common:api:control-api-configuration"))
     testImplementation(project(":extensions:common:auth:auth-tokenbased"))
     testImplementation(project(":extensions:common:http"))

extensions/common/api/api-core/src/test/java/org/eclipse/edc/api/transformer/JsonObjectFromIdResponseTransformerTest.java core/common/lib/api-lib/src/test/java/org/eclipse/edc/api/transformer/JsonObjectFromIdResponseTransformerTest.java

@@ -22,8 +22,8 @@ dependencies {
     api(project(":spi:common:validator-spi"))
     api(project(":spi:control-plane:control-plane-spi"))
 
+    implementation(project(":core:common:lib:api-lib"))
     implementation(project(":core:common:lib:validator-lib"))
-    implementation(project(":extensions:common:api:api-core"))
     implementation(project(":extensions:common:api:lib:management-api-lib"))
 
     implementation(libs.jakarta.rsApi)

extensions/common/api/api-core/src/test/java/org/eclipse/edc/api/transformer/JsonObjectToCallbackAddressTransformerTest.java core/common/lib/api-lib/src/test/java/org/eclipse/edc/api/transformer/JsonObjectToCallbackAddressTransformerTest.java

@@ -20,8 +20,8 @@ plugins {
 dependencies {
     api(project(":spi:control-plane:control-plane-spi"))
 
+    implementation(project(":core:common:lib:api-lib"))
     implementation(project(":core:common:lib:validator-lib"))
-    implementation(project(":extensions:common:api:api-core"))
     implementation(project(":extensions:common:api:lib:management-api-lib"))
 
     implementation(libs.jakarta.rsApi)

extensions/common/api/api-core/src/test/java/org/eclipse/edc/api/validation/DataAddressValidatorTest.java core/common/lib/api-lib/src/test/java/org/eclipse/edc/api/validation/DataAddressValidatorTest.java

@@ -22,7 +22,7 @@ plugins {
 dependencies {
     api(project(":spi:control-plane:control-plane-spi"))
 
-    implementation(project(":extensions:common:api:api-core"))
+    implementation(project(":core:common:lib:api-lib"))
     implementation(project(":extensions:common:api:lib:management-api-lib"))
 
     implementation(libs.jakarta.rsApi)

dist/bom/controlplane-base-bom/build.gradle.kts

@@ -21,8 +21,8 @@ dependencies {
     api(project(":spi:control-plane:control-plane-spi"))
     api(project(":spi:common:transaction-spi"))
 
-    implementation(project(":extensions:common:api:api-core"))
     implementation(project(":extensions:common:api:lib:management-api-lib"))
+    implementation(project(":core:common:lib:api-lib"))
     implementation(project(":core:common:lib:validator-lib"))
 
     implementation(libs.jakarta.rsApi)

dist/bom/dataplane-base-bom/build.gradle.kts

@@ -19,8 +19,8 @@ dependencies {
     api(project(":spi:control-plane:control-plane-spi"))
     api(project(":spi:common:transaction-spi"))
 
-    implementation(project(":extensions:common:api:api-core"))
     implementation(project(":extensions:common:api:lib:management-api-lib"))
+    implementation(project(":core:common:lib:api-lib"))
     implementation(project(":core:common:lib:validator-lib"))
 
     implementation(libs.jakarta.rsApi)

dist/bom/sts-feature-bom/build.gradle.kts

@@ -21,8 +21,9 @@ plugins {
 dependencies {
     api(project(":spi:common:edr-store-spi"))
     api(project(":spi:common:validator-spi"))
+    api(project(":spi:common:web-spi"))
     api(project(":spi:control-plane:control-plane-spi"))
-    implementation(project(":extensions:common:api:api-core"))
+    implementation(project(":core:common:lib:api-lib"))
     implementation(project(":core:common:lib:validator-lib"))
 
     implementation(libs.jakarta.rsApi)

extensions/common/api/api-core/build.gradle.kts

@@ -25,9 +25,9 @@ dependencies {
     api(project(":spi:common:transaction-spi"))
     api(project(":spi:common:policy-model"))
 
+    implementation(project(":core:common:lib:api-lib"))
     implementation(project(":core:common:lib:util-lib"))
     implementation(project(":core:common:lib:validator-lib"))
-    implementation(project(":extensions:common:api:api-core"))
     implementation(project(":extensions:common:api:lib:management-api-lib"))
 
     implementation(libs.jakarta.rsApi)

extensions/common/api/control-api-configuration/build.gradle.kts

@@ -20,7 +20,6 @@ dependencies {
     api(project(":spi:control-plane:control-plane-spi"))
 
     implementation(project(":core:common:lib:validator-lib"))
-    implementation(project(":extensions:common:api:api-core"))
     implementation(project(":extensions:common:api:lib:management-api-lib"))
 
     implementation(libs.jakarta.rsApi)

extensions/common/api/management-api-configuration/build.gradle.kts

@@ -20,10 +20,11 @@ plugins {
 
 dependencies {
     api(project(":spi:common:validator-spi"))
+    api(project(":spi:common:web-spi"))
     api(project(":spi:control-plane:control-plane-spi"))
-    implementation(project(":extensions:common:api:api-core"))
-    implementation(project(":core:common:lib:validator-lib"))
+    implementation(project(":core:common:lib:api-lib"))
     implementation(project(":core:common:lib:transform-lib"))
+    implementation(project(":core:common:lib:validator-lib"))
 
     implementation(libs.jakarta.rsApi)
 

extensions/common/api/version-api/build.gradle.kts

@@ -21,9 +21,9 @@ dependencies {
     api(project(":spi:control-plane:transfer-spi"))
     api(project(":spi:control-plane:control-plane-spi"))
 
+    implementation(project(":core:common:lib:api-lib"))
     implementation(project(":core:common:lib:util-lib"))
     implementation(project(":core:common:lib:validator-lib"))
-    implementation(project(":extensions:common:api:api-core"))
     implementation(project(":extensions:common:api:lib:management-api-lib"))
 
     implementation(libs.jakarta.rsApi)

extensions/control-plane/api/control-plane-api-client/build.gradle.kts

@@ -22,7 +22,6 @@ dependencies {
     api(project(":spi:control-plane:control-plane-spi"))
     api(project(":spi:common:http-spi"))
     api(project(":spi:common:web-spi"))
-    implementation(project(":extensions:common:api:api-core"))
     implementation(project(":extensions:common:validator:validator-data-address-http-data"))
 
     implementation(libs.jakarta.rsApi)
@@ -31,6 +30,7 @@ dependencies {
     testImplementation(project(":core:control-plane:control-plane-core"))
     testImplementation(project(":core:common:junit"))
     testImplementation(project(":core:data-plane-selector:data-plane-selector-core"))
+    testImplementation(project(":extensions:common:api:api-core"))
     testImplementation(project(":extensions:common:api:management-api-configuration"))
     testImplementation(project(":extensions:common:http"))
     testImplementation(project(":extensions:common:json-ld"))

extensions/control-plane/api/management-api/asset-api/build.gradle.kts

@@ -19,20 +19,22 @@ plugins {
 
 dependencies {
     api(project(":spi:common:core-spi"))
+    api(project(":spi:common:web-spi"))
     api(project(":spi:data-plane-selector:data-plane-selector-spi"))
     implementation(project(":spi:common:transaction-spi"))
+    implementation(project(":core:common:lib:api-lib"))
     implementation(project(":core:common:lib:transform-lib"))
     implementation(project(":core:common:lib:util-lib"))
     implementation(project(":core:common:lib:validator-lib"))
     implementation(project(":extensions:common:json-ld"))
-    implementation(project(":extensions:common:api:api-core")) //for the exception mapper
 
     implementation(libs.jakarta.rsApi)
 
     testImplementation(project(":core:common:lib:json-ld-lib"))
     testImplementation(project(":core:common:connector-core"))
     testImplementation(project(":core:common:junit"))
     testImplementation(project(":core:data-plane-selector:data-plane-selector-core"))
+    testImplementation(project(":extensions:common:api:api-core"))
     testImplementation(project(":extensions:common:api:management-api-configuration"))
     testImplementation(project(":extensions:common:http"))
     testImplementation(project(":extensions:data-plane:data-plane-signaling:data-plane-signaling-client"))

extensions/control-plane/api/management-api/catalog-api/build.gradle.kts

@@ -22,6 +22,7 @@
 import org.eclipse.edc.junit.extensions.RuntimePerMethodExtension;
 import org.eclipse.edc.spi.result.ServiceFailure;
 import org.eclipse.edc.spi.result.ServiceResult;
+import org.eclipse.edc.spi.system.configuration.ConfigFactory;
 import org.eclipse.edc.spi.types.domain.DataAddress;
 import org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry;
 import org.eclipse.edc.validator.spi.ValidationResult;
@@ -51,32 +52,33 @@ class RemoteDataPlaneSelectorServiceTest {
     private final JsonObjectValidatorRegistry validator = mock();
 
     @RegisterExtension
-    public final RuntimeExtension client = new RuntimePerMethodExtension(new EmbeddedRuntime(
-            "client",
-            Map.of(
+    public final RuntimeExtension client = new RuntimePerMethodExtension(new EmbeddedRuntime("client",
+            ":core:common:connector-core",
+            ":extensions:common:http")
+            .configurationProvider(() -> ConfigFactory.fromMap(Map.of(
                     "web.http.port", String.valueOf(getFreePort()),
                     "edc.dpf.selector.url", "http://localhost:%d/control/v1/dataplanes".formatted(port),
                     "edc.core.retry.retries.max", "0"
-            ),
-            ":core:common:connector-core",
-            ":extensions:common:http"
-    ));
+            )))
+    );
 
     @RegisterExtension
     public final RuntimeExtension server = new RuntimePerMethodExtension(new EmbeddedRuntime(
             "server",
-            Map.of(
+            ":extensions:data-plane-selector:data-plane-selector-control-api",
+            ":extensions:common:api:control-api-configuration",
+            ":extensions:common:api:api-core",
+            ":core:common:connector-core",
+            ":extensions:common:http")
+            .configurationProvider(() -> ConfigFactory.fromMap(Map.of(
                     "web.http.port", String.valueOf(getFreePort()),
                     "edc.dpf.selector.url", "http://not-used-but-mandatory",
                     "web.http.control.port", port + "",
                     "web.http.control.path", "/control"
-            ),
-            ":extensions:data-plane-selector:data-plane-selector-control-api",
-            ":extensions:common:api:control-api-configuration",
-            ":core:common:connector-core",
-            ":extensions:common:http"))
+            )))
             .registerServiceMock(DataPlaneSelectorService.class, serverService)
-            .registerServiceMock(JsonObjectValidatorRegistry.class, validator);
+            .registerServiceMock(JsonObjectValidatorRegistry.class, validator)
+    );
 
     @Test
     void addInstance() {

extensions/control-plane/api/management-api/contract-agreement-api/build.gradle.kts

@@ -22,9 +22,9 @@ dependencies {
     api(project(":spi:common:web-spi"))
     api(project(":spi:data-plane-selector:data-plane-selector-spi"))
 
+    implementation(project(":core:common:lib:api-lib"))
     implementation(project(":core:common:lib:transform-lib"))
     implementation(project(":core:common:lib:validator-lib"))
-    implementation(project(":extensions:common:api:api-core"))
     implementation(libs.jakarta.rsApi)
 
     testImplementation(project(":core:common:junit"))