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