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
25 /**
26 * Provides access to the contents of settings independently of the backing store (e.g. file system, database, memory).
27 *
28 * @author Benjamin Bentmann
29 */
30 public interface SettingsSource
31 {
32
33 /**
34 * Gets a byte stream to the settings contents. Closing the returned stream is the responsibility of the caller.
35 * Note that each invocation of this method returns a new/fresh stream which represents the entire contents.
36 *
37 * @return A byte stream to the settings contents, never {@code null}.
38 */
39 InputStream getInputStream()
40 throws IOException;
41
42 /**
43 * Provides a user-friendly hint about the location of the settings. This could be a local file path, a URI or just
44 * an empty string. The intention is to assist users during error reporting.
45 *
46 * @return A user-friendly hint about the location of the settings, never {@code null}.
47 */
48 String getLocation();
49
50 }