001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.maven.enforcer.rules.dependency;
020
021import javax.inject.Inject;
022import javax.inject.Named;
023
024import java.util.function.Predicate;
025
026import org.apache.maven.artifact.Artifact;
027import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
028import org.apache.maven.enforcer.rules.utils.ArtifactUtils;
029import org.apache.maven.execution.MavenSession;
030
031/**
032 * This rule checks that lists of dependencies are not included.
033 *
034 * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
035 */
036@Named("bannedDependencies")
037public final class BannedDependencies extends BannedDependenciesBase {
038
039    private Predicate<Artifact> shouldExclude;
040    private Predicate<Artifact> shouldInclude;
041
042    @Inject
043    BannedDependencies(MavenSession session, ResolverUtil resolverUtil) {
044        super(session, resolverUtil);
045    }
046
047    @Override
048    public void execute() throws EnforcerRuleException {
049        shouldExclude = ArtifactUtils.prepareDependencyArtifactMatcher(getExcludes());
050        shouldInclude = ArtifactUtils.prepareDependencyArtifactMatcher(getIncludes());
051        super.execute();
052    }
053
054    @Override
055    protected boolean validate(Artifact artifact) {
056        return !shouldExclude.test(artifact) || shouldInclude.test(artifact);
057    }
058
059    @Override
060    protected String getErrorMessage() {
061        return "banned via the exclude/include list";
062    }
063
064    @Override
065    public String toString() {
066        return String.format(
067                "BannedDependencies[message=%s, excludes=%s, includes=%s, searchTransitive=%b]",
068                getMessage(), getExcludes(), getIncludes(), isSearchTransitive());
069    }
070}