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.DeleteResponse;
032
033
034/**
035 * A decorator for the DeleteRequest message
036 *
037 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
038 */
039public class DeleteResponseDecorator extends ResponseDecorator<DeleteResponse>
040    implements DeleteResponse
041{
042    /** The encoded deleteResponse length */
043    private int deleteResponseLength;
044
045
046    /**
047     * Makes a DeleteResponse a MessageDecorator.
048     *
049     * @param decoratedMessage the decorated DeleteResponse
050     */
051    public DeleteResponseDecorator( LdapApiService codec, DeleteResponse decoratedMessage )
052    {
053        super( codec, decoratedMessage );
054    }
055
056
057    /**
058     * Stores the encoded length for the DeleteResponse
059     * @param deleteResponseLength The encoded length
060     */
061    public void setDeleteResponseLength( int deleteResponseLength )
062    {
063        this.deleteResponseLength = deleteResponseLength;
064    }
065
066
067    /**
068     * @return The encoded DeleteResponse's length
069     */
070    public int getDeleteResponseLength()
071    {
072        return deleteResponseLength;
073    }
074
075
076    //-------------------------------------------------------------------------
077    // The Decorator methods
078    //-------------------------------------------------------------------------
079
080    /**
081     * Compute the DelResponse length 
082     * 
083     * DelResponse :
084     * 
085     * 0x6B L1
086     *  |
087     *  +--> LdapResult
088     * 
089     * L1 = Length(LdapResult)
090     * 
091     * Length(DelResponse) = Length(0x6B) + Length(L1) + L1
092     */
093    public int computeLength()
094    {
095        int deleteResponseLength = ( ( LdapResultDecorator ) getLdapResult() ).computeLength();
096
097        setDeleteResponseLength( deleteResponseLength );
098
099        return 1 + TLV.getNbBytes( deleteResponseLength ) + deleteResponseLength;
100    }
101
102
103    /**
104     * Encode the DelResponse message to a PDU.
105     * 
106     * @param buffer The buffer where to put the PDU
107     */
108    public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException
109    {
110        try
111        {
112            // The DelResponse Tag
113            buffer.put( LdapCodecConstants.DEL_RESPONSE_TAG );
114            buffer.put( TLV.getBytes( getDeleteResponseLength() ) );
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}