001package org.apache.maven.settings.building;
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
022import java.io.IOException;
023import java.io.InputStream;
024import java.net.URL;
025
026/**
027 * Wraps an ordinary {@link URL} as a settings source.
028 * 
029 * @author Benjamin Bentmann
030 */
031public class UrlSettingsSource
032    implements SettingsSource
033{
034
035    private URL settingsUrl;
036
037    /**
038     * Creates a new model source backed by the specified URL.
039     * 
040     * @param settingsUrl The settings URL, must not be {@code null}.
041     */
042    public UrlSettingsSource( URL settingsUrl )
043    {
044        if ( settingsUrl == null )
045        {
046            throw new IllegalArgumentException( "no settings URL specified" );
047        }
048        this.settingsUrl = settingsUrl;
049    }
050
051    public InputStream getInputStream()
052        throws IOException
053    {
054        return settingsUrl.openStream();
055    }
056
057    public String getLocation()
058    {
059        return settingsUrl.toString();
060    }
061
062    /**
063     * Gets the settings URL of this model source.
064     * 
065     * @return The underlying settings URL, never {@code null}.
066     */
067    public URL getSettingsUrl()
068    {
069        return settingsUrl;
070    }
071
072    @Override
073    public String toString()
074    {
075        return getLocation();
076    }
077
078}