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.version;
020
021import javax.inject.Inject;
022import javax.inject.Named;
023
024import java.util.Objects;
025
026import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
027import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
028import org.apache.maven.rtinfo.RuntimeInformation;
029
030/**
031 * This rule checks that the Maven version is allowed.
032 *
033 * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
034 */
035@Named("requireMavenVersion")
036public final class RequireMavenVersion extends AbstractVersionEnforcer {
037
038    private final RuntimeInformation runtimeInformation;
039
040    @Inject
041    public RequireMavenVersion(RuntimeInformation runtimeInformation) {
042        this.runtimeInformation = Objects.requireNonNull(runtimeInformation);
043    }
044
045    @Override
046    public void execute() throws EnforcerRuleException {
047        String mavenVersion = runtimeInformation.getMavenVersion();
048        getLog().debug("Detected Maven Version: " + mavenVersion);
049        if (mavenVersion == null) {
050            throw new EnforcerRuleException("Unable to detect Maven Version");
051        }
052        DefaultArtifactVersion detectedVersion = new DefaultArtifactVersion(mavenVersion);
053        enforceVersion("Maven", getVersion(), detectedVersion);
054    }
055
056    @Override
057    public String toString() {
058        return String.format("%s[message=%s, version=%s]", getClass().getSimpleName(), getMessage(), getVersion());
059    }
060}