001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * docs/licenses/cddl.txt
011     * or http://www.opensource.org/licenses/cddl1.php.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * docs/licenses/cddl.txt.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2010-2012 UnboundID Corp.
026     */
027    package com.unboundid.directory.sdk.common.operation;
028    
029    
030    
031    import com.unboundid.asn1.ASN1OctetString;
032    import com.unboundid.ldap.sdk.LDAPResult;
033    import com.unboundid.util.NotExtensible;
034    import com.unboundid.util.ThreadSafety;
035    import com.unboundid.util.ThreadSafetyLevel;
036    
037    
038    
039    /**
040     * This interface defines a set of methods which may be used to update bind
041     * results.
042     */
043    @NotExtensible()
044    @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
045    public interface UpdatableBindResult
046           extends BindResult, UpdatableGenericResult
047    {
048      /**
049       * Specifies the server SASL credentials for the bind result, if any.
050       *
051       * @param  serverSASLCredentials  The server SASL credentials for the bind
052       *                                result.  It may be {@code null} if there are
053       *                                none.
054       */
055      void setServerSASLCredentials(final ASN1OctetString serverSASLCredentials);
056    
057    
058    
059      /**
060       * Sets the contents of this result with information from the provided
061       * LDAP result, including the result code, diagnostic message, matched DN,
062       * referral URLs, and controls.  If the provided result is also an instance
063       * of an LDAP SDK {@code BindResult}, then the server SASL credentials will
064       * also be updated.
065       *
066       * @param  result  The result to use to update this result.  It must not be
067       *                 {@code null}.
068       */
069      void setResultData(final LDAPResult result);
070    }