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.version;
20  
21  import javax.inject.Inject;
22  import javax.inject.Named;
23  
24  import java.util.Objects;
25  
26  import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
27  import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
28  import org.apache.maven.rtinfo.RuntimeInformation;
29  
30  /**
31   * This rule checks that the Maven version is allowed.
32   *
33   * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
34   */
35  @Named("requireMavenVersion")
36  public final class RequireMavenVersion extends AbstractVersionEnforcer {
37  
38      private final RuntimeInformation runtimeInformation;
39  
40      @Inject
41      public RequireMavenVersion(RuntimeInformation runtimeInformation) {
42          this.runtimeInformation = Objects.requireNonNull(runtimeInformation);
43      }
44  
45      @Override
46      public void execute() throws EnforcerRuleException {
47          String mavenVersion = runtimeInformation.getMavenVersion();
48          getLog().debug("Detected Maven Version: " + mavenVersion);
49          if (mavenVersion == null) {
50              throw new EnforcerRuleException("Unable to detect Maven Version");
51          }
52          DefaultArtifactVersion detectedVersion = new DefaultArtifactVersion(mavenVersion);
53          enforceVersion("Maven", getVersion(), detectedVersion);
54      }
55  
56      @Override
57      public String toString() {
58          return String.format("%s[message=%s, version=%s]", getClass().getSimpleName(), getMessage(), getVersion());
59      }
60  }