View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.model.path;
20  
21  /**
22   * Simplifies URLs by removing parent directory references ("/../") and collapsing path segments.
23   * This performs purely string-based normalization without full URL parsing or validation.
24   *
25   * <p>The normalization process iteratively removes "/../" segments by eliminating the preceding path segment,
26   * effectively resolving relative path traversals.
27   *
28   * <p>This does not guarantee that the resulting URL is valid or reachable; it simply
29   * produces a more canonical representation of the input string.
30   *
31   * @author Benjamin Bentmann
32   */
33  public interface UrlNormalizer {
34  
35      /**
36       * Normalizes the specified URL.
37       *
38       * @param url The URL to normalize, may be {@code null}.
39       * @return The normalized URL or {@code null} if the input was {@code null}.
40       */
41      String normalize(String url);
42  }