View Javadoc
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.ModifyDnResponse;
32  
33  
34  /**
35   * A decorator for the ModifyDnResponse message
36   *
37   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
38   */
39  public class ModifyDnResponseDecorator extends ResponseDecorator<ModifyDnResponse>
40      implements ModifyDnResponse
41  {
42      /** The encoded modifyDnResponse length */
43      private int modifyDnResponseLength;
44  
45  
46      /**
47       * Makes a ModifyDnResponse encodable.
48       *
49       * @param codec The LDAP service instance
50       * @param decoratedMessage the decorated ModifyDnResponse
51       */
52      public ModifyDnResponseDecorator( LdapApiService codec, ModifyDnResponse decoratedMessage )
53      {
54          super( codec, decoratedMessage );
55      }
56  
57  
58      //-------------------------------------------------------------------------
59      // The Decorator methods
60      //-------------------------------------------------------------------------
61      /**
62       * Compute the ModifyDNResponse length 
63       * <br>
64       * ModifyDNResponse : 
65       * <pre>
66       * 0x6D L1 
67       *   | 
68       *   +--&gt; LdapResult 
69       *   
70       * L1 = Length(LdapResult) 
71       * Length(ModifyDNResponse) = Length(0x6D) + Length(L1) + L1
72       * </pre>
73       */
74      @Override
75      public int computeLength()
76      {
77          modifyDnResponseLength = ( ( LdapResultDecorator ) getLdapResult() ).computeLength();
78  
79          return 1 + TLV.getNbBytes( modifyDnResponseLength ) + modifyDnResponseLength;
80      }
81  
82  
83      /**
84       * Encode the ModifyDnResponse message to a PDU.
85       * 
86       * @param buffer The buffer where to put the PDU
87       */
88      @Override
89      public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException
90      {
91          try
92          {
93              // The ModifyResponse Tag
94              buffer.put( LdapCodecConstants.MODIFY_DN_RESPONSE_TAG );
95              buffer.put( TLV.getBytes( modifyDnResponseLength ) );
96  
97              // The LdapResult
98              ( ( LdapResultDecorator ) getLdapResult() ).encode( buffer );
99          }
100         catch ( BufferOverflowException boe )
101         {
102             throw new EncoderException( I18n.err( I18n.ERR_04005 ), boe );
103         }
104 
105         return buffer;
106     }
107 }