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.abandon;
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.BerValue;
026import org.apache.directory.api.asn1.ber.tlv.IntegerDecoder;
027import org.apache.directory.api.asn1.ber.tlv.IntegerDecoderException;
028import org.apache.directory.api.asn1.ber.tlv.TLV;
029import org.apache.directory.api.i18n.I18n;
030import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
031import org.apache.directory.api.ldap.model.message.AbandonRequest;
032import org.apache.directory.api.ldap.model.message.AbandonRequestImpl;
033import org.apache.directory.api.util.Strings;
034import org.slf4j.Logger;
035import org.slf4j.LoggerFactory;
036
037
038/**
039 * The action used to initialize the AbandonRequest
040 * <pre>
041 * LdapMessage ::= ... AbandonRequest ...
042 * AbandonRequest ::= [APPLICATION 16] MessageID
043 * </pre>
044 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
045 */
046public class InitAbandonRequest extends GrammarAction<LdapMessageContainer<AbandonRequest>>
047{
048    /** The logger */
049    private static final Logger LOG = LoggerFactory.getLogger( InitAbandonRequest.class );
050
051
052    /**
053     * Instantiates a new action.
054     */
055    public InitAbandonRequest()
056    {
057        super( "Init Abandon Request" );
058    }
059
060
061    /**
062     * {@inheritDoc}
063     */
064    @Override
065    public void action( LdapMessageContainer<AbandonRequest> container ) throws DecoderException
066    {
067        // Create the AbandonRequest LdapMessage instance and store it in the container
068        AbandonRequest abandonRequest = new AbandonRequestImpl();
069        abandonRequest.setMessageId( container.getMessageId() );
070        container.setMessage( abandonRequest );
071
072        // The current TLV should be a integer
073        // We get it and store it in MessageId
074        TLV tlv = container.getCurrentTLV();
075
076        BerValue value = tlv.getValue();
077
078        if ( ( value == null ) || ( value.getData() == null ) )
079        {
080            String msg = I18n.err( I18n.ERR_05109_ABANDON_REQ_MSG_ID_NULL );
081            LOG.error( msg );
082
083            // This will generate a PROTOCOL_ERROR
084            throw new DecoderException( msg );
085        }
086
087        try
088        {
089            int abandonnedMessageId = IntegerDecoder.parse( value, 0, Integer.MAX_VALUE );
090
091            abandonRequest.setAbandoned( abandonnedMessageId );
092
093            if ( LOG.isDebugEnabled() )
094            {
095                LOG.debug( I18n.msg( I18n.MSG_05110_ABANDON_MSG_ID_DECODED, Integer.valueOf( abandonnedMessageId ) ) );
096            }
097
098            container.setGrammarEndAllowed( true );
099        }
100        catch ( IntegerDecoderException ide )
101        {
102            LOG.error( I18n
103                .err( I18n.ERR_05110_INVALID_ABANDON_REQ_MSG_ID, Strings.dumpBytes( value.getData() ), ide.getMessage() ) );
104
105            // This will generate a PROTOCOL_ERROR
106            throw new DecoderException( ide.getMessage(), ide );
107        }
108    }
109}