RejectDependenciesStrategy.java

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2012, Red Hat Middleware LLC, and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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.
 */
package org.jboss.shrinkwrap.resolver.api.maven.strategy;

import org.jboss.shrinkwrap.resolver.api.CoordinateParseException;
import org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenDependency;
import org.jboss.shrinkwrap.resolver.api.maven.filter.MavenResolutionFilter;
import org.jboss.shrinkwrap.resolver.api.maven.filter.RejectDependenciesFilter;

/**
 * {@link MavenResolutionStrategy} implementation where specified {@link MavenDependency}s may be selectively rejected
 *
 * @author <a href="mailto:kpiwko@redhat.com">Karel Piwko</a>
 * @author <a href="mailto:alr@jboss.org">Andrew Lee Rubinger</a>
 */
public class RejectDependenciesStrategy implements MavenResolutionStrategy {

    private final MavenResolutionFilter[] filters;

    /**
     * Bans all dependencies specified by coordinates including all transitive dependencies that might be fetched by resolving
     * coordinates.
     *
     * @param coordinates Coordinates to be banned
     * @throws IllegalArgumentException If no coordinates are specified
     * @throws CoordinateParseException If coordinates does not follow required format
     *
     */
    public RejectDependenciesStrategy(final String... coordinates) throws IllegalArgumentException, CoordinateParseException {
        this(true, coordinates);
    }

    /**
     * Bans all dependencies specified by coordinates possibly including all transitive dependencies that might be fetched by
     * resolving coordinates.
     *
     * @param rejectTransitives Flag to allow rejecting transitive dependencies of specified coordinates
     * @param coordinates Coordinates to be banned
     * @throws IllegalArgumentException If no coordinates are specified
     * @throws CoordinateParseException If coordinates does not follow required format
     *
     */
    public RejectDependenciesStrategy(final boolean rejectTransitives, final String... coordinates)
            throws IllegalArgumentException, CoordinateParseException {
        if (coordinates == null || coordinates.length == 0) {
            throw new IllegalArgumentException("There must be at least one coordinate specified to be rejected.");
        }

        // CoordinateParseException handled by RejectDependenciesFilter
        this.filters = new MavenResolutionFilter[] { new RejectDependenciesFilter(rejectTransitives, coordinates) };
    }

    /**
     * Returns a {@link MavenResolutionFilter} chain blocking {@link MavenDependency}s with coordinates supplied at
     * instance construction
     *
     * @see org.jboss.shrinkwrap.resolver.api.maven.strategy.MavenResolutionStrategy#getResolutionFilters()
     */
    @Override
    public MavenResolutionFilter[] getResolutionFilters() {
        return this.filters;
    }

    /**
     * {@inheritDoc}
     *
     * @see org.jboss.shrinkwrap.resolver.api.maven.strategy.MavenResolutionStrategy#getTransitiveExclusionPolicy()
     */
    @Override
    public TransitiveExclusionPolicy getTransitiveExclusionPolicy() {
        return DefaultTransitiveExclusionPolicy.INSTANCE;
    }

}