nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-ui-extension/src/main/java/org/apache/nifi/ui/extension/UiExtensionMapping.java

/*
 * 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.nifi.ui.extension;

import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * Mapping of all discovered UI extensions.
 */
public class UiExtensionMapping {

    private final Map<String, List<UiExtension>> uiExtensions = new ConcurrentHashMap<>();

    public UiExtensionMapping(Map<String, List<UiExtension>> uiExtensions) {
        this.uiExtensions.putAll(uiExtensions);
    }

    private String getBundleSpecificKey(final String type, final String bundleGroup, final String bundleArtifact, final String bundleVersion) {
        return type + ":" + bundleGroup + ":" + bundleArtifact + ":" + bundleVersion;
    }

    /**
     * @param type type
     * @param bundleGroup bundle group
     * @param bundleArtifact bundle artifact
     * @param bundleVersion bundle version
     * @return whether there are any UI extensions for the specified component
     * type
     */
    public boolean hasUiExtension(final String type, final String bundleGroup, final String bundleArtifact, final String bundleVersion) {
        // if there is an extension registered with these bundle coordinates use it
        final String bundleSpecificKey = getBundleSpecificKey(type, bundleGroup, bundleArtifact, bundleVersion);
        if (uiExtensions.containsKey(bundleSpecificKey)) {
            return true;
        }

        // otherwise fall back to the component type
        return uiExtensions.containsKey(type);
    }

    /**
     * @param type type
     * @param bundleGroup bundle group
     * @param bundleArtifact bundle artifact
     * @param bundleVersion bundle version
     * @return the listing of all discovered UI extensions for the specified
     * component type
     */
    public List<UiExtension> getUiExtension(final String type, final String bundleGroup, final String bundleArtifact, final String bundleVersion) {
        // if there is an extension registered with these bundle coordinates use it
        final String bundleSpecificKey = getBundleSpecificKey(type, bundleGroup, bundleArtifact, bundleVersion);
        if (uiExtensions.containsKey(bundleSpecificKey)) {
            return uiExtensions.get(bundleSpecificKey);
        }

        // otherwise fall back to the component type
        return uiExtensions.get(type);
    }

    /**
     * Adds additional UI extensions to the mapping.
     *
     * @param uiExtensions the additional UI extension mappings.
     */
    public void addUiExtensions(Map<String, List<UiExtension>> uiExtensions) {
        this.uiExtensions.putAll(uiExtensions);
    }

}