Source for gnu.javax.crypto.key.IKeyAgreementParty

   1: /* IKeyAgreementParty.java --
   2:    Copyright (C) 2003, 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.javax.crypto.key;
  40: 
  41: import java.util.Map;
  42: 
  43: /**
  44:  * The visible methods of an key agreement protocol participating party.
  45:  */
  46: public interface IKeyAgreementParty
  47: {
  48:   /**
  49:    * Returns the canonical name of the key agreement protocol.
  50:    *
  51:    * @return the canonical name of the key agreement protocol.
  52:    */
  53:   String name();
  54: 
  55:   /**
  56:    * Sets up the instance to operate with specific attributes.
  57:    *
  58:    * @param attributes a map of name-values used by concrete implementations.
  59:    * @throws KeyAgreementException if an exception occurs during the setup.
  60:    */
  61:   void init(Map attributes) throws KeyAgreementException;
  62: 
  63:   /**
  64:    * Processes an incoming message at one end, generating a message that will be
  65:    * processed by the other party(ies).
  66:    *
  67:    * @param in the incoming message.
  68:    * @return an outgoing message, or <code>null</code> if this is an
  69:    *         intermediary step that does not cause any output.
  70:    * @throws KeyAgreementException if an exception occurs during the processing
  71:    *           of the incoming message, or during the generation of the outgoing
  72:    *           message.
  73:    */
  74:   OutgoingMessage processMessage(IncomingMessage in)
  75:       throws KeyAgreementException;
  76: 
  77:   /**
  78:    * Returns <code>true</code> if the party in the key agreement protocol
  79:    * exchange has completed its part of the exchange. If this is the case an
  80:    * {@link IllegalStateException} is thrown for any method invocation except
  81:    * <code>init()</code> or <code>reset()</code>.
  82:    *
  83:    * @return <code>true</code> if this party has completed its part of the key
  84:    *         agreement protocol exchange; <code>false</code> otherwise.
  85:    */
  86:   boolean isComplete();
  87: 
  88:   /**
  89:    * Returns the byte array containing the shared secret as generated by this
  90:    * party.
  91:    *
  92:    * @return the generated shared secret.
  93:    * @throws KeyAgreementException if the key agreement is not yet initialised,
  94:    *           or is initialised but the exchange is still in progress.
  95:    */
  96:   byte[] getSharedSecret() throws KeyAgreementException;
  97: 
  98:   /** Resets this instance for re-use with another set of attributes. */
  99:   void reset();
 100: }