package org.apache.maven.artifact.deployer;

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *    "Apache MavenSession" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    "Apache MavenSession", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 * ====================================================================
 */

import org.apache.maven.MavenException;
import org.apache.maven.project.Project;

/**
 * 
 * The Bean which is used in Jelly Scripts 
 * and serves as a proxy to Artifact Deployer API
 * 
 * Note that all paths in repository are computed 
 * and source file name is igonred.
 * 
 * Other remark: To deploy an artifact means much 
 * more then to copy signle file. In every case
 * also MD5 file created and copied  to remote repository.
 * In case of snapshots the process in even more complex. 
 * 
 * @author <a href="michal.maczka@dimatics.com">Michal Maczka</a> 
 * @version $Id: ArtifactDeployer.java,v 1.2 2003/06/29 11:57:39 michal Exp $
 */
public interface ArtifactDeployer
{

    /**
     * Deploy given artifact to remote repository     
     * 
     * @param artifact Artifact filename
     * @param type  The type of the artifact 
     *     (like <code>war</code>, <code>jar</code>)
     * @param project The project which is a producer of the artifact
     *         POM conatains a bunch of varaiables which are used
     *         to control the deployment process (e.g 
     *         <ul>
     *             <li>artifactId<li>
     *             <li>groupId</li>
     *             <li>list of remote repositories</li>
     *         </ul> 
     *          
     * @throws MavenException 
     */
    public void deploy(String artifact, String type, Project project)
        throws MavenException;

    /**
     * Deploy given artifact as a snapshot to remote repository 
     * @param artifact
     * @param type The type of the artifact 
     *     (like <code>war</code>, <code>jar</code>)
     * @param project The project which is a producer of the artifact
     * @see ArtifactDeployer#deploy(String, String, Project)
     * 
     * @throws MavenException
     */
    public void deploySnapshot(String artifact, String type, Project project)
        throws MavenException;

    /**
     * Install given artifact in local repository
     * @param artifact file name of the artifact
     * @param type The type of the artifact 
     *     (like <code>war</code>, <code>jar</code>)
     * @param project The project which is a producer of the artifact
     * @throws MavenException
     */
    public void install(String artifact, String type, Project project)
        throws MavenException;

    /**
     * Install given artifact as snapshot in  local repository
     * @param artifact
     * @param type The type of the artifact 
     *     (like <code>war</code>, <code>jar</code>)
     * @param project The project which is a producer of the artifact
     * @throws MavenException
     */
    public void installSnapshot(String artifact, String type, Project project)
        throws MavenException;
        
               
}
