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