hcrypto.provider
Class Provider

java.lang.Object
  hcrypto.provider.Provider

Direct Known Subclasses:

DefaultProvider, RamProvider, RamProvider

public class Provider
extends java.lang.Object

This class represents a provider for the Historical Cipher API. A provider keeps a list of available cipher algorithms and their keys. Each provider has a name. The default provider, DefaultProvider, is a subclass of this class that implements a number of example algorithms. To use the DefaultProvider in an application, use the following code:

   public static void main (String args[]) throws Exception {
       Provider.addProvider(new DefaultProvider("Default"));
       Provider.addProvider(new MyProvider("Myname"));
       ...
   }
 

In this case both the default provider and a user-defined provider are added to the list of providers that can be searched for implementations of cipher algorithms.

See also:

DefaultProvider

To implement and use your own version of an algorithm, take the following steps:

• Implement a subclass of HistoricalKey
• Implement a subclass of BlockCipher
• Implement a subclass of Provider that places the name of your algorithm, the name of your BlockCipher subclass, and the name of your HistoricalKey subclass in the provider list.
• Place a call to Provider.add(Provider p) in main() giving the name of your provider class as a reference.
• Create an instance of Cipher passing it the name of your algorithm and your provider.
• Create an instance of your HistoricalKey passing it the name of your algorithm and your provider.

  Field Summary

  static java.lang.String

  DELIMITER The delimiter used to return a list of algorithm names.

  Constructor Summary

  Provider()
  default constructor.

  Provider(java.lang.String s)
  

  Method Summary

  static void	addCipher(java.lang.String cipher, java.lang.String provider, java.lang.String spiName)
  static void	addCipher(java.lang.String cipher, java.lang.String provider, java.lang.String spiName, java.lang.String keyName)
  static void	addProvider(Provider p) Adds the designated provider to the list of available providers.
  java.lang.String	getCipherEngine(java.lang.String algorithm) Searches the main provider's internal lists for an instance of a provider that implements the desired algorithm.
  java.lang.String	getCipherEngine(java.lang.String algorithm, java.lang.String provider) Searches the main provider's internal lists for an instance of the provider named in the second parameter that implements the desired algorithm.
  java.lang.String	getCipherKeyName(java.lang.String algorithm) Searches the main provider's internal lists for an instance of a provider that implements the desired key.
  java.lang.String	getCipherKeyName(java.lang.String algorithm, java.lang.String provider) Searches the main provider's internal lists for an instance of the provider named in the second parameter that implements the desired algorithm.
  static java.lang.String	getCipherNames() Returns a comma-delimited string of the names of the cipher algorithms.
  java.lang.String	getName() Returns the name of this provider object.
  void	put(java.lang.String cipherName, java.lang.String engineClass, java.lang.String keyClass) Inserts the names of the engineClass and keyClass into the appropriate tables thereby associating them with the named cipher.

  Methods inherited from class java.lang.Object

  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Field Detail

  DELIMITER

  public static final java.lang.String DELIMITER

  The delimiter used to return a list of algorithm names.

  See Also:

  Constant Field Values

  Constructor Detail

  Provider

  public Provider()

  default constructor.

  Provider

  public Provider(java.lang.String s)

  Method Detail

  getName

  public java.lang.String getName()

  Returns the name of this provider object.

  put

  public void put(java.lang.String cipherName,
                  java.lang.String engineClass,
                  java.lang.String keyClass)

  Inserts the names of the engineClass and keyClass into the appropriate tables thereby associating them with the named cipher.

  Parameters:

  cipherName - a String giving the name of the cipher.

  engineClass - a String giving the name of the associated engine.

  keyClass - a String giving the name of the associated key.

  getCipherEngine

  public java.lang.String getCipherEngine(java.lang.String algorithm)
                                   throws java.lang.Exception

  Searches the main provider's internal lists for an instance of a provider that implements the desired algorithm.

  Parameters:

  algorithm - a String giving the name of the desired algorithm.

  Throws:

  java.lang.Exception

  getCipherKeyName

  public java.lang.String getCipherKeyName(java.lang.String algorithm)
                                    throws java.lang.Exception

  Searches the main provider's internal lists for an instance of a provider that implements the desired key.

  Parameters:

  algorithm - a String giving the name of the desired algorithm.

  Throws:

  java.lang.Exception

  getCipherEngine

  public java.lang.String getCipherEngine(java.lang.String algorithm,
                                          java.lang.String provider)
                                   throws java.lang.Exception

  Searches the main provider's internal lists for an instance of the provider named in the second parameter that implements the desired algorithm.

  Parameters:

  algorithm - a String giving the name of the desired algorithm.

  provider - a String giving the name of the desired provider.

  Throws:

  java.lang.Exception

  getCipherKeyName

  public java.lang.String getCipherKeyName(java.lang.String algorithm,
                                           java.lang.String provider)
                                    throws java.lang.Exception

  Searches the main provider's internal lists for an instance of the provider named in the second parameter that implements the desired algorithm.

  Parameters:

  algorithm - a String giving the name of the desired algorithm.

  provider - a String giving the name of the desired provider.

  Throws:

  java.lang.Exception

  addProvider

  public static void addProvider(Provider p)

  Adds the designated provider to the list of available providers.

  Parameters:

  p - a reference to the provider object.

  addCipher

  public static void addCipher(java.lang.String cipher,
                               java.lang.String provider,
                               java.lang.String spiName)

  addCipher

  public static void addCipher(java.lang.String cipher,
                               java.lang.String provider,
                               java.lang.String spiName,
                               java.lang.String keyName)

  getCipherNames

  public static java.lang.String getCipherNames()

  Returns a comma-delimited string of the names of the cipher algorithms. The names are returned in the format "Algorithm(Provider)". For example "Caesar(Default)"

  Parameters:

  p - a reference to the provider object.