archetype-common/src/main/java/org/apache/maven/archetype/ArchetypeGenerationRequest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.maven.archetype;

import java.util.ArrayList;
import java.util.List;
import java.util.Properties;

import org.apache.maven.archetype.catalog.Archetype;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.project.ProjectBuildingRequest;
import org.apache.maven.settings.Mirror;
import org.apache.maven.settings.Proxy;
import org.apache.maven.settings.Server;
import org.apache.maven.wagon.events.TransferListener;
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.repository.RemoteRepository;

/** @author Jason van Zyl */
public class ArchetypeGenerationRequest {
    private ProjectBuildingRequest projectBuildingRequest;

    private RepositorySystemSession repositorySystemSession;

    private List<RemoteRepository> remoteRepositories;

    private boolean offline;

    private boolean interactiveMode;

    private boolean askForDefaultPropertyValues;

    private TransferListener transferListener;

    private String outputDirectory;

    private Proxy activeProxy;

    private List<Server> servers = new ArrayList<>();

    private List<Mirror> mirrors = new ArrayList<>();

    // Archetype definition
    private String archetypeName;

    private String archetypeGroupId;

    private String archetypeArtifactId;

    private String archetypeVersion;

    private String archetypeGoals = "";

    /**
     * The URL to the archetype repository
     *
     * @deprecated see ARCHETYPE-439
     */
    @Deprecated
    private String archetypeRepository;

    // Archetype configuration
    private String groupId;

    private String artifactId;

    private String version;

    private String packageName;

    private Properties properties = new Properties();

    /**
     *  @since 2.1
     */
    private String filter;

    public ArchetypeGenerationRequest() {
        // no op
    }

    public ArchetypeGenerationRequest(Archetype archetype) {
        this.archetypeGroupId = archetype.getGroupId();

        this.archetypeArtifactId = archetype.getArtifactId();

        this.archetypeVersion = archetype.getVersion();

        this.archetypeRepository = archetype.getRepository();
    }

    public ProjectBuildingRequest getProjectBuildingRequest() {
        return projectBuildingRequest;
    }

    public ArchetypeGenerationRequest setProjectBuildingRequest(ProjectBuildingRequest projectBuildingRequest) {
        this.projectBuildingRequest = projectBuildingRequest;
        return this;
    }

    /**
     * @since TBD
     */
    public RepositorySystemSession getRepositorySystemSession() {
        return repositorySystemSession;
    }

    /**
     * @since TBD
     */
    public ArchetypeGenerationRequest setRepositorySystemSession(RepositorySystemSession repositorySystemSession) {
        this.repositorySystemSession = repositorySystemSession;
        return this;
    }

    /**
     * @since TBD
     */
    public List<RemoteRepository> getRemoteRepositories() {
        return remoteRepositories;
    }

    /**
     * @since TBD
     */
    public ArchetypeGenerationRequest setRemoteRepositories(List<RemoteRepository> remoteRepositories) {
        this.remoteRepositories = remoteRepositories;
        return this;
    }

    public String getArchetypeGroupId() {
        return archetypeGroupId;
    }

    public ArchetypeGenerationRequest setArchetypeGroupId(String archetypeGroupId) {
        this.archetypeGroupId = archetypeGroupId;

        return this;
    }

    public String getArchetypeArtifactId() {
        return archetypeArtifactId;
    }

    public ArchetypeGenerationRequest setArchetypeArtifactId(String archetypeArtifactId) {
        this.archetypeArtifactId = archetypeArtifactId;

        return this;
    }

    public String getArchetypeVersion() {
        return archetypeVersion;
    }

    public ArchetypeGenerationRequest setArchetypeVersion(String archetypeVersion) {
        this.archetypeVersion = archetypeVersion;

        return this;
    }

    public String getArchetypeGoals() {
        return archetypeGoals;
    }

    public ArchetypeGenerationRequest setArchetypeGoals(String archetypeGoals) {
        this.archetypeGoals = archetypeGoals;

        return this;
    }

    public String getArchetypeName() {
        return archetypeName;
    }

    public ArchetypeGenerationRequest setArchetypeName(String archetypeName) {
        this.archetypeName = archetypeName;

        return this;
    }

    /**
     *
     * @return the URL of the archetype repository
     * @deprecated see ARCHETYPE-439
     */
    @Deprecated
    public String getArchetypeRepository() {
        return archetypeRepository;
    }

    /**
     *
     * @param archetypeRepository the URL of the archetype repository
     * @return this request
     * @deprecated see ARCHETYPE-439
     */
    @Deprecated
    public ArchetypeGenerationRequest setArchetypeRepository(String archetypeRepository) {
        this.archetypeRepository = archetypeRepository;

        return this;
    }

    public String getArtifactId() {
        return artifactId;
    }

    public ArchetypeGenerationRequest setArtifactId(String artifactId) {
        this.artifactId = artifactId;

        return this;
    }

    public String getGroupId() {
        return groupId;
    }

    public ArchetypeGenerationRequest setGroupId(String groupId) {
        this.groupId = groupId;

        return this;
    }

    public String getVersion() {
        return version;
    }

    public ArchetypeGenerationRequest setVersion(String version) {
        this.version = version;

        return this;
    }

    public String getPackage() {
        return packageName;
    }

    public ArchetypeGenerationRequest setPackage(String packageName) {
        this.packageName = packageName;

        return this;
    }

    public Properties getProperties() {
        return properties;
    }

    public ArchetypeGenerationRequest setProperties(Properties additionalProperties) {
        this.properties = additionalProperties;

        return this;
    }

    @Deprecated
    public ArtifactRepository getLocalRepository() {
        return null;
    }

    @Deprecated
    public ArchetypeGenerationRequest setLocalRepository(ArtifactRepository localRepository) {
        return this;
    }

    public String getOutputDirectory() {
        return outputDirectory;
    }

    public ArchetypeGenerationRequest setOutputDirectory(String outputDirectory) {
        this.outputDirectory = outputDirectory;

        return this;
    }

    public boolean isInteractiveMode() {
        return interactiveMode;
    }

    public ArchetypeGenerationRequest setInteractiveMode(boolean interactiveMode) {
        this.interactiveMode = interactiveMode;

        return this;
    }

    public boolean isAskForDefaultPropertyValues() {
        return askForDefaultPropertyValues;
    }

    public ArchetypeGenerationRequest setAskForDefaultPropertyValues(boolean askForDefaultPropertyValues) {
        this.askForDefaultPropertyValues = askForDefaultPropertyValues;

        return this;
    }

    public boolean isOffline() {
        return offline;
    }

    public ArchetypeGenerationRequest setOffline(boolean offline) {
        this.offline = offline;

        return this;
    }

    public TransferListener getTransferListener() {
        return transferListener;
    }

    public ArchetypeGenerationRequest setTransferListener(TransferListener transferListener) {
        this.transferListener = transferListener;

        return this;
    }

    public Proxy getActiveProxy() {
        return activeProxy;
    }

    public ArchetypeGenerationRequest setActiveProxy(Proxy activeProxy) {
        this.activeProxy = activeProxy;

        return this;
    }

    public ArchetypeGenerationRequest addMirror(Mirror mirror) {
        mirrors.add(mirror);

        return this;
    }

    public List<Mirror> getMirrors() {
        return mirrors;
    }

    /**
     * @deprecated Use {@link #addServer(Server)} instead
     */
    @Deprecated
    public ArchetypeGenerationRequest addMirror(Server server) {
        return addServer(server);
    }

    public ArchetypeGenerationRequest addServer(Server server) {
        servers.add(server);

        return this;
    }

    public List<Server> getServers() {
        return servers;
    }

    @Deprecated
    public List<ArtifactRepository> getRemoteArtifactRepositories() {
        return null;
    }

    @Deprecated
    public ArchetypeGenerationRequest setRemoteArtifactRepositories(
            List<ArtifactRepository> remoteArtifactRepositories) {
        return this;
    }

    public String getFilter() {
        return filter;
    }

    public ArchetypeGenerationRequest setFilter(String filter) {
        this.filter = filter;

        return this;
    }
}