io.syndesis.model.WithProperties.java Source code

Introduction

Here is the source code for io.syndesis.model.WithProperties.java

Source

/**
 * Copyright (C) 2016 Red Hat, Inc.
 *
 * 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.syndesis.model;

import java.util.Map;
import java.util.Map.Entry;
import java.util.Optional;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.stream.Collectors;

import com.fasterxml.jackson.annotation.JsonIgnore;

import io.syndesis.model.connection.ConfigurationProperty;
import io.syndesis.model.connection.Connector;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

public interface WithProperties {

    @SuppressFBWarnings("SE_BAD_FIELD")
    Map<String, ConfigurationProperty> getProperties();

    Map<String, String> getConfiguredProperties();

    @JsonIgnore
    default boolean isEndpointProperty(Map.Entry<String, String> e) {
        return this.getProperties() != null && this.getProperties().containsKey(e.getKey())
                && Boolean.FALSE.equals(this.getProperties().get(e.getKey()).getComponentProperty());
    }

    @JsonIgnore
    default Predicate<Map.Entry<String, String>> isEndpointProperty() {
        return e -> this.isEndpointProperty(e);
    }

    @JsonIgnore
    default boolean isSecretEndpointProperty(Map.Entry<String, String> e) {
        return this.isEndpointProperty(e) && this.isSecret(e);
    }

    @JsonIgnore
    default Predicate<Map.Entry<String, String>> isSecretEndpointProperty() {
        return e -> isSecretEndpointProperty(e);
    }

    @JsonIgnore
    default boolean isComponentProperty(Map.Entry<String, String> e) {
        return this.getProperties() != null && this.getProperties().containsKey(e.getKey())
                && Boolean.TRUE.equals(this.getProperties().get(e.getKey()).getComponentProperty());
    }

    @JsonIgnore
    default Predicate<Map.Entry<String, String>> isComponentProperty() {
        return e -> this.isComponentProperty(e);
    }

    @JsonIgnore
    default boolean isSecretComponentProperty(Map.Entry<String, String> e) {
        return this.isComponentProperty(e) && this.isSecret(e);
    }

    @JsonIgnore
    default Predicate<Map.Entry<String, String>> isSecretComponentProperty() {
        return e -> this.isSecretComponentProperty(e);
    }

    @JsonIgnore
    default boolean isSecret(Map.Entry<String, String> e) {
        return this.getProperties() != null && this.getProperties().containsKey(e.getKey())
                && Boolean.TRUE.equals(this.getProperties().get(e.getKey()).getSecret());
    }

    @JsonIgnore
    default Predicate<Map.Entry<String, String>> isSecret() {
        return e -> this.isSecret(e);
    }

    @JsonIgnore
    default boolean isSecretOrComponentProperty(Map.Entry<String, String> e) {
        return this.isComponentProperty(e) || this.isSecret(e);
    }

    @JsonIgnore
    default Predicate<Map.Entry<String, String>> isSecretOrComponentProperty() {
        return e -> isSecretOrComponentProperty(e);
    }

    /**
     * Filters the specified properties, using the specified {@link Predicate} and value converter {@link Function}.
     *
     * @param properties        The configuration.
     * @param predicate         The {@link Predicate}.
     * @param keyConverter    The {@link Function} to apply to keys.
     * @param valueConverter    The {@link Function} to apply to values.
     * @return                  A map with the properties that match the {@link Predicate}, and converted values.
     */
    default Map<String, String> filterProperties(Map<String, String> properties,
            Predicate<Map.Entry<String, String>> predicate,
            Function<Map.Entry<String, String>, String> keyConverter,
            Function<Map.Entry<String, String>, String> valueConverter) {
        return properties.entrySet().stream().filter(predicate)
                .collect(Collectors.toMap(keyConverter, valueConverter));
    }

    /**
     * Filters the specified properties, using the specified {@link Predicate} and value converter {@link Function}.
     *
     * @param properties        The configuration.
     * @param predicate         The {@link Predicate}.
        
     * @return                  A map with the properties that match the {@link Predicate}, and converted values.
     */
    default Map<String, String> filterProperties(Map<String, String> properties,
            Predicate<Map.Entry<String, String>> predicate) {
        return filterProperties(properties, predicate, e -> e.getKey(), e -> e.getValue());
    }

    /**
     * Filters the properties that the {@link Connector} considers sensitive / secret.
     * @param properties        The specified configuration.
     * @return                  A map with just the sensitive data.
     */
    default Map<String, String> filterSecrets(Map<String, String> properties) {
        return filterSecrets(properties, e -> e.getValue());
    }

    /**
     * Filters the properties that the {@link Connector} considers sensitive / secret.
     * @param properties        The specified configuration.
     * @param valueConverter    A {@link Function} that is applies to each {@link Map.Entry} of the configuration.
     * @return                  A map with just the sensitive data.
     */
    default Map<String, String> filterSecrets(Map<String, String> properties,
            Function<Map.Entry<String, String>, String> valueConverter) {
        return properties.entrySet().stream().filter(isSecret())
                .collect(Collectors.toMap(e -> e.getKey(), e -> valueConverter.apply(e)));
    }

    /**
     * Returns first property entry tagged with the given tag.
     *
     * @param tag               The looked after tag
     * @return                  First property tagged with the supplied tag, if any
     */
    default Optional<Entry<String, ConfigurationProperty>> propertyEntryTaggedWith(final String tag) {
        return getProperties().entrySet().stream().filter(entry -> entry.getValue().getTags().contains(tag))
                .findFirst();
    }

    /**
     * Returns first property tagged with the given tag.
     *
     * @param properties        The properties
     * @param tag               The looked after tag
     * @return                  First property tagged with the supplied tag, if any
     */
    default Optional<String> propertyTaggedWith(final Map<String, String> properties, final String tag) {
        return propertyEntryTaggedWith(tag).map(entry -> properties.get(entry.getKey()));
    }

}