jdk/src/share/classes/javax/security/sasl/Sasl.java
changeset 14340 e150cbaf584e
parent 10709 d865c9f21240
child 14342 8435a30053c1
equal deleted inserted replaced
14339:3b561cef789b 14340:e150cbaf584e
   117      */
   117      */
   118     public static final String SERVER_AUTH =
   118     public static final String SERVER_AUTH =
   119     "javax.security.sasl.server.authentication";
   119     "javax.security.sasl.server.authentication";
   120 
   120 
   121     /**
   121     /**
       
   122      * The name of a property that specifies the bound server name for
       
   123      * an unbound server. A server is created as an unbound server by setting
       
   124      * the {@code serverName} argument in {@link #createSaslServer} as null.
       
   125      * The property contains the bound host name after the authentication
       
   126      * exchange has completed. It is only available on the server side.
       
   127      * <br>The value of this constant is
       
   128      * <tt>"javax.security.sasl.bound.server.name"</tt>.
       
   129      */
       
   130     public static final String BOUND_SERVER_NAME =
       
   131     "javax.security.sasl.bound.server.name";
       
   132 
       
   133     /**
   122      * The name of a property that specifies the maximum size of the receive
   134      * The name of a property that specifies the maximum size of the receive
   123      * buffer in bytes of <tt>SaslClient</tt>/<tt>SaslServer</tt>.
   135      * buffer in bytes of <tt>SaslClient</tt>/<tt>SaslServer</tt>.
   124      * The property contains the string representation of an integer.
   136      * The property contains the string representation of an integer.
   125      * <br>If this property is absent, the default size
   137      * <br>If this property is absent, the default size
   126      * is defined by the mechanism.
   138      * is defined by the mechanism.
   447      *
   459      *
   448      * @param mechanism The non-null mechanism name. It must be an
   460      * @param mechanism The non-null mechanism name. It must be an
   449      * IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5").
   461      * IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5").
   450      * @param protocol The non-null string name of the protocol for which
   462      * @param protocol The non-null string name of the protocol for which
   451      * the authentication is being performed (e.g., "ldap").
   463      * the authentication is being performed (e.g., "ldap").
   452      * @param serverName The non-null fully qualified host name of the server.
   464      * @param serverName The fully qualified host name of the server, or null
       
   465      * if the server is not bound to any specific host name. If the mechanism
       
   466      * does not allow an unbound server, a <code>SaslException</code> will
       
   467      * be thrown.
   453      * @param props The possibly null set of properties used to
   468      * @param props The possibly null set of properties used to
   454      * select the SASL mechanism and to configure the authentication
   469      * select the SASL mechanism and to configure the authentication
   455      * exchange of the selected mechanism.
   470      * exchange of the selected mechanism.
   456      * For example, if <tt>props</tt> contains the
   471      * For example, if <tt>props</tt> contains the
   457      * <code>Sasl.POLICY_NOPLAINTEXT</code> property with the value
   472      * <code>Sasl.POLICY_NOPLAINTEXT</code> property with the value