-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: SQL implementation of
TargetNodeDirectory (#241)
feat: sql implementation of target node directory
- Loading branch information
1 parent
a1b7e8f
commit 5af5314
Showing
18 changed files
with
674 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
...talog-core/src/test/java/org/eclipse/edc/catalog/directory/InMemoryNodeDirectoryTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /* | ||
| * Copyright (c) 2024 Amadeus IT Group | ||
| * | ||
| * 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: | ||
| * Amadeus IT Group - initial API and implementation | ||
| * | ||
| */ | ||
|
|
||
| package org.eclipse.edc.catalog.directory; | ||
|
|
||
| import org.eclipse.edc.catalog.spi.testfixtures.TargetNodeDirectoryTestBase; | ||
| import org.eclipse.edc.crawler.spi.TargetNodeDirectory; | ||
|
|
||
| class InMemoryNodeDirectoryTest extends TargetNodeDirectoryTestBase { | ||
|
|
||
| private final InMemoryNodeDirectory store = new InMemoryNodeDirectory(); | ||
|
|
||
| @Override | ||
| protected TargetNodeDirectory getStore() { | ||
| return store; | ||
| } | ||
|
|
||
| } |
29 changes: 29 additions & 0 deletions
29
extensions/store/sql/target-node-directory-sql/build.gradle.kts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /* | ||
| * Copyright (c) 2024 Amadeus IT Group | ||
| * | ||
| * 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: | ||
| * Amadeus IT Group - initial API and implementation | ||
| * | ||
| */ | ||
|
|
||
| plugins { | ||
| `java-library` | ||
| } | ||
|
|
||
| dependencies { | ||
| api(project(":spi:crawler-spi")) | ||
| implementation(libs.edc.sql.core) // for the SqlStatements | ||
| implementation(libs.edc.sql.bootstrapper) | ||
| implementation(libs.edc.spi.transaction.datasource) | ||
| implementation(libs.edc.lib.util) | ||
|
|
||
| testImplementation(libs.edc.junit) | ||
| testImplementation(testFixtures(libs.edc.sql.core)) | ||
| testImplementation(testFixtures(project(":spi:crawler-spi"))) | ||
| } |
60 changes: 60 additions & 0 deletions
60
...rectory-sql/src/main/java/org/eclipse/edc/catalog/store/sql/BaseSqlDialectStatements.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /* | ||
| * Copyright (c) 2024 Amadeus IT Group | ||
| * | ||
| * 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: | ||
| * Amadeus IT Group - initial API and implementation | ||
| * | ||
| */ | ||
|
|
||
| package org.eclipse.edc.catalog.store.sql; | ||
|
|
||
| import org.eclipse.edc.catalog.store.sql.schema.postgres.TargetNodeMapping; | ||
| import org.eclipse.edc.spi.query.QuerySpec; | ||
| import org.eclipse.edc.sql.translation.PostgresqlOperatorTranslator; | ||
| import org.eclipse.edc.sql.translation.SqlQueryStatement; | ||
|
|
||
| import static java.lang.String.format; | ||
|
|
||
| public abstract class BaseSqlDialectStatements implements TargetNodeStatements { | ||
|
|
||
| @Override | ||
| public String getFindByIdTemplate() { | ||
| return format("SELECT * FROM %s WHERE %s = ?", getTargetNodeDirectoryTable(), getIdColumn()); | ||
| } | ||
|
|
||
| @Override | ||
| public String getUpdateTemplate() { | ||
| return executeStatement() | ||
| .column(getNameColumn()) | ||
| .column(getTargetUrlColumn()) | ||
| .jsonColumn(getSupportedProtocolsColumn()) | ||
| .update(getTargetNodeDirectoryTable(), getIdColumn()); | ||
| } | ||
|
|
||
| @Override | ||
| public String getInsertTemplate() { | ||
| return executeStatement() | ||
| .column(getIdColumn()) | ||
| .column(getNameColumn()) | ||
| .column(getTargetUrlColumn()) | ||
| .jsonColumn(getSupportedProtocolsColumn()) | ||
| .insertInto(getTargetNodeDirectoryTable()); | ||
| } | ||
|
|
||
| @Override | ||
| public SqlQueryStatement createQuery(QuerySpec querySpec) { | ||
| var select = getSelectStatement(); | ||
| return new SqlQueryStatement(select, querySpec, new TargetNodeMapping(this), new PostgresqlOperatorTranslator()); | ||
| } | ||
|
|
||
| @Override | ||
| public String getSelectStatement() { | ||
| return format("SELECT * FROM %s", getTargetNodeDirectoryTable()); | ||
| } | ||
| } |
110 changes: 110 additions & 0 deletions
110
...directory-sql/src/main/java/org/eclipse/edc/catalog/store/sql/SqlTargetNodeDirectory.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| /* | ||
| * Copyright (c) 2024 Amadeus IT Group | ||
| * | ||
| * 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: | ||
| * Amadeus IT Group - initial API and implementation | ||
| * | ||
| */ | ||
|
|
||
| package org.eclipse.edc.catalog.store.sql; | ||
|
|
||
| import com.fasterxml.jackson.core.type.TypeReference; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import org.eclipse.edc.crawler.spi.TargetNode; | ||
| import org.eclipse.edc.crawler.spi.TargetNodeDirectory; | ||
| import org.eclipse.edc.spi.persistence.EdcPersistenceException; | ||
| import org.eclipse.edc.spi.query.QuerySpec; | ||
| import org.eclipse.edc.sql.QueryExecutor; | ||
| import org.eclipse.edc.sql.store.AbstractSqlStore; | ||
| import org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry; | ||
| import org.eclipse.edc.transaction.spi.TransactionContext; | ||
|
|
||
| import java.sql.Connection; | ||
| import java.sql.ResultSet; | ||
| import java.sql.SQLException; | ||
| import java.util.List; | ||
|
|
||
| public class SqlTargetNodeDirectory extends AbstractSqlStore implements TargetNodeDirectory { | ||
|
|
||
| private final TargetNodeStatements statements; | ||
|
|
||
| public SqlTargetNodeDirectory(DataSourceRegistry dataSourceRegistry, String dataSourceName, TransactionContext transactionContext, | ||
| ObjectMapper objectMapper, QueryExecutor queryExecutor, TargetNodeStatements statements) { | ||
| super(dataSourceRegistry, dataSourceName, transactionContext, objectMapper, queryExecutor); | ||
| this.statements = statements; | ||
| } | ||
|
|
||
| @Override | ||
| public List<TargetNode> getAll() { | ||
| return transactionContext.execute(() -> { | ||
| try (var connection = getConnection()) { | ||
| var query = statements.createQuery(QuerySpec.max()); | ||
| return queryExecutor.query(connection, true, this::mapResultSet, query.getQueryAsString(), query.getParameters()).toList(); | ||
| } catch (SQLException e) { | ||
| throw new EdcPersistenceException(e); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| @Override | ||
| public void insert(TargetNode node) { | ||
| transactionContext.execute(() -> { | ||
| try (var connection = getConnection()) { | ||
| var id = node.id(); | ||
|
|
||
| if (findByIdInternal(connection, id) == null) { | ||
| insertInternal(connection, id, node); | ||
| } else { | ||
| updateInternal(connection, id, node); | ||
| } | ||
|
|
||
| } catch (SQLException e) { | ||
| throw new EdcPersistenceException(e); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| private TargetNode findByIdInternal(Connection connection, String id) { | ||
| var stmt = statements.getFindByIdTemplate(); | ||
| return queryExecutor.single(connection, false, this::mapResultSet, stmt, id); | ||
| } | ||
|
|
||
| private void insertInternal(Connection connection, String id, TargetNode targetNode) { | ||
| var stmt = statements.getInsertTemplate(); | ||
| queryExecutor.execute(connection, | ||
| stmt, | ||
| id, | ||
| targetNode.name(), | ||
| targetNode.targetUrl(), | ||
| toJson(targetNode.supportedProtocols()) | ||
| ); | ||
| } | ||
|
|
||
| private void updateInternal(Connection connection, String id, TargetNode targetNode) { | ||
| var stmt = statements.getUpdateTemplate(); | ||
| queryExecutor.execute(connection, | ||
| stmt, | ||
| targetNode.name(), | ||
| targetNode.targetUrl(), | ||
| toJson(targetNode.supportedProtocols()), | ||
| id | ||
| ); | ||
| } | ||
|
|
||
| private TargetNode mapResultSet(ResultSet resultSet) throws Exception { | ||
| return new TargetNode( | ||
| resultSet.getString(statements.getNameColumn()), | ||
| resultSet.getString(statements.getIdColumn()), | ||
| resultSet.getString(statements.getTargetUrlColumn()), | ||
| fromJson(resultSet.getString(statements.getSupportedProtocolsColumn()), new TypeReference<>() { | ||
| }) | ||
| ); | ||
| } | ||
|
|
||
| } |
71 changes: 71 additions & 0 deletions
71
...-sql/src/main/java/org/eclipse/edc/catalog/store/sql/SqlTargetNodeDirectoryExtension.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| /* | ||
| * Copyright (c) 2024 Amadeus IT Group | ||
| * | ||
| * 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: | ||
| * Amadeus IT Group - initial API and implementation | ||
| * | ||
| */ | ||
|
|
||
| package org.eclipse.edc.catalog.store.sql; | ||
|
|
||
| import org.eclipse.edc.catalog.store.sql.schema.postgres.PostgresDialectStatements; | ||
| import org.eclipse.edc.crawler.spi.TargetNode; | ||
| import org.eclipse.edc.crawler.spi.TargetNodeDirectory; | ||
| import org.eclipse.edc.runtime.metamodel.annotation.Extension; | ||
| import org.eclipse.edc.runtime.metamodel.annotation.Inject; | ||
| import org.eclipse.edc.runtime.metamodel.annotation.Provides; | ||
| import org.eclipse.edc.runtime.metamodel.annotation.Setting; | ||
| import org.eclipse.edc.spi.system.ServiceExtension; | ||
| import org.eclipse.edc.spi.system.ServiceExtensionContext; | ||
| import org.eclipse.edc.spi.types.TypeManager; | ||
| import org.eclipse.edc.sql.QueryExecutor; | ||
| import org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper; | ||
| import org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry; | ||
| import org.eclipse.edc.transaction.spi.TransactionContext; | ||
|
|
||
| @Provides(TargetNodeDirectory.class) | ||
| @Extension(value = "SQL target node directory") | ||
| public class SqlTargetNodeDirectoryExtension implements ServiceExtension { | ||
|
|
||
| @Setting(value = "The datasource to be used", defaultValue = DataSourceRegistry.DEFAULT_DATASOURCE) | ||
| public static final String DATASOURCE_NAME = "edc.sql.store.targetnodedirectory.datasource"; | ||
|
|
||
| @Inject | ||
| private DataSourceRegistry dataSourceRegistry; | ||
| @Inject | ||
| private TransactionContext trxContext; | ||
| @Inject(required = false) | ||
| private TargetNodeStatements statements; | ||
| @Inject | ||
| private TypeManager typeManager; | ||
|
|
||
| @Inject | ||
| private QueryExecutor queryExecutor; | ||
|
|
||
| @Inject | ||
| private SqlSchemaBootstrapper sqlSchemaBootstrapper; | ||
|
|
||
| @Override | ||
| public void initialize(ServiceExtensionContext context) { | ||
| typeManager.registerTypes(TargetNode.class); | ||
| var dataSourceName = context.getSetting(DATASOURCE_NAME, DataSourceRegistry.DEFAULT_DATASOURCE); | ||
| var targetNodeDirectory = new SqlTargetNodeDirectory(dataSourceRegistry, dataSourceName, trxContext, | ||
| typeManager.getMapper(), queryExecutor, getStatementImpl()); | ||
| context.registerService(TargetNodeDirectory.class, targetNodeDirectory); | ||
| sqlSchemaBootstrapper.addStatementFromResource(dataSourceName, "target-node-directory-schema.sql"); | ||
| } | ||
|
|
||
| /** | ||
| * returns an externally-provided sql statement dialect, or postgres as a default | ||
| */ | ||
| private TargetNodeStatements getStatementImpl() { | ||
| return statements != null ? statements : new PostgresDialectStatements(); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.