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.delRequest;
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.DeleteRequestDecorator;
030import org.apache.directory.api.ldap.model.exception.LdapInvalidDnException;
031import org.apache.directory.api.ldap.model.message.DeleteRequest;
032import org.apache.directory.api.ldap.model.message.DeleteRequestImpl;
033import org.apache.directory.api.ldap.model.message.DeleteResponseImpl;
034import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
035import org.apache.directory.api.ldap.model.name.Dn;
036import org.apache.directory.api.util.Strings;
037import org.slf4j.Logger;
038import org.slf4j.LoggerFactory;
039
040
041/**
042 * The action used to initialize the DelRequest.
043 * <pre>
044 * LdapMessage ::= ... DelRequest ...
045 * delRequest ::= [APPLICATION 10] LDAPDN
046 *
047 * We store the Dn to bve deleted into the DelRequest object
048 * </pre>
049 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
050 */
051public class InitDelRequest extends GrammarAction<LdapMessageContainer<DeleteRequestDecorator>>
052{
053    /** The logger */
054    private static final Logger LOG = LoggerFactory.getLogger( InitDelRequest.class );
055
056    /** Speedup for logs */
057    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
058
059
060    /**
061     * Instantiates a new action.
062     */
063    public InitDelRequest()
064    {
065        super( "Delete Request initialization" );
066    }
067
068
069    /**
070     * {@inheritDoc}
071     */
072    public void action( LdapMessageContainer<DeleteRequestDecorator> container ) throws DecoderException
073    {
074        // Create the DeleteRequest LdapMessage instance and store it in the container
075        DeleteRequest internaldelRequest = new DeleteRequestImpl();
076        internaldelRequest.setMessageId( container.getMessageId() );
077        DeleteRequestDecorator delRequest = new DeleteRequestDecorator(
078            container.getLdapCodecService(), internaldelRequest );
079        container.setMessage( delRequest );
080
081        // And store the Dn into it
082        // Get the Value and store it in the DelRequest
083        TLV tlv = container.getCurrentTLV();
084
085        // We have to handle the special case of a 0 length matched
086        // Dn
087        Dn entry;
088
089        if ( tlv.getLength() == 0 )
090        {
091            // This will generate a PROTOCOL_ERROR
092            throw new DecoderException( I18n.err( I18n.ERR_04073 ) );
093        }
094        else
095        {
096            byte[] dnBytes = tlv.getValue().getData();
097            String dnStr = Strings.utf8ToString( dnBytes );
098
099            try
100            {
101                entry = new Dn( dnStr );
102            }
103            catch ( LdapInvalidDnException ine )
104            {
105                String msg = I18n.err( I18n.ERR_04074, dnStr, Strings.dumpBytes( dnBytes ), ine
106                    .getLocalizedMessage() );
107                LOG.error( msg );
108
109                DeleteResponseImpl response = new DeleteResponseImpl( delRequest.getMessageId() );
110                throw new ResponseCarryingException( msg, response, ResultCodeEnum.INVALID_DN_SYNTAX,
111                    Dn.EMPTY_DN, ine );
112            }
113
114            delRequest.setName( entry );
115        }
116
117        // We can have an END transition
118        container.setGrammarEndAllowed( true );
119
120        if ( IS_DEBUG )
121        {
122            LOG.debug( "Deleting Dn {}", entry );
123        }
124    }
125}