Source code

001package org.apache.archiva.repository;
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 org.apache.archiva.model.ArtifactReference;
023import org.apache.archiva.model.VersionedReference;
024
025
026/**
027 * Common aspects of content provider interfaces
028 */
029public interface RepositoryContent
030{
031
032
033    /**
034     * Given a repository relative path to a filename, return the {@link VersionedReference} object suitable for the path.
035     *
036     * @param path the path relative to the repository base dir for the artifact.
037     * @return the {@link ArtifactReference} representing the path.  (or null if path cannot be converted to
038     *         a {@link ArtifactReference})
039     * @throws LayoutException if there was a problem converting the path to an artifact.
040     */
041    ArtifactReference toArtifactReference( String path )
042        throws LayoutException;
043
044    /**
045     * Given an {@link ArtifactReference}, return the relative path to the artifact.
046     *
047     * @param reference the artifact reference to use.
048     * @return the relative path to the artifact.
049     */
050    String toPath( ArtifactReference reference );
051}