Source for gnu.java.security.key.IKeyPairGenerator

   1: /* IKeyPairGenerator.java --
   2:    Copyright 2001, 2002, 2006 Free Software Foundation, Inc.
   3: 
   4: This file is a part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2 of the License, or (at
   9: your option) any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; if not, write to the Free Software
  18: Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  19: USA
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version.  */
  37: 
  38: 
  39: package gnu.java.security.key;
  40: 
  41: import java.security.KeyPair;
  42: import java.util.Map;
  43: 
  44: /**
  45:  * The visible methods of every asymmetric keypair generator.
  46:  */
  47: public interface IKeyPairGenerator
  48: {
  49:   /**
  50:    * Returns the canonical name of this keypair generator.
  51:    *
  52:    * @return the canonical name of this instance.
  53:    */
  54:   String name();
  55: 
  56:   /**
  57:    * [Re]-initialises this instance for use with a given set of attributes.
  58:    *
  59:    * @param attributes a map of name/value pairs to use for setting up the
  60:    *          instance.
  61:    * @exception IllegalArgumentException if at least one of the mandatory
  62:    *              attributes is missing or an invalid value was specified.
  63:    */
  64:   void setup(Map attributes);
  65: 
  66:   /**
  67:    * Generates a new keypair based on the attributes used to configure the
  68:    * instance.
  69:    *
  70:    * @return a new keypair.
  71:    */
  72:   KeyPair generate();
  73: }