SettingsSource.java

package org.apache.maven.settings.building;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.io.IOException;
import java.io.InputStream;

/**
 * Provides access to the contents of settings independently of the backing store (e.g. file system, database, memory).
 * 
 * @author Benjamin Bentmann
 */
public interface SettingsSource
{

    /**
     * Gets a byte stream to the settings contents. Closing the returned stream is the responsibility of the caller.
     * Note that each invocation of this method returns a new/fresh stream which represents the entire contents.
     * 
     * @return A byte stream to the settings contents, never {@code null}.
     */
    InputStream getInputStream()
        throws IOException;

    /**
     * Provides a user-friendly hint about the location of the settings. This could be a local file path, a URI or just
     * an empty string. The intention is to assist users during error reporting.
     * 
     * @return A user-friendly hint about the location of the settings, never {@code null}.
     */
    String getLocation();

}