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 * https://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.codec.factory;
21
22 import org.apache.directory.api.asn1.ber.tlv.BerValue;
23 import org.apache.directory.api.asn1.util.Asn1Buffer;
24 import org.apache.directory.api.ldap.codec.api.LdapApiService;
25 import org.apache.directory.api.ldap.codec.api.LdapCodecConstants;
26 import org.apache.directory.api.ldap.model.message.BindResponse;
27 import org.apache.directory.api.ldap.model.message.Message;
28
29 /**
30 * The BindResponse factory.
31 *
32 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33 */
34 public final class BindResponseFactory extends ResponseFactory
35 {
36 /** The static instance */
37 public static final BindResponseFactory INSTANCE = new BindResponseFactory();
38
39 private BindResponseFactory()
40 {
41 super();
42 }
43
44
45 /**
46 * Encode the BindResponse message to a PDU.
47 * <br>
48 * BindResponse :
49 * <pre>
50 * 0x61 L1
51 * |
52 * +--> LdapResult
53 * [+--0x87 LL serverSaslCreds]
54 * </pre>
55 *
56 * @param codec The LdapApiService instance
57 * @param buffer The buffer where to put the PDU
58 * @param message the BindResponse to encode
59 */
60 @Override
61 public void encodeReverse( LdapApiService codec, Asn1Buffer buffer, Message message )
62 {
63 int start = buffer.getPos();
64 BindResponse bindResponse = ( ( BindResponse ) message );
65
66 // The serverSASL creds, if any
67 byte[] serverSaslCreds = bindResponse.getServerSaslCreds();
68
69 if ( serverSaslCreds != null )
70 {
71 BerValue.encodeOctetString( buffer, ( byte ) LdapCodecConstants.SERVER_SASL_CREDENTIAL_TAG,
72 serverSaslCreds );
73 }
74
75 // The LDAPResult part
76 encodeLdapResultReverse( buffer, bindResponse.getLdapResult() );
77
78 // The BindResponse Tag
79 BerValue.encodeSequence( buffer, LdapCodecConstants.BIND_RESPONSE_TAG, start );
80 }
81 }