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.codec.decorators;
21
22
23 import java.nio.BufferOverflowException;
24 import java.nio.ByteBuffer;
25
26 import org.apache.directory.api.asn1.EncoderException;
27 import org.apache.directory.api.asn1.ber.tlv.TLV;
28 import org.apache.directory.api.i18n.I18n;
29 import org.apache.directory.api.ldap.codec.api.LdapApiService;
30 import org.apache.directory.api.ldap.codec.api.LdapCodecConstants;
31 import org.apache.directory.api.ldap.model.message.SearchResultDone;
32
33
34 /**
35 * A decorator for the SearchResultDone message
36 *
37 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
38 */
39 public class SearchResultDoneDecorator extends ResponseDecorator<SearchResultDone> implements SearchResultDone
40 {
41 /** The encoded searchResultDone length */
42 private int searchResultDoneLength;
43
44
45 /**
46 * Makes a SearchResultDone encodable.
47 *
48 * @param decoratedMessage the decorated SearchResultDone
49 */
50 public SearchResultDoneDecorator( LdapApiService codec, SearchResultDone decoratedMessage )
51 {
52 super( codec, decoratedMessage );
53 }
54
55
56 /**
57 * Stores the encoded length for the SearchResultDone
58 * @param searchResultDoneLength The encoded length
59 */
60 public void setSearchResultDoneLength( int searchResultDoneLength )
61 {
62 this.searchResultDoneLength = searchResultDoneLength;
63 }
64
65
66 /**
67 * @return The encoded SearchResultDone's length
68 */
69 public int getSearchResultDoneLength()
70 {
71 return searchResultDoneLength;
72 }
73
74
75 //-------------------------------------------------------------------------
76 // The Decorator methods
77 //-------------------------------------------------------------------------
78
79 /**
80 * Compute the SearchResultDone length
81 *
82 * SearchResultDone :
83 * <pre>
84 * 0x65 L1
85 * |
86 * +--> LdapResult
87 *
88 * L1 = Length(LdapResult)
89 * Length(SearchResultDone) = Length(0x65) + Length(L1) + L1
90 * </pre>
91 */
92 public int computeLength()
93 {
94 int searchResultDoneLength = ( ( LdapResultDecorator ) getLdapResult() ).computeLength();
95
96 setSearchResultDoneLength( searchResultDoneLength );
97
98 return 1 + TLV.getNbBytes( searchResultDoneLength ) + searchResultDoneLength;
99 }
100
101
102 /**
103 * Encode the SearchResultDone message to a PDU.
104 *
105 * @param buffer The buffer where to put the PDU
106 * @param searchResultDoneDecorator The SearchResultDone decorator
107 */
108 public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException
109 {
110 try
111 {
112 // The searchResultDone Tag
113 buffer.put( LdapCodecConstants.SEARCH_RESULT_DONE_TAG );
114 buffer.put( TLV.getBytes( getSearchResultDoneLength() ) );
115
116 // The LdapResult
117 ( ( LdapResultDecorator ) getLdapResult() ).encode( buffer );
118 }
119 catch ( BufferOverflowException boe )
120 {
121 throw new EncoderException( I18n.err( I18n.ERR_04005 ) );
122 }
123
124 return buffer;
125 }
126 }