source.dussan.org Git - archiva.git/blob

   1 package org.apache.archiva.repository;
   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 org.apache.archiva.model.ArtifactReference;
  23 import org.apache.archiva.model.VersionedReference;
  24 import org.apache.archiva.repository.content.ItemSelector;
  25
  26
  27 /**
  28  * Common aspects of content provider interfaces
  29  */
  30 public interface RepositoryContent
  31 {
  32
  33
  34     /**
  35      * Given a repository relative path to a filename, return the {@link VersionedReference} object suitable for the path.
  36      *
  37      * @param path the path relative to the repository base dir for the artifact.
  38      * @return the {@link ArtifactReference} representing the path.  (or null if path cannot be converted to
  39      *         a {@link ArtifactReference})
  40      * @throws LayoutException if there was a problem converting the path to an artifact.
  41      */
  42     ArtifactReference toArtifactReference( String path )
  43         throws LayoutException;
  44
  45     /**
  46      * Given an {@link ArtifactReference}, return the relative path to the artifact.
  47      *
  48      * @param reference the artifact reference to use.
  49      * @return the relative path to the artifact.
  50      */
  51     String toPath( ArtifactReference reference );
  52
  53
  54     /**
  55      * Return the path, that represents the item specified by the selector.
  56      * @param selector the selector with the artifact coordinates
  57      * @return the path to the content item
  58      */
  59     String toPath( ItemSelector selector );
  60
  61     /**
  62      * Return a item selector that matches the given path. This is kind of reverse method for the {@link #toPath(ItemSelector)}
  63      * method and fills the selector with the known information. It may not make sense for every path, and the following
  64      * must <b>not always be true</b>:
  65      * <pre>
  66      *  selector.equals(r.toItemSelector(r.toPath(selector)))
  67      * </pre>
  68      *
  69      * The methods on the ManagedRepository give more reliable results.
  70      *
  71      * @param path the repository path
  72      * @return a item selector that would select the given path
  73      */
  74     ItemSelector toItemSelector(String path) throws LayoutException;
  75
  76
  77 }