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.transport.http;
20  
21  import java.util.Map;
22  
23  import org.apache.http.HttpResponse;
24  import org.apache.http.client.HttpResponseException;
25  import org.apache.http.client.methods.HttpUriRequest;
26  
27  /**
28   * A component extracting included checksums from response of artifact request.
29   *
30   * @since 1.8.0
31   */
32  public abstract class ChecksumExtractor {
33      /**
34       * Prepares request, if needed.
35       */
36      public void prepareRequest(HttpUriRequest request) {
37          // nothing
38      }
39  
40      /**
41       * May control is request to be retried with checksum extractors disabled.
42       */
43      public boolean retryWithoutExtractor(HttpResponseException exception) {
44          return false; // nothing, usually tied to prepareRequest
45      }
46  
47      /**
48       * Tries to extract checksums from response headers, if present, otherwise returns {@code null}.
49       */
50      public abstract Map<String, String> extractChecksums(HttpResponse response);
51  }