org.fabric3.contribution.DependencyResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fabric3-contribution Show documentation
Fabric3
The newest version!
/*
 * Fabric3
 * Copyright (c) 2009-2015 Metaform Systems
 *
 * 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.
 * Portions originally based on Apache Tuscany 2007
 * licensed under the Apache 2.0 license.
 */
package org.fabric3.contribution;

import java.net.URI;
import java.util.List;

import org.fabric3.api.host.Fabric3Exception;
import org.fabric3.spi.contribution.Contribution;

/**
 * Resolves contribution dependencies.
 */
public interface DependencyResolver {

    /**
     * Resolves dependencies for the given contributions. An ordered list is returned based on a reverse topological sort of contribution resolved imports and
     * capability requirements.
     *
     * @param contributions the  list of contributions to order
     * @return the ordered list of contributions
     * @throws Fabric3Exception if an error occurs ordering the contributions such as an unresolvable import or dependency cycle
     */
    List resolve(List contributions) throws Fabric3Exception;

    /**
     * Orders a list of contributions to uninstall. Ordering is calculated by topologically sorting the list based on resolved contribution imports and
     * capability requirements.
     *
     * @param contributions the contributions to order
     * @return the ordered list of contributions
     */
    List orderForUninstall(List contributions);

    /**
     * Returns the contribution and its transitive dependents in order. For example, if C2 depends on C1 and C3 on C2, the collection returned will be {C3, C2,
     * C1}.
     *
     * @param uri the contribution URI
     * @return an ordered collection containing the contribution and its transitive dependents
     */
    List orderContributionAndDependents(URI uri);
}