001    /*
002     * JBoss DNA (http://www.jboss.org/dna)
003     * See the COPYRIGHT.txt file distributed with this work for information
004     * regarding copyright ownership.  Some portions may be licensed
005     * to Red Hat, Inc. under one or more contributor license agreements.
006     * See the AUTHORS.txt file in the distribution for a full listing of 
007     * individual contributors. 
008     *
009     * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
010     * is licensed to you under the terms of the GNU Lesser General Public License as
011     * published by the Free Software Foundation; either version 2.1 of
012     * the License, or (at your option) any later version.
013     *
014     * JBoss DNA is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017     * Lesser General Public License for more details.
018     *
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this software; if not, write to the Free
021     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023     */
024    package org.jboss.dna.maven.spi;
025    
026    import java.net.MalformedURLException;
027    import java.net.URL;
028    import java.net.URLConnection;
029    import java.util.Properties;
030    import org.jboss.dna.maven.ArtifactType;
031    import org.jboss.dna.maven.MavenId;
032    import org.jboss.dna.maven.MavenRepository;
033    import org.jboss.dna.maven.MavenRepositoryException;
034    import org.jboss.dna.maven.SignatureType;
035    
036    /**
037     * @author Randall Hauch
038     */
039    public interface MavenUrlProvider {
040    
041        /**
042         * Configure this provider given the configuration properties. This method is intended to be called by the
043         * {@link MavenRepository} that instantiates this provider, and only once immediately after instantiation and before any calls
044         * to {@link #getUrl(MavenId, ArtifactType, SignatureType, boolean)}.
045         * @param properties the configuration properties
046         * @throws MavenRepositoryException if there is a problem connecting to or using the Maven repository, as configured
047         */
048        public void configure( Properties properties ) throws MavenRepositoryException;
049    
050        /**
051         * Get the URL for the artifact with the specified type in the given Maven project. The resulting URL can be used to
052         * {@link URL#openConnection() connect} to the repository to {@link URLConnection#getInputStream() read} or
053         * {@link URLConnection#getOutputStream() write} the artifact's content.
054         * @param mavenId the ID of the Maven project; may not be null
055         * @param artifactType the type of artifact; may be null, but the URL will not be able to be read or written to
056         * @param signatureType the type of signature; may be null if the signature file is not desired
057         * @param createIfRequired true if the node structure should be created if any part of it does not exist; this always expects
058         * that the path to the top of the repository tree exists.
059         * @return the URL to this artifact, or null if the artifact does not exist
060         * @throws MalformedURLException if the supplied information cannot be turned into a valid URL
061         * @throws MavenRepositoryException if there is a problem connecting to or using the Maven repository, as configured
062         */
063        public URL getUrl( MavenId mavenId, ArtifactType artifactType, SignatureType signatureType, boolean createIfRequired ) throws MalformedURLException, MavenRepositoryException;
064    
065    }