diff options
Diffstat (limited to 'gnu/javax/crypto/key/IKeyAgreementParty.java')
-rw-r--r-- | gnu/javax/crypto/key/IKeyAgreementParty.java | 43 |
1 files changed, 19 insertions, 24 deletions
diff --git a/gnu/javax/crypto/key/IKeyAgreementParty.java b/gnu/javax/crypto/key/IKeyAgreementParty.java index 05aef5e51..280f3f33d 100644 --- a/gnu/javax/crypto/key/IKeyAgreementParty.java +++ b/gnu/javax/crypto/key/IKeyAgreementParty.java @@ -41,65 +41,60 @@ package gnu.javax.crypto.key; import java.util.Map; /** - * <p>The visible methods of an key agreement protocol participating party.</p> + * The visible methods of an key agreement protocol participating party. */ public interface IKeyAgreementParty { - - // Constants - // ------------------------------------------------------------------------- - - // Methods - // ------------------------------------------------------------------------- - /** - * <p>Returns the canonical name of the key agreement protocol.</p> - * + * Returns the canonical name of the key agreement protocol. + * * @return the canonical name of the key agreement protocol. */ String name(); /** - * <p>Sets up the instance to operate with specific attributes.</p> - * + * Sets up the instance to operate with specific attributes. + * * @param attributes a map of name-values used by concrete implementations. * @throws KeyAgreementException if an exception occurs during the setup. */ void init(Map attributes) throws KeyAgreementException; /** - * <p>Processes an incoming message at one end, generating a message that - * will be processed by the other party(ies).</p> - * + * Processes an incoming message at one end, generating a message that will be + * processed by the other party(ies). + * * @param in the incoming message. * @return an outgoing message, or <code>null</code> if this is an - * intermediary step that does not cause any output. + * 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. + * of the incoming message, or during the generation of the outgoing + * message. */ OutgoingMessage processMessage(IncomingMessage in) throws KeyAgreementException; /** - * <p>Returns <code>true</code> if the party in the key agreement protocol + * Returns <code>true</code> if the party in the key agreement protocol * exchange has completed its part of the exchange. If this is the case an * {@link IllegalStateException} is thrown for any method invocation except * <code>init()</code> or <code>reset()</code>. + * * @return <code>true</code> if this party has completed its part of the key - * agreement protocol exchange; <code>false</code> otherwise. + * agreement protocol exchange; <code>false</code> otherwise. */ boolean isComplete(); /** - * <p>Returns the byte array containing the shared secret as generated by - * this party.</p> - * + * Returns the byte array containing the shared secret as generated by this + * party. + * * @return the generated shared secret. * @throws KeyAgreementException if the key agreement is not yet initialised, - * or is initialised but the exchange is still in progress. + * or is initialised but the exchange is still in progress. */ byte[] getSharedSecret() throws KeyAgreementException; /** Resets this instance for re-use with another set of attributes. */ void reset(); -}
\ No newline at end of file +} |