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