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   *    https://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.factory;
21  
22  import org.apache.directory.api.asn1.ber.tlv.BerValue;
23  import org.apache.directory.api.asn1.util.Asn1Buffer;
24  import org.apache.directory.api.ldap.codec.api.LdapApiService;
25  import org.apache.directory.api.ldap.codec.api.LdapCodecConstants;
26  import org.apache.directory.api.ldap.model.message.Message;
27  import org.apache.directory.api.ldap.model.message.ModifyDnRequest;
28  import org.apache.directory.api.util.Strings;
29  
30  /**
31   * The ModifyDnRequest factory.
32   *
33   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34   */
35  public final class ModifyDnRequestFactory implements Messagefactory
36  {
37      /** The static instance */
38      public static final ModifyDnRequestFactory INSTANCE = new ModifyDnRequestFactory();
39  
40      private ModifyDnRequestFactory()
41      {
42          // Nothing to do
43      }
44  
45  
46      /**
47       * Encode the ModifyDnRequest message to a PDU.
48       * <br>
49       * ModifyDNRequest :
50       * <pre>
51       * 0x6C LL
52       *   0x04 LL entry
53       *   0x04 LL newRDN
54       *   0x01 0x01 deleteOldRDN
55       *   [0x80 LL newSuperior]
56       * </pre>
57       *
58       * @param codec The LdapApiService instance
59       * @param buffer The buffer where to put the PDU
60       * @param message the ModifyRequest to encode
61       */
62      @Override
63      public void encodeReverse( LdapApiService codec, Asn1Buffer buffer, Message message )
64      {
65          int start = buffer.getPos();
66          ModifyDnRequest modifyDnRequest = ( ModifyDnRequest ) message;
67  
68          if ( modifyDnRequest.getNewSuperior() != null )
69          {
70              // Encode the new superior
71              BerValue.encodeOctetString( buffer,
72                  ( byte ) LdapCodecConstants.MODIFY_DN_REQUEST_NEW_SUPERIOR_TAG,
73                  Strings.getBytesUtf8( modifyDnRequest.getNewSuperior().getName() ) );
74          }
75  
76          // The deleteOldRdn flag
77          BerValue.encodeBoolean( buffer, modifyDnRequest.getDeleteOldRdn() );
78  
79          // The new RDN
80          BerValue.encodeOctetString( buffer, modifyDnRequest.getNewRdn().getName() );
81  
82          // The entry DN
83          BerValue.encodeOctetString( buffer, modifyDnRequest.getName().getName() );
84  
85          // The ModifyDnRequest tag
86          BerValue.encodeSequence( buffer, LdapCodecConstants.MODIFY_DN_REQUEST_TAG, start );
87      }
88  }