This project has retired. For details please refer to its Attic page.
RepositoryContent xref
View Javadoc
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  
25  
26  /**
27   * Common aspects of content provider interfaces
28   */
29  public interface RepositoryContent
30  {
31  
32  
33      /**
34       * Given a repository relative path to a filename, return the {@link VersionedReference} object suitable for the path.
35       *
36       * @param path the path relative to the repository base dir for the artifact.
37       * @return the {@link ArtifactReference} representing the path.  (or null if path cannot be converted to
38       *         a {@link ArtifactReference})
39       * @throws LayoutException if there was a problem converting the path to an artifact.
40       */
41      ArtifactReference toArtifactReference( String path )
42          throws LayoutException;
43  
44      /**
45       * Given an {@link ArtifactReference}, return the relative path to the artifact.
46       *
47       * @param reference the artifact reference to use.
48       * @return the relative path to the artifact.
49       */
50      String toPath( ArtifactReference reference );
51  }