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 org.apache.maven.artifact.Artifact;
025import org.apache.maven.enforcer.rules.utils.ArtifactUtils;
026import org.apache.maven.execution.MavenSession;
027
028/**
029 * This rule checks that lists of dependencies are not included.
030 *
031 * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
032 */
033@Named("bannedDependencies")
034public final class BannedDependencies extends BannedDependenciesBase {
035
036    @Inject
037    BannedDependencies(MavenSession session, ResolverUtil resolverUtil) {
038        super(session, resolverUtil);
039    }
040
041    @Override
042    protected boolean validate(Artifact artifact) {
043        return !ArtifactUtils.matchDependencyArtifact(artifact, getExcludes())
044                || ArtifactUtils.matchDependencyArtifact(artifact, getIncludes());
045    }
046
047    @Override
048    protected String getErrorMessage() {
049        return "banned via the exclude/include list";
050    }
051
052    @Override
053    public String toString() {
054        return String.format(
055                "BannedDependencies[message=%s, excludes=%s, includes=%s, searchTransitive=%b]",
056                getMessage(), getExcludes(), getIncludes(), isSearchTransitive());
057    }
058}