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.checksum;
20
21 import org.eclipse.aether.RepositorySystemSession;
22 import org.eclipse.aether.repository.RemoteRepository;
23 import org.eclipse.aether.transfer.TransferResource;
24
25 /**
26 * Assists repository connectors in applying checksum policies to downloaded resources.
27 *
28 * @noimplement This interface is not intended to be implemented by clients.
29 * @noextend This interface is not intended to be extended by clients.
30 */
31 public interface ChecksumPolicyProvider {
32
33 /**
34 * Retrieves the checksum policy with the specified identifier for use on the given remote resource.
35 *
36 * @param session The repository system session during which the request is made, must not be {@code null}.
37 * @param repository The repository hosting the resource being transferred, must not be {@code null}.
38 * @param resource The transfer resource on which the policy will be applied, must not be {@code null}.
39 * @param policy The identifier of the policy to apply, must not be {@code null}.
40 * @return The policy to apply or {@code null} if checksums should be ignored.
41 */
42 ChecksumPolicy newChecksumPolicy(
43 RepositorySystemSession session, RemoteRepository repository, TransferResource resource, String policy);
44
45 /**
46 * Returns the least strict policy. A checksum policy is said to be less strict than another policy if it would
47 * accept a downloaded resource in all cases where the other policy would reject the resource.
48 *
49 * @param session The repository system session during which the request is made, must not be {@code null}.
50 * @param policy1 A policy to compare, must not be {@code null}.
51 * @param policy2 A policy to compare, must not be {@code null}.
52 * @return The least strict policy among the two input policies.
53 */
54 String getEffectiveChecksumPolicy(RepositorySystemSession session, String policy1, String policy2);
55 }