org.infrastructurebuilder.data.IBDataDatabaseDriverSupplier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ibdata-api Show documentation

APIs for dealing with data streams

The newest version!

/**
 * Copyright © 2019 admin ([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.infrastructurebuilder.data;

import java.util.List;
import java.util.Optional;
import java.util.function.Supplier;

import javax.sql.DataSource;

import org.infrastructurebuilder.util.BasicCredentials;
import org.infrastructurebuilder.util.artifacts.GAV;
import org.slf4j.Logger;

/**
 * Supplies the class name for the driver to make a Connection using a given JDBC URL
 *
 * @author mykel.alvis
 *
 */
public interface IBDataDatabaseDriverSupplier {

  Logger getLog();
  /**
   * Return a list of coordinates that must be in the classpath in order to load the driver
   * @return List of GAV items in order of required insertion into the (new) classpath that the driver will be created from
   */
  List getRequiredArtifacts();

  /**
   * Returns the Jooq Dialect name for a JDBC url if possible
   * @param jdbcUrl
   * @return Jooq Dialect name or empty()
   */
  Optional getDatabaseDriverClassName(String jdbcUrl);

  /**
   * The mapped hint for type of component
   * @return
   */
  String getHint();

  /**
   * The name of the Jooq SQLDialect enum.  Defaults to be the same as the getHint() call
   * @return
   */
  default String getJooqName() {
    return getHint();
  }

  /**
   * Get an IBDatabaseDialect from a JDBC url if possible
   * @param jdbcUrl
   * @return IBDatabaseDialect or empty() if not possible
   */
  Optional getDialect(String jdbcUrl);

  boolean respondsTo(String jdbcURL);

  Optional> getDataSourceSupplier(String jdbcURL, Optional creds);
}