View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.enforcer.rules.dependency;
20  
21  import javax.inject.Inject;
22  import javax.inject.Named;
23  
24  import java.util.function.Predicate;
25  
26  import org.apache.maven.artifact.Artifact;
27  import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
28  import org.apache.maven.enforcer.rules.utils.ArtifactUtils;
29  import org.apache.maven.execution.MavenSession;
30  
31  /**
32   * This rule checks that lists of dependencies are not included.
33   *
34   * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
35   */
36  @Named("bannedDependencies")
37  public final class BannedDependencies extends BannedDependenciesBase {
38  
39      private Predicate<Artifact> shouldExclude;
40      private Predicate<Artifact> shouldInclude;
41  
42      @Inject
43      BannedDependencies(MavenSession session, ResolverUtil resolverUtil) {
44          super(session, resolverUtil);
45      }
46  
47      @Override
48      public void execute() throws EnforcerRuleException {
49          shouldExclude = ArtifactUtils.prepareDependencyArtifactMatcher(getExcludes());
50          shouldInclude = ArtifactUtils.prepareDependencyArtifactMatcher(getIncludes());
51          super.execute();
52      }
53  
54      @Override
55      protected boolean validate(Artifact artifact) {
56          return !shouldExclude.test(artifact) || shouldInclude.test(artifact);
57      }
58  
59      @Override
60      protected String getErrorMessage() {
61          return "banned via the exclude/include list";
62      }
63  
64      @Override
65      public String toString() {
66          return String.format(
67                  "BannedDependencies[message=%s, excludes=%s, includes=%s, searchTransitive=%b]",
68                  getMessage(), getExcludes(), getIncludes(), isSearchTransitive());
69      }
70  }