001/*
002 * Copyright 2007 The Kuali Foundation
003 * 
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 * 
008 * http://www.opensource.org/licenses/ecl2.php
009 * 
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kualigan.maven.plugins.api;
017
018import java.io.File;
019
020import org.apache.maven.plugin.MojoExecutionException;
021import org.apache.maven.plugin.AbstractMojo;
022
023
024/**
025 * @author Leo Przybylski (leo [at] rsmart.com)
026 */
027public interface OverlayHelper {
028    String ROLE = OverlayHelper.class.getName();
029
030    /**
031     * Invokes the maven goal {@code archetype:generate} with the appropriate properties.
032     * 
033     */
034    void generateArchetype(final File mavenHome,
035                           final String archetypeGroupId,
036                           final String archetypeArtifactId,
037                           final String archetypeVersion,
038                           final String groupId,
039                           final String artifactId,
040                           final String version,
041                           final String prototypeGroupId,
042                           final String prototypeArtifactId,
043                           final String prototypeVersion) throws MojoExecutionException;
044
045    void setCaller(final AbstractMojo caller);
046    
047    AbstractMojo getCaller();
048}