This project has retired. For details please refer to its Attic page.
RequestPathMapper xref
View Javadoc
1   package org.apache.archiva.repository;
2   /*
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   */
20  
21  /**
22   *
23   * Maps request paths to native repository paths. Normally HTTP requests and the path in the repository
24   * storage should be identically.
25   *
26   * @author Martin Stockhammer <martin_s@apache.org>
27   */
28  public interface RequestPathMapper
29  {
30      /**
31       * Maps a request path to a repository path. The request path should be relative
32       * to the repository. The resulting path should always start with a '/'.
33       * The returned object contains additional information, if this request
34       *
35       * @param requestPath
36       * @return
37       */
38      RelocatablePath relocatableRequestToRepository(String requestPath);
39  
40  
41      String requestToRepository(String requestPath);
42  
43  
44      /**
45       * Maps a repository path to a request path. The repository path is relative to the
46       * repository. The resulting path should always start with a '/'.
47       *
48       * @param repositoryPath
49       * @return
50       */
51      String repositoryToRequest(String repositoryPath);
52  
53  }