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 org.apache.maven.artifact.Artifact;
25  import org.apache.maven.enforcer.rules.utils.ArtifactUtils;
26  import org.apache.maven.execution.MavenSession;
27  
28  /**
29   * This rule checks that lists of dependencies are not included.
30   *
31   * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
32   */
33  @Named("bannedDependencies")
34  public final class BannedDependencies extends BannedDependenciesBase {
35  
36      @Inject
37      BannedDependencies(MavenSession session, ResolverUtil resolverUtil) {
38          super(session, resolverUtil);
39      }
40  
41      @Override
42      protected boolean validate(Artifact artifact) {
43          return !ArtifactUtils.matchDependencyArtifact(artifact, getExcludes())
44                  || ArtifactUtils.matchDependencyArtifact(artifact, getIncludes());
45      }
46  
47      @Override
48      protected String getErrorMessage() {
49          return "banned via the exclude/include list";
50      }
51  
52      @Override
53      public String toString() {
54          return String.format(
55                  "BannedDependencies[message=%s, excludes=%s, includes=%s, searchTransitive=%b]",
56                  getMessage(), getExcludes(), getIncludes(), isSearchTransitive());
57      }
58  }