View Javadoc

1   package org.apache.maven.settings.building;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.IOException;
23  import java.io.InputStream;
24  import java.net.URL;
25  
26  /**
27   * Wraps an ordinary {@link URL} as a settings source.
28   * 
29   * @author Benjamin Bentmann
30   */
31  public class UrlSettingsSource
32      implements SettingsSource
33  {
34  
35      private URL settingsUrl;
36  
37      /**
38       * Creates a new model source backed by the specified URL.
39       * 
40       * @param settingsUrl The settings URL, must not be {@code null}.
41       */
42      public UrlSettingsSource( URL settingsUrl )
43      {
44          if ( settingsUrl == null )
45          {
46              throw new IllegalArgumentException( "no settings URL specified" );
47          }
48          this.settingsUrl = settingsUrl;
49      }
50  
51      public InputStream getInputStream()
52          throws IOException
53      {
54          return settingsUrl.openStream();
55      }
56  
57      public String getLocation()
58      {
59          return settingsUrl.toString();
60      }
61  
62      /**
63       * Gets the settings URL of this model source.
64       * 
65       * @return The underlying settings URL, never {@code null}.
66       */
67      public URL getSettingsUrl()
68      {
69          return settingsUrl;
70      }
71  
72      @Override
73      public String toString()
74      {
75          return getLocation();
76      }
77  
78  }