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