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.Message;
27 import org.apache.directory.api.ldap.model.message.Referral;
28 import org.apache.directory.api.ldap.model.message.SearchResultReference;
29
30 /**
31 * The SearchResultReference factory.
32 *
33 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34 */
35 public final class SearchResultReferenceFactory extends ResponseFactory
36 {
37 /** The static instance */
38 public static final SearchResultReferenceFactory INSTANCE = new SearchResultReferenceFactory();
39
40 private SearchResultReferenceFactory()
41 {
42 super();
43 }
44
45
46 /**
47 * Encode the SearchResultReference message to a PDU.
48 * <br>
49 * SearchResultReference :
50 * <pre>
51 * 0x73 LL
52 * 0x04 LL reference
53 * [0x04 LL reference]*
54 * </pre>
55 *
56 * @param buffer The buffer where to put the PDU
57 * @param message the SearchResultReference to encode
58 */
59 @Override
60 public void encodeReverse( LdapApiService codec, Asn1Buffer buffer, Message message )
61 {
62 int start = buffer.getPos();
63
64 SearchResultReference searchResultReference = ( SearchResultReference ) message;
65
66 // The referrals, if any
67 Referral referral = searchResultReference.getReferral();
68
69 if ( referral != null )
70 {
71 // Each referral
72 encodeReferralUrls( buffer, referral.getLdapUrls().iterator() );
73 }
74
75 // The SearchResultEntry tag
76 BerValue.encodeSequence( buffer, LdapCodecConstants.SEARCH_RESULT_REFERENCE_TAG, start );
77 }
78 }