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