org.fabric3.spi.contribution.ContributionResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fabric3-spi Show documentation

Fabric3

There is a newer version: 3.0.0

/*
 * 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.spi.contribution;

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

/**
 * Implementations resolve contribution artifacts in a domain.
 */
public interface ContributionResolver {

    /**
     * Resolves the contribution artifact associated with the URI, returning a local URL by which it may be dereferenced.
     *
     * @param contributionUri the contribution URI
     * @return the local dereferenceable URL for the artifact
     * @throws ResolutionException if an error occurs resolving the artifact
     */
    URL resolve(URI contributionUri) throws ResolutionException;

    /**
     * Resolves the contribution artifact associated with the URI, returning a set of local URLs by which it may be dereferenced. Multiple URLs are returned for
     * exploded contributions, e.g. a contribution mapped to multiple directories in a development environment.
     *
     * @param contributionUri the contribution URI
     * @return the local dereferenceable URL for the artifact
     * @throws ResolutionException if an error occurs resolving the artifact
     */
    List resolveAllLocations(URI contributionUri) throws ResolutionException;

    /**
     * Releases a previously resolved contribution.
     *
     * @param contributionUri the contribution  URI.
     * @throws ResolutionException if an error occurs releasing the artifact
     */
    void release(URI contributionUri) throws ResolutionException;

}