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.eclipse.aether.spi.connector.transport.http;
20  
21  import java.util.Map;
22  import java.util.function.Function;
23  
24  /**
25   * Checksum extractor strategy, that aims for given type of included checksum.
26   *
27   * @since 2.0.0
28   */
29  public abstract class ChecksumExtractorStrategy {
30      /**
31       * Extract checksums using given getter, if possible, or {@code null}.
32       * <p>
33       * The supplied {@code headerGetter} function should provide access to given transport response HTTP Headers in
34       * some common way, like for example returning first header value, or {@code null} if header not present.
35       *
36       * @param headerGetter A function that provides access to response HTTP Headers, never {@code null}.
37       * @return Map of extracted checksums, or {@code null} if none extracted.
38       */
39      public Map<String, String> extractChecksums(Function<String, String> headerGetter) {
40          return null;
41      }
42  }