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