Interface Algorithm

All Known Subinterfaces:
AlgorithmIdentifierAware, BlockEncryptionAlgorithm, EncryptionAlgorithm, JoseAlgorithm, KeyBasedAlgorithm, KeyTransportAlgorithm, MacAlgorithm, MessageDigestAlgorithm, RSAPSSSignatureAlgorithm, SignatureAlgorithm
All Known Implementing Classes:
AbstractAlgorithm, AbstractEncryptionAlgorithm, AbstractJoseAlgorithm, AbstractKeyBasedAlgorithm, BlockEncryptionAlgorithmImpl, KeyTransportAlgorithmImpl, MacAlgorithmImpl, MessageDigestAlgorithmImpl, NoParamsRSAPSSSignatureAlgorithm, RSAPSSSignatureAlgorithmImpl, SignatureAlgorithmImpl, SymmetricKeyWrapImpl

public interface Algorithm
Representation of an algorithm.
Author:
Martin Lindström (martin@idsec.se), Stefan Santesson (stefan@idsec.se)
  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the JCA (Java Cryptography Architecture) name.
    int
    Gets the order for an algorithm where a lower order is seen as more preferable than an algorithm with a higher ordering.
    Gets the algorithm type.
    Gets the URI representation of the algorithm.
    boolean
    Tells whether this algorithm is black-listed, i.e., configured to not be allowed.
  • Method Details

    • getUri

      String getUri()
      Gets the URI representation of the algorithm.
      Returns:
      the URI
    • getType

      AlgorithmType getType()
      Gets the algorithm type.
      Returns:
      the type
    • getJcaName

      String getJcaName()
      Gets the JCA (Java Cryptography Architecture) name.
      Returns:
      the JCA name
    • getOrder

      int getOrder()
      Gets the order for an algorithm where a lower order is seen as more preferable than an algorithm with a higher ordering. The ordering is relative to algorithms of the same type, and also other critera such as key or key length material.
      Returns:
      a positive integer
    • isBlacklisted

      boolean isBlacklisted()
      Tells whether this algorithm is black-listed, i.e., configured to not be allowed.
      Returns:
      true if the algorithm is black-listed and false otherwise