Interface DigestAlgorithmFactory

  • All Implemented Interfaces:

    
    public interface DigestAlgorithmFactory
    
                        

    Interface defining a factory creating a custom digest implementation. The interface should be implemented if a CPK developer wishes to provide support for digest algorithms beyond those supported by the Corda Platform. For each algorithm there must be matching a pair of [DigestAlgorithmFactory] and [DigestAlgorithm] implementations.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract String getAlgorithm() The algorithm name, for example, 'QUAD-SHA-256', the unique name (per Corda Platform and given CPK) of the digest algorithm.
      abstract DigestAlgorithm getInstance() The factory method.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getAlgorithm

        @NotNull() abstract String getAlgorithm()

        The algorithm name, for example, 'QUAD-SHA-256', the unique name (per Corda Platform and given CPK) of the digest algorithm. The name must match the names used by the created [DigestAlgorithm].

      • getInstance

        @NotNull() abstract DigestAlgorithm getInstance()

        The factory method. The method must return a new instance on each call. The method must be thread safe.