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 /**
23 * A component representing a checksum factory: provides {@link ChecksumAlgorithm} instances, name and extension to be
24 * used with this algorithm. While directly injecting components of this type is possible, it is not recommended. To
25 * obtain factory instances use {@link ChecksumAlgorithmFactorySelector} instead.
26 *
27 * @since 1.8.0
28 */
29 public interface ChecksumAlgorithmFactory
30 {
31 /**
32 * Returns the algorithm name, usually used as key, never {@code null} value. The name is a standard name of
33 * algorithm (if applicable) or any other designator that is algorithm commonly referred with. Example: "SHA-1".
34 */
35 String getName();
36
37 /**
38 * Returns the file extension to be used for given checksum file (without leading dot), never {@code null}. The
39 * extension should be file and URL path friendly, and may differ from value returned by {@link #getName()}.
40 * Example: "sha1".
41 */
42 String getFileExtension();
43
44 /**
45 * Each invocation of this method returns a new instance of algorithm, never {@code null} value.
46 */
47 ChecksumAlgorithm getAlgorithm();
48 }