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.factory;
021
022import org.apache.directory.api.asn1.ber.tlv.BerValue;
023import org.apache.directory.api.asn1.util.Asn1Buffer;
024import org.apache.directory.api.ldap.codec.api.LdapApiService;
025import org.apache.directory.api.ldap.codec.api.LdapCodecConstants;
026import org.apache.directory.api.ldap.model.message.Message;
027import org.apache.directory.api.ldap.model.message.ModifyDnRequest;
028import org.apache.directory.api.util.Strings;
029
030/**
031 * The ModifyDnRequest factory.
032 *
033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034 */
035public final class ModifyDnRequestFactory implements Messagefactory
036{
037    /** The static instance */
038    public static final ModifyDnRequestFactory INSTANCE = new ModifyDnRequestFactory();
039
040    private ModifyDnRequestFactory()
041    {
042        // Nothing to do
043    }
044
045
046    /**
047     * Encode the ModifyDnRequest message to a PDU.
048     * <br>
049     * ModifyDNRequest :
050     * <pre>
051     * 0x6C LL
052     *   0x04 LL entry
053     *   0x04 LL newRDN
054     *   0x01 0x01 deleteOldRDN
055     *   [0x80 LL newSuperior]
056     * </pre>
057     *
058     * @param codec The LdapApiService instance
059     * @param buffer The buffer where to put the PDU
060     * @param message the ModifyRequest to encode
061     */
062    @Override
063    public void encodeReverse( LdapApiService codec, Asn1Buffer buffer, Message message )
064    {
065        int start = buffer.getPos();
066        ModifyDnRequest modifyDnRequest = ( ModifyDnRequest ) message;
067
068        if ( modifyDnRequest.getNewSuperior() != null )
069        {
070            // Encode the new superior
071            BerValue.encodeOctetString( buffer,
072                ( byte ) LdapCodecConstants.MODIFY_DN_REQUEST_NEW_SUPERIOR_TAG,
073                Strings.getBytesUtf8( modifyDnRequest.getNewSuperior().getName() ) );
074        }
075
076        // The deleteOldRdn flag
077        BerValue.encodeBoolean( buffer, modifyDnRequest.getDeleteOldRdn() );
078
079        // The new RDN
080        BerValue.encodeOctetString( buffer, modifyDnRequest.getNewRdn().getName() );
081
082        // The entry DN
083        BerValue.encodeOctetString( buffer, modifyDnRequest.getName().getName() );
084
085        // The ModifyDnRequest tag
086        BerValue.encodeSequence( buffer, LdapCodecConstants.MODIFY_DN_REQUEST_TAG, start );
087    }
088}