com.agapsys.rcf.scanner.RcListMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rcf-scanner-maven-plugin Show documentation

Maven plugin which scans REST controllers for applications unsing Agapsys REST Controller Framework

The newest version!

/*
 * Copyright 2016 Agapsys Tecnologia Ltda-ME.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.agapsys.rcf.scanner;

import com.agapsys.mvn.scanner.AbstractListMojo;
import com.agapsys.mvn.scanner.ScannerDefs;
import static com.agapsys.rcf.scanner.RcScannerDefs.log;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;

/**
 * RCF implementation of {@linkplain AbstractListMojo}
 */
@Mojo(name = "list", defaultPhase = LifecyclePhase.GENERATE_RESOURCES, requiresDependencyResolution = ResolutionScope.COMPILE)
public class RcListMojo extends AbstractListMojo {

    @Parameter(property = "project", readonly = true)
    private MavenProject mavenProject;

    @Override
    protected MavenProject getMavenProject() {
        return mavenProject;
    }

    @Parameter(defaultValue = "controllers")
    private String filterProperty;

    @Override
    protected String getFilterPropertyName() {
        return filterProperty;
    }

    @Override
    protected String getExposedEntry(String scanInfoEntry) {
        return scanInfoEntry + "\n";
    }

    @Override
    protected ScannerDefs getScannerDefs() {
        return RcScannerDefs.getInstance();
    }

    @Parameter(defaultValue = "false", name = RcScannerDefs.OPTION_INCLUDE_DEPENDENCIES)
    private boolean includeDependencies;

    @Override
    protected boolean includeDependencies() {
        return includeDependencies;
    }

    @Parameter(defaultValue = "false", name = RcScannerDefs.OPTION_INCLUDE_TESTS)
    private boolean includeTests;

    @Override
    protected boolean includeTests() {
        return includeTests;
    }

    @Override
    public void execute() throws MojoExecutionException {
        log("Listing controllers...");
        super.execute();
        log("Done!");
    }

}