components/basys.components/basyx.components.docker/basyx.components.registry/src/main/java/org/eclipse/basyx/components/registry/sql/SQLRegistry.java

/*******************************************************************************
 * Copyright (C) 2021 the Eclipse BaSyx Authors
 * 
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 * 
 * SPDX-License-Identifier: EPL-2.0
 ******************************************************************************/
package org.eclipse.basyx.components.registry.sql;

import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.Map;

import javax.servlet.ServletException;

import org.eclipse.basyx.aas.registration.memory.AASRegistry;
import org.eclipse.basyx.aas.registration.memory.MapRegistryHandler;
import org.eclipse.basyx.components.configuration.BaSyxSQLConfiguration;
import org.eclipse.basyx.tools.sqlproxy.SQLRootElement;

/**
 * Implements a local registry based on an SQL database
 * 
 * @author espen
 *
 */
public class SQLRegistry extends AASRegistry {
	public final static String TABLE_ID = "root_registry";

	/**
	 * Constructor using default sql connection
	 */
	public SQLRegistry() {
		super(new MapRegistryHandler(new AASDescriptorMap(createRootMap(new BaSyxSQLConfiguration()))));
	}

	/**
	 * Creates a SQLRegistry from a sql configuration
	 */
	public SQLRegistry(BaSyxSQLConfiguration configuration) {
		super(new MapRegistryHandler(new AASDescriptorMap(createRootMap(configuration))));
	}

	private static Map<String, Object> createRootMap(BaSyxSQLConfiguration config) {
		SQLRootElement sqlRootElement = initSQLConnection(config);
		sqlRootElement.createRootTableIfNotExists();
		return sqlRootElement.retrieveRootMap();
	}

	/**
	 * Initialize sqlDriver
	 * 
	 * @throws IOException
	 * @throws FileNotFoundException
	 * 
	 * @throws ServletException
	 */
	private static final SQLRootElement initSQLConnection(BaSyxSQLConfiguration config) {
		// SQL parameter
		String path = config.getPath();
		String user = config.getUser();
		String pass = config.getPass();
		String qryPfx = config.getPrefix();
		String qDrvCls = config.getDriver();

		// Create SQL driver instance
		return new SQLRootElement(user, pass, path, qDrvCls, qryPfx, TABLE_ID);
	}
}