1 package org.eclipse.aether.spi.connector.checksum; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 import org.eclipse.aether.RepositorySystemSession; 23 import org.eclipse.aether.repository.RemoteRepository; 24 import org.eclipse.aether.transfer.TransferResource; 25 26 /** 27 * Assists repository connectors in applying checksum policies to downloaded resources. 28 * 29 * @noimplement This interface is not intended to be implemented by clients. 30 * @noextend This interface is not intended to be extended by clients. 31 */ 32 public interface ChecksumPolicyProvider 33 { 34 35 /** 36 * Retrieves the checksum policy with the specified identifier for use on the given remote resource. 37 * 38 * @param session The repository system session during which the request is made, must not be {@code null}. 39 * @param repository The repository hosting the resource being transferred, must not be {@code null}. 40 * @param resource The transfer resource on which the policy will be applied, must not be {@code null}. 41 * @param policy The identifier of the policy to apply, must not be {@code null}. 42 * @return The policy to apply or {@code null} if checksums should be ignored. 43 */ 44 ChecksumPolicy newChecksumPolicy( RepositorySystemSession session, RemoteRepository repository, 45 TransferResource resource, String policy ); 46 47 /** 48 * Returns the least strict policy. A checksum policy is said to be less strict than another policy if it would 49 * accept a downloaded resource in all cases where the other policy would reject the resource. 50 * 51 * @param session The repository system session during which the request is made, must not be {@code null}. 52 * @param policy1 A policy to compare, must not be {@code null}. 53 * @param policy2 A policy to compare, must not be {@code null}. 54 * @return The least strict policy among the two input policies. 55 */ 56 String getEffectiveChecksumPolicy( RepositorySystemSession session, String policy1, String policy2 ); 57 58 }