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.LdapCodecConstants;
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 codec The LDAP service instance
049     * @param decoratedMessage the decorated SearchResultDone
050     */
051    public SearchResultDoneDecorator( LdapApiService codec, SearchResultDone decoratedMessage )
052    {
053        super( codec, decoratedMessage );
054    }
055
056
057    //-------------------------------------------------------------------------
058    // The Decorator methods
059    //-------------------------------------------------------------------------
060
061    /**
062     * Compute the SearchResultDone length 
063     * <br>
064     * SearchResultDone : 
065     * <pre>
066     * 0x65 L1 
067     *   | 
068     *   +--&gt; LdapResult 
069     *   
070     * L1 = Length(LdapResult) 
071     * Length(SearchResultDone) = Length(0x65) + Length(L1) + L1
072     * </pre>
073     * 
074     */
075    @Override
076    public int computeLength()
077    {
078        searchResultDoneLength = ( ( LdapResultDecorator ) getLdapResult() ).computeLength();
079
080        return 1 + TLV.getNbBytes( searchResultDoneLength ) + searchResultDoneLength;
081    }
082
083
084    /**
085     * Encode the SearchResultDone message to a PDU.
086     * 
087     * @param buffer The buffer where to put the PDU
088     * return The encoded response
089     * @throws EncoderException If the encoding failed
090     */
091    @Override
092    public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException
093    {
094        try
095        {
096            // The searchResultDone Tag
097            buffer.put( LdapCodecConstants.SEARCH_RESULT_DONE_TAG );
098            buffer.put( TLV.getBytes( searchResultDoneLength ) );
099
100            // The LdapResult
101            ( ( LdapResultDecorator ) getLdapResult() ).encode( buffer );
102        }
103        catch ( BufferOverflowException boe )
104        {
105            throw new EncoderException( I18n.err( I18n.ERR_04005 ), boe );
106        }
107
108        return buffer;
109    }
110}