org.apache.sshd.common.NamedFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sshd-common Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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 org.apache.sshd.common;

import java.util.Collection;
import java.util.List;
import java.util.function.Function;
import java.util.stream.Collectors;

/**
 * A named factory is a factory identified by a name. Such names are used mainly in the algorithm negotiation at the
 * beginning of the SSH connection.
 *
 * @param   The create object instance type
 * @author     Apache MINA SSHD Project
 */
public interface NamedFactory extends Factory, NamedResource {
    /**
     * Create an instance of the specified name by looking up the needed factory in the list.
     *
     * @param  factories list of available factories
     * @param  name      the factory name to use
     * @param         type of object to create
     * @return           a newly created object or {@code null} if the factory is not in the list
     */
    static  T create(Collection> factories, String name) {
        NamedFactory f = NamedResource.findByName(name, String.CASE_INSENSITIVE_ORDER, factories);
        if (f != null) {
            return f.create();
        } else {
            return null;
        }
    }

    /**
     * Converts a list of factories to a list of transformed factories, optionally excluding unsupported factories.
     *
     * @param                 initial factory type
     * @param                 transformed factory type
     * @param  ignoreUnsupported whether to filter out unsupported factories from {@code preferred}
     * @param  preferred         initial list to filter
     * @param  xform             the transformation to apply
     * @return                   the filtered list of transformed factories
     */
    static  List setUpTransformedFactories(
            boolean ignoreUnsupported, Collection preferred, Function xform) {
        return preferred.stream()
                .filter(f -> ignoreUnsupported ? f.isSupported() : true)
                .map(xform)
                .collect(Collectors.toList());
    }

    /**
     * Filters out unsupported factories from a given list if {@code ignoreUnsupported == true}.
     *
     * @param                 factory type
     * @param  ignoreUnsupported whether to filter out unsupported factories from {@code preferred}
     * @param  preferred         initial list to filter
     * @return                   the filtered list of factories
     */
    static  List setUpBuiltinFactories(
            boolean ignoreUnsupported, Collection preferred) {
        return preferred.stream()
                .filter(f -> ignoreUnsupported ? f.isSupported() : true)
                .collect(Collectors.toList());
    }
}