Mercurial Mercurial > jdk-sandbox / diff
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
jdk/src/share/classes/javax/security/sasl/SaslClient.java
changeset 18830 90956ead732f
parent 18156 edb590d448c5
child 21278 ef8a3a2a72f2 
--- a/jdk/src/share/classes/javax/security/sasl/SaslClient.java	Mon Jul 15 14:37:01 2013 -0700
+++ b/jdk/src/share/classes/javax/security/sasl/SaslClient.java	Tue Jul 16 12:19:41 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -30,14 +30,14 @@
  *<p>
  * A protocol library such as one for LDAP gets an instance of this
  * class in order to perform authentication defined by a specific SASL
- * mechanism. Invoking methods on the <tt>SaslClient</tt> instance
+ * mechanism. Invoking methods on the {@code SaslClient} instance
  * process challenges and create responses according to the SASL
- * mechanism implemented by the <tt>SaslClient</tt>.
+ * mechanism implemented by the {@code SaslClient}.
  * As the authentication proceeds, the instance
  * encapsulates the state of a SASL client's authentication exchange.
  *<p>
- * Here's an example of how an LDAP library might use a <tt>SaslClient</tt>.
- * It first gets an instance of a <tt>SaslClient</tt>:
+ * Here's an example of how an LDAP library might use a {@code SaslClient}.
+ * It first gets an instance of a {@code SaslClient}:
  *<blockquote><pre>{@code
  * SaslClient sc = Sasl.createSaslClient(mechanisms,
  *     authorizationId, protocol, serverName, props, callbackHandler);
@@ -77,16 +77,16 @@
  *}</pre></blockquote>
  *
  * If the mechanism has an initial response, the library invokes
- * <tt>evaluateChallenge()</tt> with an empty
+ * {@code evaluateChallenge()} with an empty
  * challenge and to get initial response.
  * Protocols such as IMAP4, which do not include an initial response with
  * their first authentication command to the server, initiates the
- * authentication without first calling <tt>hasInitialResponse()</tt>
- * or <tt>evaluateChallenge()</tt>.
+ * authentication without first calling {@code hasInitialResponse()}
+ * or {@code evaluateChallenge()}.
  * When the server responds to the command, it sends an initial challenge.
  * For a SASL mechanism in which the client sends data first, the server should
  * have issued a challenge with no data. This will then result in a call
- * (on the client) to <tt>evaluateChallenge()</tt> with an empty challenge.
+ * (on the client) to {@code evaluateChallenge()} with an empty challenge.
  *
  * @since 1.5
  *
@@ -107,7 +107,7 @@
 
     /**
      * Determines whether this mechanism has an optional initial response.
-     * If true, caller should call <tt>evaluateChallenge()</tt> with an
+     * If true, caller should call {@code evaluateChallenge()} with an
      * empty array to get the initial response.
      *
      * @return true if this mechanism has an initial response.
@@ -148,22 +148,22 @@
     /**
      * Unwraps a byte array received from the server.
      * This method can be called only after the authentication exchange has
-     * completed (i.e., when <tt>isComplete()</tt> returns true) and only if
+     * completed (i.e., when {@code isComplete()} returns true) and only if
      * the authentication exchange has negotiated integrity and/or privacy
      * as the quality of protection; otherwise, an
-     * <tt>IllegalStateException</tt> is thrown.
+     * {@code IllegalStateException} is thrown.
      *<p>
-     * <tt>incoming</tt> is the contents of the SASL buffer as defined in RFC 2222
+     * {@code incoming} is the contents of the SASL buffer as defined in RFC 2222
      * without the leading four octet field that represents the length.
-     * <tt>offset</tt> and <tt>len</tt> specify the portion of <tt>incoming</tt>
+     * {@code offset} and {@code len} specify the portion of {@code incoming}
      * to use.
      *
      * @param incoming A non-null byte array containing the encoded bytes
      *                from the server.
-     * @param offset The starting position at <tt>incoming</tt> of the bytes to use.
-     * @param len The number of bytes from <tt>incoming</tt> to use.
+     * @param offset The starting position at {@code incoming} of the bytes to use.
+     * @param len The number of bytes from {@code incoming} to use.
      * @return A non-null byte array containing the decoded bytes.
-     * @exception SaslException if <tt>incoming</tt> cannot be successfully
+     * @exception SaslException if {@code incoming} cannot be successfully
      * unwrapped.
      * @exception IllegalStateException if the authentication exchange has
      * not completed, or  if the negotiated quality of protection
@@ -175,22 +175,22 @@
     /**
      * Wraps a byte array to be sent to the server.
      * This method can be called only after the authentication exchange has
-     * completed (i.e., when <tt>isComplete()</tt> returns true) and only if
+     * completed (i.e., when {@code isComplete()} returns true) and only if
      * the authentication exchange has negotiated integrity and/or privacy
      * as the quality of protection; otherwise, an
-     * <tt>IllegalStateException</tt> is thrown.
+     * {@code IllegalStateException} is thrown.
      *<p>
      * The result of this method will make up the contents of the SASL buffer
      * as defined in RFC 2222 without the leading four octet field that
      * represents the length.
-     * <tt>offset</tt> and <tt>len</tt> specify the portion of <tt>outgoing</tt>
+     * {@code offset} and {@code len} specify the portion of {@code outgoing}
      * to use.
      *
      * @param outgoing A non-null byte array containing the bytes to encode.
-     * @param offset The starting position at <tt>outgoing</tt> of the bytes to use.
-     * @param len The number of bytes from <tt>outgoing</tt> to use.
+     * @param offset The starting position at {@code outgoing} of the bytes to use.
+     * @param len The number of bytes from {@code outgoing} to use.
      * @return A non-null byte array containing the encoded bytes.
-     * @exception SaslException if <tt>outgoing</tt> cannot be successfully
+     * @exception SaslException if {@code outgoing} cannot be successfully
      * wrapped.
      * @exception IllegalStateException if the authentication exchange has
      * not completed, or if the negotiated quality of protection
@@ -202,8 +202,8 @@
     /**
      * Retrieves the negotiated property.
      * This method can be called only after the authentication exchange has
-     * completed (i.e., when <tt>isComplete()</tt> returns true); otherwise, an
-     * <tt>IllegalStateException</tt> is thrown.
+     * completed (i.e., when {@code isComplete()} returns true); otherwise, an
+     * {@code IllegalStateException} is thrown.
      *
      * @param propName The non-null property name.
      * @return The value of the negotiated property. If null, the property was
jdk-sandbox