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.codec.decorators;
021
022
023import java.nio.BufferOverflowException;
024import java.nio.ByteBuffer;
025
026import org.apache.directory.api.asn1.EncoderException;
027import org.apache.directory.api.asn1.ber.tlv.TLV;
028import org.apache.directory.api.i18n.I18n;
029import org.apache.directory.api.ldap.codec.api.LdapApiService;
030import org.apache.directory.api.ldap.codec.api.LdapConstants;
031import org.apache.directory.api.ldap.model.message.SearchResultDone;
032
033
034/**
035 * A decorator for the SearchResultDone message
036 *
037 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
038 */
039public class SearchResultDoneDecorator extends ResponseDecorator<SearchResultDone> implements SearchResultDone
040{
041    /** The encoded searchResultDone length */
042    private int searchResultDoneLength;
043
044
045    /**
046     * Makes a SearchResultDone encodable.
047     *
048     * @param decoratedMessage the decorated SearchResultDone
049     */
050    public SearchResultDoneDecorator( LdapApiService codec, SearchResultDone decoratedMessage )
051    {
052        super( codec, decoratedMessage );
053    }
054
055
056    /**
057     * Stores the encoded length for the SearchResultDone
058     * @param searchResultDoneLength The encoded length
059     */
060    public void setSearchResultDoneLength( int searchResultDoneLength )
061    {
062        this.searchResultDoneLength = searchResultDoneLength;
063    }
064
065
066    /**
067     * @return The encoded SearchResultDone's length
068     */
069    public int getSearchResultDoneLength()
070    {
071        return searchResultDoneLength;
072    }
073
074
075    //-------------------------------------------------------------------------
076    // The Decorator methods
077    //-------------------------------------------------------------------------
078
079    /**
080     * Compute the SearchResultDone length 
081     * 
082     * SearchResultDone : 
083     * <pre>
084     * 0x65 L1 
085     *   | 
086     *   +--> LdapResult 
087     *   
088     * L1 = Length(LdapResult) 
089     * Length(SearchResultDone) = Length(0x65) + Length(L1) + L1
090     * </pre>
091     */
092    public int computeLength()
093    {
094        int searchResultDoneLength = ( ( LdapResultDecorator ) getLdapResult() ).computeLength();
095
096        setSearchResultDoneLength( searchResultDoneLength );
097
098        return 1 + TLV.getNbBytes( searchResultDoneLength ) + searchResultDoneLength;
099    }
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( LdapConstants.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}