1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.ldap.model.message;
21
22
23 /**
24 * Bind protocol response message used to confirm the results of a bind request
25 * message. BindResponse consists simply of an indication from the server of the
26 * status of the client's request for authentication.
27 *
28 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
29 */
30 public interface BindResponse extends ResultResponse
31 {
32 /** Bind response message type enumeration value */
33 //MessageTypeEnum TYPE = MessageTypeEnum.BIND_RESPONSE;
34
35 /**
36 * Gets the optional property holding SASL authentication response parameters
37 * that are SASL mechanism specific. Will return null if the authentication
38 * is simple.
39 *
40 * @return the sasl mech. specific credentials or null of auth. is simple
41 */
42 byte[] getServerSaslCreds();
43
44
45 /**
46 * Sets the optional property holding SASL authentication response paramters
47 * that are SASL mechanism specific. Leave null if authentication mode is
48 * simple.
49 *
50 * @param serverSaslCreds the sasl auth. mech. specific credentials
51 */
52 void setServerSaslCreds( byte[] serverSaslCreds );
53 }