Source code

001package org.apache.archiva.repository;
002/*
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 */
020
021/**
022 *
023 * Maps request paths to native repository paths. Normally HTTP requests and the path in the repository
024 * storage should be identically.
025 *
026 * @author Martin Stockhammer <martin_s@apache.org>
027 */
028public interface RequestPathMapper
029{
030    /**
031     * Maps a request path to a repository path. The request path should be relative
032     * to the repository. The resulting path should always start with a '/'.
033     * The returned object contains additional information, if this request
034     *
035     * @param requestPath
036     * @return
037     */
038    RelocatablePath relocatableRequestToRepository(String requestPath);
039
040
041    String requestToRepository(String requestPath);
042
043
044    /**
045     * Maps a repository path to a request path. The repository path is relative to the
046     * repository. The resulting path should always start with a '/'.
047     *
048     * @param repositoryPath
049     * @return
050     */
051    String repositoryToRequest(String repositoryPath);
052
053}