io.github.mmm.orm.connection.DbConnectionPoolProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mmm-orm-spi Show documentation

Service Provider API (SPI) for mmm-orm.

There is a newer version: 0.9.8

/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package io.github.mmm.orm.connection;

import io.github.mmm.base.metainfo.MetaInfo;
import io.github.mmm.orm.dialect.DbDialect;
import io.github.mmm.orm.source.DbSource;

/**
 * Service provider interface (SPI) to {@link #create(DbSource, MetaInfo, DbDialect) create} instances of
 * {@link DbConnectionPool} for a specific provider implementation.
 *
 * @param  type of the {@link DbConnection}.
 */
public interface DbConnectionPoolProvider {

  /**
   * @return the identifier of this provider.
   */
  String getId();

  /**
   * @return the {@link DbSource#KEY_KIND kind} of database connection.
   */
  String getKind();

  /**
   * @param url the database connection URL (e.g. JDBC URL).
   * @return {@code true} if this {@link DbConnectionPoolProvider} is responsible for the given {@code url},
   *         {@code false} otherwise.
   */
  default boolean isResponsible(String url) {

    return url.startsWith(getKind());
  }

  /**
   * @param source the {@link DbSource}.
   * @param config the {@link MetaInfo} with the database configuration.
   * @param dialect the {@link DbDialect} to use.
   * @return the new {@link DbConnectionPool} instance for the given configuration.
   */
  DbConnectionPool create(DbSource source, MetaInfo config, DbDialect dialect);

}