Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

gnu.javax.crypto.key

Interface IKeyAgreementParty

Known Implementing Classes:
BaseKeyAgreementParty, DiffieHellmanKeyAgreement, DiffieHellmanReceiver, DiffieHellmanSender, ElGamalKeyAgreement, ElGamalReceiver, ElGamalSender, SRP6Host, SRP6KeyAgreement, SRP6SaslClient, SRP6SaslServer, SRP6TLSClient, SRP6TLSServer, SRP6User
public interface IKeyAgreementParty
The visible methods of an key agreement protocol participating party.

Method Summary

byte[]
getSharedSecret()
Returns the byte array containing the shared secret as generated by this party.
void
init(Map<K,V> attributes)
Sets up the instance to operate with specific attributes.
boolean
isComplete()
Returns true if the party in the key agreement protocol exchange has completed its part of the exchange.
String
name()
Returns the canonical name of the key agreement protocol.
OutgoingMessage
processMessage(IncomingMessage in)
Processes an incoming message at one end, generating a message that will be processed by the other party(ies).
void
reset()
Resets this instance for re-use with another set of attributes.

Method Details

getSharedSecret

public byte[] getSharedSecret()
            throws KeyAgreementException
Returns the byte array containing the shared secret as generated by this party.
Returns:
the generated shared secret.
Throws:
KeyAgreementException - if the key agreement is not yet initialised, or is initialised but the exchange is still in progress.

init

public void init(Map<K,V> attributes)
            throws KeyAgreementException
Sets up the instance to operate with specific attributes.
Parameters:
attributes - a map of name-values used by concrete implementations.
Throws:
KeyAgreementException - if an exception occurs during the setup.

isComplete

public boolean isComplete()
Returns true if the party in the key agreement protocol exchange has completed its part of the exchange. If this is the case an IllegalStateException is thrown for any method invocation except init() or reset().
Returns:
true if this party has completed its part of the key agreement protocol exchange; false otherwise.

name

public String name()
Returns the canonical name of the key agreement protocol.
Returns:
the canonical name of the key agreement protocol.

processMessage

public OutgoingMessage processMessage(IncomingMessage in)
            throws KeyAgreementException
Processes an incoming message at one end, generating a message that will be processed by the other party(ies).
Parameters:
in - the incoming message.
Returns:
an outgoing message, or null if this is an intermediary step that does not cause any output.
Throws:
KeyAgreementException - if an exception occurs during the processing of the incoming message, or during the generation of the outgoing message.

reset

public void reset()
Resets this instance for re-use with another set of attributes.
IKeyAgreementParty.java -- Copyright (C) 2003, 2006 Free Software Foundation, Inc. This file is a part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About