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