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.actions.modifyDnRequest;
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.codec.decorators.ModifyDnRequestDecorator;
030import org.apache.directory.api.ldap.model.exception.LdapInvalidDnException;
031import org.apache.directory.api.ldap.model.message.ModifyDnRequest;
032import org.apache.directory.api.ldap.model.message.ModifyDnResponseImpl;
033import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
034import org.apache.directory.api.ldap.model.name.Dn;
035import org.apache.directory.api.ldap.model.name.Rdn;
036import org.apache.directory.api.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    /**
063     * Instantiates a new action.
064     */
065    public StoreModifyDnRequestNewRdn()
066    {
067        super( "Store ModifyDN request new RDN" );
068    }
069
070
071    /**
072     * {@inheritDoc}
073     */
074    public void action( LdapMessageContainer<ModifyDnRequestDecorator> container ) throws DecoderException
075    {
076        ModifyDnRequest modifyDnRequest = container.getMessage();
077
078        // Get the Value and store it in the modifyDNRequest
079        TLV tlv = container.getCurrentTLV();
080
081        // We have to handle the special case of a 0 length matched
082        // newDN
083        Rdn newRdn;
084
085        if ( tlv.getLength() == 0 )
086        {
087            String msg = I18n.err( I18n.ERR_04090 );
088            LOG.error( msg );
089
090            ModifyDnResponseImpl response = new ModifyDnResponseImpl( modifyDnRequest.getMessageId() );
091            throw new ResponseCarryingException( msg, response, ResultCodeEnum.INVALID_DN_SYNTAX,
092                modifyDnRequest.getName(), null );
093        }
094        else
095        {
096            byte[] dnBytes = tlv.getValue().getData();
097            String dnStr = Strings.utf8ToString( dnBytes );
098
099            try
100            {
101                Dn dn = new Dn( dnStr );
102                newRdn = dn.getRdn( dn.size() - 1 );
103            }
104            catch ( LdapInvalidDnException ine )
105            {
106                String msg = "Invalid new Rdn given : " + dnStr + " (" + Strings.dumpBytes( dnBytes )
107                    + ") 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.setNewRdn( newRdn );
116        }
117
118        if ( IS_DEBUG )
119        {
120            LOG.debug( "Modifying with new Rdn {}", newRdn );
121        }
122    }
123}