Source for javax.crypto.SecretKeyFactorySpi

   1: /* SecretKeyFactorySpi.java -- Secret key factory service provider interface.
   2:    Copyright (C) 2004  Free Software Foundation, Inc.
   3: 
   4: This file is 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, or (at your option)
   9: 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; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 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 javax.crypto;
  40: 
  41: import java.security.InvalidKeyException;
  42: import java.security.spec.InvalidKeySpecException;
  43: import java.security.spec.KeySpec;
  44: 
  45: /**
  46:  * The <i>Service Provider Interface</i> (<b>SPI</b>) for the {@link
  47:  * SecretKeyFactory} class.
  48:  *
  49:  * <p>Providers wishing to implement a secret key factory must
  50:  * subclass this and provide an appropriate implementation for all the
  51:  * abstract methods below, and provide an appropriate entry in the
  52:  * master {@link java.security.Provider} class (the service name for
  53:  * secret key factories is <code>"SecretKeyFactory"</code>).
  54:  *
  55:  * @author Casey Marshall (csm@gnu.org)
  56:  * @since 1.4
  57:  * @see SecretKeyFactory
  58:  */
  59: public abstract class SecretKeyFactorySpi
  60: {
  61: 
  62:   // Constructor.
  63:   // ------------------------------------------------------------------------
  64: 
  65:   /**
  66:    * Create a new secret key factory SPI.
  67:    */
  68:   public SecretKeyFactorySpi()
  69:   {
  70:   }
  71: 
  72:   // Abstract instance methods.
  73:   // ------------------------------------------------------------------------
  74: 
  75:   /**
  76:    * Translate a {@link java.security.KeySpec} into a {@link SecretKey}.
  77:    *
  78:    * @param keySpec The key specification.
  79:    * @return The secret key.
  80:    * @throws java.security.spec.InvalidKeySpecException If the key specification
  81:    *         cannot be translated into a secret key.
  82:    */
  83:   protected abstract SecretKey engineGenerateSecret(KeySpec keySpec)
  84:     throws InvalidKeySpecException;
  85: 
  86:   /**
  87:    * Translate a {@link SecretKey} into a {@link java.security.KeySpec}.
  88:    *
  89:    * @param key     The secret key.
  90:    * @param keySpec The desired key specification class.
  91:    * @return The key specification.
  92:    * @throws java.security.spec.InvalidKeySpecException If the secret key cannot
  93:    *         be translated into the desired key specification.
  94:    */
  95:   protected abstract KeySpec engineGetKeySpec(SecretKey key, Class keySpec)
  96:     throws InvalidKeySpecException;
  97: 
  98:   /**
  99:    * Translate a secret key into a different representation.
 100:    *
 101:    * @param key The secret key to translate.
 102:    * @return The translated key.
 103:    * @throws java.security.InvalidKeyException If the specified secret
 104:    *         key cannot be translated.
 105:    */
 106:   protected abstract SecretKey engineTranslateKey(SecretKey key)
 107:     throws InvalidKeyException;
 108: }