001    package org.apache.maven.artifact.installer;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *  http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import java.io.File;
023    
024    import org.apache.maven.artifact.Artifact;
025    import org.apache.maven.artifact.repository.ArtifactRepository;
026    
027    /**
028     * @author <a href="michal@codehaus.org">Michal Maczka</a>
029     */
030    public interface ArtifactInstaller
031    {
032        String ROLE = ArtifactInstaller.class.getName();
033    
034        /**
035         * Install an artifact from a particular directory. The artifact handler is used to determine
036         * the filename of the source file.
037         *
038         * @param basedir the directory where the artifact is stored
039         * @param finalName the name of the artifact sans extension
040         * @param artifact the artifact definition
041         * @param localRepository the local repository to install into
042         * @throws ArtifactInstallationException if an error occurred installing the artifact
043         * @deprecated to be removed before 2.0 after the instlal/deploy plugins use the alternate
044         *             method
045         */
046        @Deprecated
047        void install( String basedir, String finalName, Artifact artifact, ArtifactRepository localRepository )
048            throws ArtifactInstallationException;
049    
050        /**
051         * Install an artifact from a particular file.
052         *
053         * @param source the file to install
054         * @param artifact the artifact definition
055         * @param localRepository the local repository to install into
056         * @throws ArtifactInstallationException if an error occurred installing the artifact
057         */
058        void install( File source, Artifact artifact, ArtifactRepository localRepository )
059            throws ArtifactInstallationException;
060    }