com.exactpro.sf.configuration.suri.SailfishURIUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of Sailfish-REST-API-client Show documentation
'Exactpro Sailfish Core'
The newest version!
/******************************************************************************
 * Copyright 2009-2018 Exactpro (Exactpro Systems Limited)
 *
 * 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 com.exactpro.sf.configuration.suri;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Objects;
import java.util.Set;

import org.apache.commons.lang3.ArrayUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.common.collect.Multimap;

public class SailfishURIUtils {
    //FIXME: use "resolve once" strategy in managers instead of matching URIs every time
    private static final Logger LOGGER = LoggerFactory.getLogger(SailfishURIUtils.class);

    /**
     * Finds an URI in the set which matches specified URI
     *
     *  @param  uri         URI for matching
     *  @param  set         set with URI
     *  @param  defaultRule default URI rule
     *  @param  rules       array of URI rules
     *
     *  @return found URI or {@code null}
     */
    public static SailfishURI getMatchingURI(SailfishURI uri, Set set, SailfishURIRule defaultRule, SailfishURIRule... rules) {
        Objects.requireNonNull(set, "set cannot be null");
        checkURI(uri, defaultRule, rules);

        for (SailfishURI sailfishURI : set) {
            if (uri.matches(sailfishURI)) {
                LOGGER.debug("Matching: {} -> {}", uri, sailfishURI);
                return sailfishURI;
            }
        }

        return null;
    }

    /**
     * Finds a single URI in the set which matches specified URI
     *
     *  @param  uri         URI for matching
     *  @param  set         set with URI
     *  @param  resource    URI resource name
     *  @param  defaultRule default URI rule
     *  @param  rules       array of URI rules
     *
     *  @throws IllegalArgumentException if there is more than one resource with matching URI
     *  @throws NoSuchElementException if there are no resources with matching URIs
     *
     *  @return found URI
     */
    public static SailfishURI getSingleMatchingURI(SailfishURI uri, Set set, String resource, SailfishURIRule defaultRule, SailfishURIRule... rules) {
        Objects.requireNonNull(set, "set cannot be null");
        checkURI(uri, defaultRule, rules);

        List matchingUris = new ArrayList<>();

        for (SailfishURI sailfishUri : set) {
            if (uri.matches(sailfishUri)) {
                matchingUris.add(sailfishUri);
            }
        }

        if (matchingUris.isEmpty()) {
            throw new NoSuchElementException("No " + resource + " with URI matching: " + uri);
        }

        if (matchingUris.size() > 1) {
            throw new IllegalArgumentException("More than one " + resource + " with URI matching '" + uri + "': " + matchingUris);
        }

        return matchingUris.get(0);
    }

    /**
     * Finds a value in multimap with key matching specified URI
     *
     *  @param  uri         URI for matching
     *  @param  multimap    multimap with values
     *  @param  defaultRule default URI rule
     *  @param  rules       array of URI rules
     *
     *  @return found value or {@code null}
     */
    public static  T getMatchingValue(SailfishURI uri, Multimap multimap, SailfishURIRule defaultRule, SailfishURIRule... rules) {
		Objects.requireNonNull(multimap, "multimap cannot be null");
        checkURI(uri, defaultRule, rules);
        Collection c = getMatchingValue(uri, multimap.asMap(), defaultRule, rules);
        return c == null || c.isEmpty() ? null : c.iterator().next();
    }

    /**
     * Finds a value in map with key matching specified URI
     *
     *  @param  uri         URI for matching
     *  @param  map         map with values
     *  @param  defaultRule default URI rule
     *  @param  rules       array of URI rules
     *
     *  @return found value or {@code null}
     */
    public static  T getMatchingValue(SailfishURI uri, Map map, SailfishURIRule defaultRule, SailfishURIRule... rules) {
		Objects.requireNonNull(map, "map cannot be null");
        SailfishURI key = getMatchingURI(uri, map.keySet(), defaultRule, rules);
        return key != null ? map.get(key) : null;
    }

    /**
     * Finds values in multimap with keys matching specified URI
     *
     *  @param  uri         URI for matching
     *  @param  multimap    multimap with values
     *  @param  defaultRule default URI rule
     *  @param  rules       array of URI rules
     *
     *  @return set of found values
     */
    public static  Set getMatchingValues(SailfishURI uri, Multimap multimap, SailfishURIRule defaultRule, SailfishURIRule... rules) {
		Objects.requireNonNull(multimap, "multimap cannot be null");
        checkURI(uri, defaultRule, rules);

        Set values = new HashSet();

        for(Collection c : getMatchingValues(uri, multimap.asMap(), defaultRule, rules)) {
            values.addAll(c);
        }

        return values;
    }

    /**
     * Finds values in map with keys matching specified URI
     *
     *  @param  uri         URI for matching
     *  @param  map         map with values
     *  @param  defaultRule default URI rule
     *  @param  rules       array of URI rules
     *
     *  @return set of found values
     */
    public static  Set getMatchingValues(SailfishURI uri, Map map, SailfishURIRule defaultRule, SailfishURIRule... rules) {
		Objects.requireNonNull(map, "map cannot be null");
        checkURI(uri, defaultRule, rules);

        Set values = new HashSet();

        for(SailfishURI key : map.keySet()) {
            if(uri.matches(key)) {
                LOGGER.debug("Matching: {} -> {}", uri, key);
                values.add(map.get(key));
            }
        }

        return values;
    }

    public static SailfishURI checkURI(SailfishURI uri, SailfishURIRule defaultRule, SailfishURIRule... rules) {
        Objects.requireNonNull(uri, "uri cannot be null");
        Objects.requireNonNull(defaultRule, "defaultRule cannot be null");
        Objects.requireNonNull(rules, "rules cannot be null");

        for(SailfishURIRule rule : ArrayUtils.add(rules, defaultRule)) {
            if(!rule.check(uri)) {
                throw new IllegalArgumentException(String.format("Invalid URI: %s (%s)", uri, rule.getDescription()));
            }
        }

        return uri;
    }

    public static String sanitize(String value) {
        return value != null ? value.replaceAll("[^\\w:.]", "_") : null;
    }
}