io.rxmicro.data.sql.r2dbc.postgresql.PostgreSQLConfigCustomizer Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2020. https://rxmicro.io
 *
 * 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.rxmicro.data.sql.r2dbc.postgresql;

import io.r2dbc.postgresql.extension.CodecRegistrar;
import io.r2dbc.spi.Connection;
import io.rxmicro.data.sql.r2dbc.postgresql.internal.PostgreSQLConnectionPoolBuilder;

import java.util.function.Function;

/**
 * Allows configuring the application specific configs for PostgreSQL database driver (R2DBC driver).
 *
 * 
 *     {@link PostgreSQLConfig} must be used for environment specific configs.
 *     {@link PostgreSQLConfigCustomizer} must be used for application specific configs.
 * 
 *
 * @author nedis
 * @see PostgreSQLConfig
 * @since 0.7
 */
public final class PostgreSQLConfigCustomizer {

    /**
     * Allows registering custom codecs.
     *
     * @param codecRegistrars the custom codecs
     * @throws IllegalStateException if connection pool already built
     * @throws NullPointerException if {@code codecRegistrar} is {@code null}
     */
    public static void registerPostgreSQLCodecs(final CodecRegistrar... codecRegistrars) {
        for (final CodecRegistrar codecRegistrar : codecRegistrars) {
            PostgreSQLConnectionPoolBuilder.getInstance().addCodecRegistrar(codecRegistrar);
        }
    }

    /**
     * Sets the connection decorator function.
     *
     * 
     * This features is useful for testing purposes.
     *
     * @param connectionDecorator the connection decorator function
     * @throws IllegalStateException if connection pool already built
     * @throws NullPointerException if {@code connectionDecorator} is {@code null}
     */
    public static void setConnectionDecorator(final Function connectionDecorator) {
        PostgreSQLConnectionPoolBuilder.getInstance().setConnectionDecorator(connectionDecorator);
    }

    private PostgreSQLConfigCustomizer() {
    }
}