io.helidon.dbclient.spi.DbClientServiceProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helidon-dbclient Show documentation

Helidon Database Client API

There is a newer version: 4.1.4

/*
 * Copyright (c) 2019, 2023 Oracle and/or its affiliates.
 *
 * 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 io.helidon.dbclient.spi;

import java.util.Collection;

import io.helidon.common.config.Config;
import io.helidon.dbclient.DbClientService;

/**
 * Java service loader service to configure client services.
 */
public interface DbClientServiceProvider {

    /**
     * The configuration key expected in config.
     * If the key exists, the builder looks into
     * {@code global}, {@code named}, and {@code typed} sub keys
     * to configure appropriate instances.
     * Method {@link #create(Config)} is called for each
     * configuration as follows:
     * 
     *     {@code global}: the configuration key is used to get a new instance
     *     {code named}: for each configuration node with a list of nodes, a new instance is requested
     *     {code typed}: for each configuration node with a list of types, a new instance is requested
     * 
     * @return name of the configuration key (such as "tracing")
     */
    String configKey();

    /**
     * Create a new interceptor instance with the configuration provided.
     *
     * @param config configuration node with additional properties that are (maybe) configured for this interceptor
     * @return an interceptor to handle DB statements
     */
    Collection create(Config config);

}