001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.spi.connector.checksum;
020
021/**
022 * A component representing a checksum factory: provides {@link ChecksumAlgorithm} instances, name and extension to be
023 * used with this algorithm. While directly injecting components of this type is possible, it is not recommended. To
024 * obtain factory instances use {@link ChecksumAlgorithmFactorySelector} instead.
025 *
026 * @since 1.8.0
027 */
028public interface ChecksumAlgorithmFactory {
029    /**
030     * Returns the algorithm name, usually used as key, never {@code null} value. The name is a standard name of
031     * algorithm (if applicable) or any other designator that is algorithm commonly referred with. Example: "SHA-1".
032     */
033    String getName();
034
035    /**
036     * Returns the file extension to be used for given checksum file (without leading dot), never {@code null}. The
037     * extension should be file and URL path friendly, and may differ from value returned by {@link #getName()}.
038     * The checksum extension SHOULD NOT contain dot (".") character.
039     * Example: "sha1".
040     */
041    String getFileExtension();
042
043    /**
044     * Each invocation of this method returns a new instance of algorithm, never {@code null} value.
045     */
046    ChecksumAlgorithm getAlgorithm();
047}