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 *    https://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.actions.request.modifydn;
021
022
023import org.apache.directory.api.asn1.DecoderException;
024import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
025import org.apache.directory.api.asn1.ber.tlv.TLV;
026import org.apache.directory.api.i18n.I18n;
027import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
028import org.apache.directory.api.ldap.codec.api.ResponseCarryingException;
029import org.apache.directory.api.ldap.model.exception.LdapInvalidDnException;
030import org.apache.directory.api.ldap.model.message.ModifyDnRequest;
031import org.apache.directory.api.ldap.model.message.ModifyDnResponseImpl;
032import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
033import org.apache.directory.api.ldap.model.name.Dn;
034import org.apache.directory.api.util.Strings;
035import org.slf4j.Logger;
036import org.slf4j.LoggerFactory;
037
038
039/**
040 * The action used to store the ModifyDnRequest new Superior
041 * <pre>
042 * ModifyDNRequest ::= [APPLICATION 12] SEQUENCE { ...
043 *     ...
044 *     newSuperior [0] LDAPDN OPTIONAL }
045 * </pre>
046 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
047 */
048public class StoreModifyDnRequestNewSuperior extends GrammarAction<LdapMessageContainer<ModifyDnRequest>>
049{
050    /** The logger */
051    private static final Logger LOG = LoggerFactory.getLogger( StoreModifyDnRequestNewSuperior.class );
052
053    /**
054     * Instantiates a new action.
055     */
056    public StoreModifyDnRequestNewSuperior()
057    {
058        super( "Store new superior" );
059    }
060
061
062    /**
063     * {@inheritDoc}
064     */
065    @Override
066    public void action( LdapMessageContainer<ModifyDnRequest> container ) throws DecoderException
067    {
068        ModifyDnRequest modifyDnRequest = container.getMessage();
069
070        // Get the Value and store it in the modifyDNRequest
071        TLV tlv = container.getCurrentTLV();
072
073        // We have to handle the special case of a 0 length matched
074        // Dn
075        if ( tlv.getLength() == 0 )
076        {
077
078            if ( modifyDnRequest.getDeleteOldRdn() )
079            {
080                // This will generate a PROTOCOL_ERROR
081                throw new DecoderException( I18n.err( I18n.ERR_05128_NULL_SUPERIOR ) );
082            }
083            else
084            {
085                if ( LOG.isWarnEnabled() )
086                {
087                    LOG.warn( I18n.msg( I18n.MSG_05139_NULL_NEW_SUPERIOR ) );
088                }
089            }
090
091            modifyDnRequest.setNewSuperior( Dn.EMPTY_DN );
092        }
093        else
094        {
095            byte[] dnBytes = tlv.getValue().getData();
096            String dnStr = Strings.utf8ToString( dnBytes );
097
098            try
099            {
100                Dn newSuperior = new Dn( dnStr );
101                modifyDnRequest.setNewSuperior( newSuperior );
102            }
103            catch ( LdapInvalidDnException ine )
104            {
105                String msg = I18n.err( I18n.ERR_05129_INVALID_NEW_SUPERIOR, dnStr, Strings.dumpBytes( dnBytes ) );
106                LOG.error( I18n.err( I18n.ERR_05114_ERROR_MESSAGE, msg, ine.getMessage() ) );
107
108                ModifyDnResponseImpl response = new ModifyDnResponseImpl( modifyDnRequest.getMessageId() );
109                throw new ResponseCarryingException( msg, response, ResultCodeEnum.INVALID_DN_SYNTAX,
110                    modifyDnRequest.getName(), ine );
111            }
112        }
113
114        // We can have an END transition
115        container.setGrammarEndAllowed( true );
116
117        if ( LOG.isDebugEnabled() )
118        {
119            LOG.debug( I18n.msg( I18n.MSG_05140_NEW_SUPERIOR_DN, modifyDnRequest.getNewSuperior() ) );
120        }
121    }
122}