001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *  
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *  
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License. 
018     *  
019     */
020    package org.apache.directory.shared.ldap.message.internal;
021    
022    import org.apache.directory.shared.ldap.codec.MessageTypeEnum;
023    
024    
025    /**
026     * Bind protocol response message used to confirm the results of a bind request
027     * message. BindResponse consists simply of an indication from the server of the
028     * status of the client's request for authentication.
029     * 
030     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031     * @version $Rev: 910150 $
032     */
033    public interface InternalBindResponse extends InternalResultResponse
034    {
035        /** Bind response message type enumeration value */
036        MessageTypeEnum TYPE = MessageTypeEnum.BIND_RESPONSE;
037    
038    
039        /**
040         * Gets the optional property holding SASL authentication response parameters
041         * that are SASL mechanism specific. Will return null if the authentication
042         * is simple.
043         * 
044         * @return the sasl mech. specific credentials or null of auth. is simple
045         */
046        byte[] getServerSaslCreds();
047    
048    
049        /**
050         * Sets the optional property holding SASL authentication response paramters
051         * that are SASL mechanism specific. Leave null if authentication mode is
052         * simple.
053         * 
054         * @param a_serverSaslCreds
055         *            the sasl auth. mech. specific credentials
056         */
057        void setServerSaslCreds( byte[] a_serverSaslCreds );
058    }