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 decoratedMessage the decorated ModifyDnResponse
50       */
51      public ModifyDnResponseDecorator( LdapApiService codec, ModifyDnResponse decoratedMessage )
52      {
53          super( codec, decoratedMessage );
54      }
55  
56  
57      /**
58       * @param modifyDnResponseLength The encoded ModifyDnResponse's length
59       */
60      public void setModifyDnResponseLength( int modifyDnResponseLength )
61      {
62          this.modifyDnResponseLength = modifyDnResponseLength;
63      }
64  
65  
66      /**
67       * Stores the encoded length for the ModifyDnResponse
68       * @return The encoded length
69       */
70      public int getModifyDnResponseLength()
71      {
72          return modifyDnResponseLength;
73      }
74  
75  
76      //-------------------------------------------------------------------------
77      // The Decorator methods
78      //-------------------------------------------------------------------------
79      /**
80       * Compute the ModifyDNResponse length 
81       * 
82       * ModifyDNResponse : 
83       * <pre>
84       * 0x6D L1 
85       *   | 
86       *   +--> LdapResult 
87       *   
88       * L1 = Length(LdapResult) 
89       * Length(ModifyDNResponse) = Length(0x6D) + Length(L1) + L1
90       * </pre>
91       */
92      public int computeLength()
93      {
94          int modifyDnResponseLength = ( ( LdapResultDecorator ) getLdapResult() ).computeLength();
95  
96          setModifyDnResponseLength( modifyDnResponseLength );
97  
98          return 1 + TLV.getNbBytes( modifyDnResponseLength ) + modifyDnResponseLength;
99      }
100 
101 
102     /**
103      * Encode the ModifyDnResponse message to a PDU.
104      * 
105      * @param buffer The buffer where to put the PDU
106      */
107     public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException
108     {
109         try
110         {
111             // The ModifyResponse Tag
112             buffer.put( LdapCodecConstants.MODIFY_DN_RESPONSE_TAG );
113             buffer.put( TLV.getBytes( getModifyDnResponseLength() ) );
114 
115             // The LdapResult
116             ( ( LdapResultDecorator ) getLdapResult() ).encode( buffer );
117         }
118         catch ( BufferOverflowException boe )
119         {
120             throw new EncoderException( I18n.err( I18n.ERR_04005 ) );
121         }
122 
123         return buffer;
124     }
125 }