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.ldap.model.name.Rdn;
036import org.apache.directory.shared.util.Strings;
037import org.slf4j.Logger;
038import org.slf4j.LoggerFactory;
039
040
041/**
042 * The action used to store the ModifyDnRequest new RDN
043 * <pre>
044 * ModifyDNRequest ::= [APPLICATION 12] SEQUENCE { ...
045 *     ...
046 *     newrdn  RelativeRDN,
047 *     ...
048 *
049 * RelativeRDN :: LDAPString
050 * </pre>
051 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
052 */
053public class StoreModifyDnRequestNewRdn extends GrammarAction<LdapMessageContainer<ModifyDnRequestDecorator>>
054{
055    /** The logger */
056    private static final Logger LOG = LoggerFactory.getLogger( StoreModifyDnRequestNewRdn.class );
057
058    /** Speedup for logs */
059    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
060
061    /**
062     * Instantiates a new action.
063     */
064    public StoreModifyDnRequestNewRdn()
065    {
066        super( "Store ModifyDN request new RDN" );
067    }
068
069
070    /**
071     * {@inheritDoc}
072     */
073    public void action( LdapMessageContainer<ModifyDnRequestDecorator> container ) throws DecoderException
074    {
075        ModifyDnRequest modifyDnRequest = container.getMessage();
076
077        // Get the Value and store it in the modifyDNRequest
078        TLV tlv = container.getCurrentTLV();
079
080        // We have to handle the special case of a 0 length matched
081        // newDN
082        Rdn newRdn = null;
083
084        if ( tlv.getLength() == 0 )
085        {
086            String msg = I18n.err( I18n.ERR_04090 );
087            LOG.error( msg );
088
089            ModifyDnResponseImpl response = new ModifyDnResponseImpl( modifyDnRequest.getMessageId() );
090            throw new ResponseCarryingException( msg, response, ResultCodeEnum.INVALID_DN_SYNTAX,
091                modifyDnRequest.getName(), null );
092        }
093        else
094        {
095            byte[] dnBytes = tlv.getValue().getData();
096            String dnStr = Strings.utf8ToString(dnBytes);
097
098            try
099            {
100                Dn dn = new Dn( dnStr );
101                newRdn = dn.getRdn( dn.size() - 1 );
102            }
103            catch ( LdapInvalidDnException ine )
104            {
105                String msg = "Invalid new Rdn given : " + dnStr + " (" + Strings.dumpBytes(dnBytes)
106                    + ") is invalid";
107                LOG.error( "{} : {}", msg, ine.getMessage() );
108
109                ModifyDnResponseImpl response = new ModifyDnResponseImpl( modifyDnRequest.getMessageId() );
110                throw new ResponseCarryingException( msg, response, ResultCodeEnum.INVALID_DN_SYNTAX,
111                    modifyDnRequest.getName(), ine );
112            }
113
114            modifyDnRequest.setNewRdn( newRdn );
115        }
116
117        if ( IS_DEBUG )
118        {
119            LOG.debug( "Modifying with new Rdn {}", newRdn );
120        }
121    }
122}