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 */
020package org.apache.directory.api.ldap.model.message;
021
022
023/**
024 * Bind protocol response message used to confirm the results of a bind request
025 * message. BindResponse consists simply of an indication from the server of the
026 * status of the client's request for authentication.
027 * 
028 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
029 */
030public interface BindResponse extends ResultResponse
031{
032    /** Bind response message type enumeration value */
033    MessageTypeEnum TYPE = MessageTypeEnum.BIND_RESPONSE;
034
035
036    /**
037     * Gets the optional property holding SASL authentication response parameters
038     * that are SASL mechanism specific. Will return null if the authentication
039     * is simple.
040     * 
041     * @return the sasl mech. specific credentials or null of auth. is simple
042     */
043    byte[] getServerSaslCreds();
044
045
046    /**
047     * Sets the optional property holding SASL authentication response paramters
048     * that are SASL mechanism specific. Leave null if authentication mode is
049     * simple.
050     * 
051     * @param serverSaslCreds the sasl auth. mech. specific credentials
052     */
053    void setServerSaslCreds( byte[] serverSaslCreds );
054}