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.modifyRequest;
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.ldap.codec.api.LdapMessageContainer;
027import org.apache.directory.shared.ldap.codec.api.ResponseCarryingException;
028import org.apache.directory.shared.ldap.codec.decorators.ModifyRequestDecorator;
029import org.apache.directory.shared.ldap.model.exception.LdapInvalidDnException;
030import org.apache.directory.shared.ldap.model.message.ModifyRequest;
031import org.apache.directory.shared.ldap.model.message.ModifyResponseImpl;
032import org.apache.directory.shared.ldap.model.message.ResultCodeEnum;
033import org.apache.directory.shared.ldap.model.name.Dn;
034import org.apache.directory.shared.util.Strings;
035import org.slf4j.Logger;
036import org.slf4j.LoggerFactory;
037
038
039/**
040 * The action used to store the ModificationRequest object name
041 * <pre>
042 * ModifyRequest ::= [APPLICATION 6] SEQUENCE {
043 *     object    LDAPDN,
044 *     ...
045 * </pre>
046 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
047 */
048public class StoreModifyRequestObjectName extends GrammarAction<LdapMessageContainer<ModifyRequestDecorator>>
049{
050    /** The logger */
051    private static final Logger LOG = LoggerFactory.getLogger( StoreModifyRequestObjectName.class );
052
053    /** Speedup for logs */
054    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
055
056    /**
057     * Instantiates a new action.
058     */
059    public StoreModifyRequestObjectName()
060    {
061        super( "Store Modify request object Name" );
062    }
063
064
065    /**
066     * {@inheritDoc}
067     */
068    public void action( LdapMessageContainer<ModifyRequestDecorator> container ) throws DecoderException
069    {
070        ModifyRequestDecorator modifyRequestDecorator = container.getMessage();
071        ModifyRequest modifyRequest = modifyRequestDecorator.getDecorated();
072
073        TLV tlv = container.getCurrentTLV();
074
075        Dn object = Dn.EMPTY_DN;
076
077        // Store the value.
078        if ( tlv.getLength() == 0 )
079        {
080            (modifyRequestDecorator.getDecorated()).setName( object );
081        }
082        else
083        {
084            byte[] dnBytes = tlv.getValue().getData();
085            String dnStr = Strings.utf8ToString(dnBytes);
086
087            try
088            {
089                object = new Dn( dnStr );
090            }
091            catch ( LdapInvalidDnException ine )
092            {
093                String msg = "Invalid Dn given : " + dnStr + " (" + Strings.dumpBytes(dnBytes)
094                    + ") is invalid";
095                LOG.error( "{} : {}", msg, ine.getMessage() );
096
097                ModifyResponseImpl response = new ModifyResponseImpl( modifyRequest.getMessageId() );
098                throw new ResponseCarryingException( msg, response, ResultCodeEnum.INVALID_DN_SYNTAX,
099                    Dn.EMPTY_DN, ine );
100            }
101
102            modifyRequest.setName( object );
103        }
104
105        if ( IS_DEBUG )
106        {
107            LOG.debug( "Modification of Dn {}", modifyRequest.getName() );
108        }
109    }
110}