org.apache.camel.maven.packaging.EndpointHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-package-maven-plugin Show documentation
Maven plugin to help package Camel components and plugins
There is a newer version: 4.9.0
Show 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.camel.maven.packaging;

import java.util.Comparator;
import java.util.Objects;

import org.apache.camel.tooling.model.BaseOptionModel;
import org.apache.camel.tooling.util.Strings;

public final class EndpointHelper {

    private EndpointHelper() {
    }

    /**
     * Returns the group name from the given label.
     * 
     * The group name is a single name deducted from the label. The label can contain multiple names separated by comma.
     * The group is the best guess as a group of those labels, so similar labels can be combined into the same group.
     *
     * @param  label        the label
     * @param  consumerOnly whether the component is consumer only
     * @param  producerOnly whether the component is producer only
     * @return              the group name
     */
    public static String labelAsGroupName(String label, boolean consumerOnly, boolean producerOnly) {
        // if there is no label then use common as fallback
        String answer = "common";
        if (consumerOnly) {
            answer = "consumer";
        } else if (producerOnly) {
            answer = "producer";
        }

        String value = label;
        if (!Strings.isNullOrEmpty(value)) {

            // we want to put advanced into own group, so look for a label that
            // has advanced as prefix x,advanced => x (advanced)
            if (value.contains("advanced")) {
                value = value.replaceFirst("(\\w),(advanced)", "$1 (advanced)");
            }

            if (value.contains(",")) {
                String[] array = value.split(",");
                // grab last label which is the most specific label we want to
                // use for the tab
                answer = array[array.length - 1];
            } else {
                answer = value;
            }
        }

        return answer;
    }

    /**
     * A comparator to sort the endpoint/component options according to group and label.
     */
    public static Comparator createGroupAndLabelComparator() {
        return new EndpointOptionGroupAndLabelComparator();
    }

    /**
     * A comparator to sort the endpoint paths according to syntax.
     *
     * @param syntax the endpoint uri syntax
     */
    public static Comparator createPathComparator(String syntax) {
        return new EndpointPathComparator(syntax);
    }

    /**
     * A comparator to sort endpoints options: first paths according to the path comparator, then parameters according
     * to their group and label.
     *
     * @param syntax the endpoint uri syntax
     */
    public static Comparator createOverallComparator(String syntax) {
        Comparator pathComparator = createPathComparator(syntax);
        Comparator groupAndLabelComparator = createGroupAndLabelComparator();
        return (o1, o2) -> {
            if (Objects.equals("path", o1.getKind())) {
                if (Objects.equals("path", o2.getKind())) {
                    return pathComparator.compare(o1, o2);
                } else {
                    return -1;
                }
            } else {
                if (Objects.equals("path", o2.getKind())) {
                    return +1;
                } else {
                    return groupAndLabelComparator.compare(o1, o2);
                }
            }
        };
    }

    /**
     * To sort the component/endpoint options in human friendly order.
     * 

     * The order is to include options grouped by
     * 

     * common
     * consumer
     * consumer (advanced)
     * producer
     * consumer (advanced)
     * ... and the rest sorted by a..z
     * 
     */
    private static final class EndpointOptionGroupAndLabelComparator implements Comparator {

        @Override
        public int compare(BaseOptionModel o1, BaseOptionModel o2) {
            String name1 = o1.getName();
            String name2 = o2.getName();
            String label1 = !Strings.isNullOrEmpty(o1.getLabel()) ? o1.getLabel() : "common";
            String label2 = !Strings.isNullOrEmpty(o2.getLabel()) ? o2.getLabel() : "common";
            String group1 = o1.getGroup();
            String group2 = o2.getGroup();

            // if same label or group then sort by name
            if (label1.equalsIgnoreCase(label2) || group1.equalsIgnoreCase(group2)) {
                return name1.compareToIgnoreCase(name2);
            }

            int score1 = groupScore(group1);
            int score2 = groupScore(group2);

            if (score1 < score2) {
                return -1;
            } else if (score2 < score1) {
                return 1;
            } else {
                int score = group1.compareToIgnoreCase(group2);
                if (score == 0) {
                    // compare by full label and name
                    score = label1.compareToIgnoreCase(label2);
                    if (score == 0) {
                        score = name1.compareToIgnoreCase(name2);
                    }
                }
                return score;
            }
        }
    }

    private static int groupScore(String group) {
        switch (group) {
            case "common":
                return 1;
            case "common (advanced)":
                return 2;
            case "consumer":
                return 3;
            case "consumer (advanced)":
                return 4;
            case "producer":
                return 5;
            case "producer (advanced)":
                return 6;
            default:
                return 9;
        }
    }

    private static final class EndpointPathComparator implements Comparator {

        private final String syntax;

        EndpointPathComparator(String syntax) {
            this.syntax = syntax;
        }

        @Override
        public int compare(BaseOptionModel path1, BaseOptionModel path2) {
            int pos1 = syntax != null ? syntax.indexOf(path1.getName()) : -1;
            int pos2 = syntax != null ? syntax.indexOf(path2.getName()) : -1;

            // use position in syntax to determine the order
            if (pos1 != -1 && pos2 != -1) {
                return Integer.compare(pos1, pos2);
            }
            return 0;
        }
    }

}