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.ModifyResponse;
032
033
034/**
035 * A decorator for the ModifyResponse message
036 *
037 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
038 */
039public class ModifyResponseDecorator extends ResponseDecorator<ModifyResponse>
040    implements ModifyResponse
041{
042    /** The encoded modifyResponse length */
043    private int modifyResponseLength;
044
045
046    /**
047     * Makes a ModifyResponse encodable.
048     *
049     * @param codec The LDAP service instance
050     * @param decoratedMessage the decorated ModifyResponse
051     */
052    public ModifyResponseDecorator( LdapApiService codec, ModifyResponse decoratedMessage )
053    {
054        super( codec, decoratedMessage );
055    }
056
057
058    //-------------------------------------------------------------------------
059    // The Decorator methods
060    //-------------------------------------------------------------------------
061
062    /**
063     * Compute the ModifyResponse length 
064     * <br>
065     * ModifyResponse : 
066     * <pre>
067     * 0x67 L1 
068     *   | 
069     *   +--&gt; LdapResult 
070     *   
071     * L1 = Length(LdapResult) 
072     * Length(ModifyResponse) = Length(0x67) + Length(L1) + L1
073     * </pre>
074     */
075    @Override
076    public int computeLength()
077    {
078        modifyResponseLength = ( ( LdapResultDecorator ) getLdapResult() ).computeLength();
079
080        return 1 + TLV.getNbBytes( modifyResponseLength ) + modifyResponseLength;
081    }
082
083
084    /**
085     * Encode the ModifyResponse message to a PDU.
086     * 
087     * @param buffer The buffer where to put the PDU
088     */
089    @Override
090    public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException
091    {
092        try
093        {
094            // The ModifyResponse Tag
095            buffer.put( LdapCodecConstants.MODIFY_RESPONSE_TAG );
096            buffer.put( TLV.getBytes( modifyResponseLength ) );
097
098            // The LdapResult
099            ( ( LdapResultDecorator ) getLdapResult() ).encode( buffer );
100        }
101        catch ( BufferOverflowException boe )
102        {
103            throw new EncoderException( I18n.err( I18n.ERR_04005 ), boe );
104        }
105
106        return buffer;
107    }
108}