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