Package org.eclipse.aether.spi.connector.checksum

Interface ChecksumAlgorithmFactory

All Known Implementing Classes:
ChecksumAlgorithmFactorySupport, Md5ChecksumAlgorithmFactory, MessageDigestChecksumAlgorithmFactorySupport, Sha1ChecksumAlgorithmFactory, Sha256ChecksumAlgorithmFactory, Sha512ChecksumAlgorithmFactory
public interface ChecksumAlgorithmFactory
A component representing a checksum factory: provides ChecksumAlgorithm instances, name and extension to be used with this algorithm. While directly injecting components of this type is possible, it is not recommended. To obtain factory instances use ChecksumAlgorithmFactorySelector instead.
Since:
1.8.0

  • Method Summary

    Modifier and Type
    Method
    Description
    ChecksumAlgorithm
    getAlgorithm()
    Each invocation of this method returns a new instance of algorithm, never null value.
    String
    getFileExtension()
    Returns the file extension to be used for given checksum file (without leading dot), never null.
    String
    getName()
    Returns the algorithm name, usually used as key, never null value.

  • Method Details

    • getName

      String getName()
      Returns the algorithm name, usually used as key, never null value. The name is a standard name of algorithm (if applicable) or any other designator that is algorithm commonly referred with. Example: "SHA-1".

    • getFileExtension

      String getFileExtension()
      Returns the file extension to be used for given checksum file (without leading dot), never null. The extension should be file and URL path friendly, and may differ from value returned by getName(). The checksum extension SHOULD NOT contain dot (".") character. Example: "sha1".

    • getAlgorithm

      ChecksumAlgorithm getAlgorithm()
      Each invocation of this method returns a new instance of algorithm, never null value.