io.trino.jdbc.$internal.client.uri.AbstractConnectionProperty Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of trino-jdbc Show documentation
Trino - JDBC driver
There is a newer version: 458
/*
 * 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.trino.jdbc.\$internal.client.uri;

import io.trino.jdbc.\$internal.guava.reflect.TypeToken;

import java.io.File;
import java.sql.DriverPropertyInfo;
import java.sql.SQLException;
import java.util.Optional;
import java.util.Properties;
import java.util.function.Predicate;
import java.util.stream.Stream;

import static io.trino.jdbc.\$internal.guava.base.Preconditions.checkArgument;
import static java.lang.String.format;
import static java.util.Locale.ENGLISH;
import static java.util.Objects.requireNonNull;

abstract class AbstractConnectionProperty
        implements ConnectionProperty
{
    private final PropertyName propertyName;
    private final String key;
    private final Optional defaultValue;
    private final Predicate isRequired;
    private final Validator validator;
    private final Converter converter;
    private final String[] choices;

    protected AbstractConnectionProperty(
            PropertyName propertyName,
            Optional defaultValue,
            Predicate isRequired,
            Validator validator,
            Converter converter)
    {
        this.propertyName = requireNonNull(propertyName, "key is null");
        this.key = propertyName.toString();
        this.defaultValue = requireNonNull(defaultValue, "defaultValue is null");
        this.isRequired = requireNonNull(isRequired, "isRequired is null");
        this.validator = requireNonNull(validator, "validator is null");
        this.converter = requireNonNull(converter, "converter is null");

        Class type = new TypeToken(getClass()) {}.getRawType();
        if (type == Boolean.class) {
            choices = new String[] {"true", "false"};
        }
        else if (Enum.class.isAssignableFrom(type)) {
            choices = Stream.of(type.getEnumConstants())
                    .map(Object::toString)
                    .toArray(String[]::new);
        }
        else {
            choices = null;
        }
    }

    protected AbstractConnectionProperty(
            PropertyName key,
            Predicate required,
            Validator allowed,
            Converter converter)
    {
        this(key, Optional.empty(), required, allowed, converter);
    }

    @Override
    public PropertyName getPropertyName()
    {
        return propertyName;
    }

    @Override
    public DriverPropertyInfo getDriverPropertyInfo(Properties mergedProperties)
    {
        String currentValue = mergedProperties.getProperty(key);
        DriverPropertyInfo result = new DriverPropertyInfo(key, currentValue);
        result.required = isRequired.test(mergedProperties);
        result.choices = (choices != null) ? choices.clone() : null;
        return result;
    }

    @Override
    public boolean isRequired(Properties properties)
    {
        return isRequired.test(properties);
    }

    @Override
    public boolean isValid(Properties properties)
    {
        return !validator.validate(properties).isPresent();
    }

    @Override
    public Optional getValue(Properties properties)
            throws SQLException
    {
        return getValueOrDefault(properties, defaultValue);
    }

    @Override
    public Optional getValueOrDefault(Properties properties, Optional defaultValue)
            throws SQLException
    {
        V value = (V) properties.get(key);
        if (value == null) {
            if (isRequired(properties) && !defaultValue.isPresent()) {
                throw new SQLException(format("Connection property %s is required", key));
            }
            return defaultValue;
        }

        try {
            return Optional.of(converter.convert(value));
        }
        catch (RuntimeException e) {
            if (isEmpty(value)) {
                throw new SQLException(format("Connection property %s value is empty", key), e);
            }
            throw new SQLException(format("Connection property %s value is invalid: %s", key, value), e);
        }
    }

    private boolean isEmpty(V value)
    {
        if (value instanceof String) {
            return ((String) value).isEmpty();
        }
        return false;
    }

    @Override
    public void validate(Properties properties)
            throws SQLException
    {
        if (properties.containsKey(key)) {
            Optional message = validator.validate(properties);
            if (message.isPresent()) {
                throw new SQLException(message.get());
            }
        }

        getValue(properties);
    }

    protected static final Predicate NOT_REQUIRED = properties -> false;

    protected static final Validator ALLOWED = properties -> Optional.empty();

    interface Converter
    {
        T convert(V value);
    }

    protected static final Converter STRING_CONVERTER = String.class::cast;

    protected static final Converter NON_EMPTY_STRING_CONVERTER = value -> {
        checkArgument(!value.isEmpty(), "value is empty");
        return value;
    };

    protected static final Converter FILE_CONVERTER = File::new;

    protected static final Converter BOOLEAN_CONVERTER = value -> {
        switch (value.toLowerCase(ENGLISH)) {
            case "true":
                return true;
            case "false":
                return false;
        }
        throw new IllegalArgumentException("value must be 'true' or 'false'");
    };

    protected interface Validator
    {
        /**
         * @param value Value to validate
         * @return An error message if the value is invalid or empty otherwise
         */
        Optional validate(T value);

        default Validator and(Validator other)
        {
            requireNonNull(other, "other is null");
            // return the first non-empty optional
            return t -> {
                Optional result = validate(t);
                if (result.isPresent()) {
                    return result;
                }
                return other.validate(t);
            };
        }
    }

    protected static  Validator validator(Predicate predicate, String errorMessage)
    {
        requireNonNull(predicate, "predicate is null");
        requireNonNull(errorMessage, "errorMessage is null");
        return value -> {
            if (predicate.test(value)) {
                return Optional.empty();
            }
            return Optional.of(errorMessage);
        };
    }

    protected interface CheckedPredicate
    {
        boolean test(T t)
                throws SQLException;
    }

    protected static  Predicate checkedPredicate(CheckedPredicate predicate)
    {
        requireNonNull(predicate, "predicate is null");
        return value -> {
            try {
                return predicate.test(value);
            }
            catch (SQLException e) {
                return false;
            }
        };
    }
}