001    package org.apache.maven.model.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    
022    import java.io.IOException;
023    import java.io.InputStream;
024    
025    /**
026     * Provides access to the contents of a POM independently of the backing store (e.g. file system, database, memory).
027     * <p>
028     * This interface does not support loading of parent POM(s) from the same backing store, integrators are strongly
029     * encouraged to implement {@link ModelSource2} instead of implementing this interface directly.
030     * 
031     * @author Benjamin Bentmann
032     * @see ModelSource2
033     */
034    public interface ModelSource
035    {
036    
037        /**
038         * Gets a byte stream to the POM contents. Closing the returned stream is the responsibility of the caller.
039         * 
040         * @return A byte stream to the POM contents, never {@code null}.
041         */
042        InputStream getInputStream()
043            throws IOException;
044    
045        /**
046         * Provides a user-friendly hint about the location of the POM. This could be a local file path, a URI or just an
047         * empty string. The intention is to assist users during error reporting.
048         * 
049         * @return A user-friendly hint about the location of the POM, never {@code null}.
050         */
051        String getLocation();
052    
053    }