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 /** 033 * Gets the optional property holding SASL authentication response parameters 034 * that are SASL mechanism specific. Will return null if the authentication 035 * is simple. 036 * 037 * @return the sasl mech. specific credentials or null of auth. is simple 038 */ 039 byte[] getServerSaslCreds(); 040 041 042 /** 043 * Sets the optional property holding SASL authentication response paramters 044 * that are SASL mechanism specific. Leave null if authentication mode is 045 * simple. 046 * 047 * @param serverSaslCreds the sasl auth. mech. specific credentials 048 */ 049 void setServerSaslCreds( byte[] serverSaslCreds ); 050}