nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-nar-utils/src/main/java/org/apache/nifi/nar/ExtensionDiscoveringManager.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.nar;

import org.apache.nifi.bundle.Bundle;

import java.util.Set;

/**
 * ExtensionManage that can discovers and load extensions.
 */
public interface ExtensionDiscoveringManager extends ExtensionManager {

    /**
     * Discovers all extensions available in the provided bundles.
     *
     * This method is intended to be called only once during application start-up.
     *
     * @param systemBundle the system bundle
     * @param narBundles the bundles to use for discovering extensions
     */
    void discoverExtensions(Bundle systemBundle, Set<Bundle> narBundles);

    /**
     * Discovers extensions in the provided bundles.
     *
     * This method is intended to be used to discover additional extensions after the application is running.
     *
     * @param narBundles the bundles to use for discovering extensions
     */
    default void discoverExtensions(Set<Bundle> narBundles) {
        discoverExtensions(narBundles, true);
    }

    /**
     * Discovers extensions in the provided bundles.
     *
     * This method is intended to be used to discover additional extensions after the application is running.
     *
     * @param narBundles the bundles to use for discovering extensions
     * @param logDetails whether or not to log the details about what is loaded
     */
    void discoverExtensions(Set<Bundle> narBundles, boolean logDetails);

}