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.abandonRequest;
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.IntegerDecoder;
026import org.apache.directory.shared.asn1.ber.tlv.IntegerDecoderException;
027import org.apache.directory.shared.asn1.ber.tlv.TLV;
028import org.apache.directory.shared.asn1.ber.tlv.Value;
029import org.apache.directory.shared.i18n.I18n;
030import org.apache.directory.shared.ldap.codec.api.LdapMessageContainer;
031import org.apache.directory.shared.ldap.codec.decorators.AbandonRequestDecorator;
032import org.apache.directory.shared.ldap.model.message.AbandonRequest;
033import org.apache.directory.shared.ldap.model.message.AbandonRequestImpl;
034import org.apache.directory.shared.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     * Instantiates a new action.
057     */
058    public InitAbandonRequest()
059    {
060        super( "Init Abandon Request" );
061    }
062
063
064    /**
065     * {@inheritDoc}
066     */
067    public void action( LdapMessageContainer<AbandonRequestDecorator> container ) throws DecoderException
068    {
069        // Create the AbandonRequest LdapMessage instance and store it in the container
070        AbandonRequest internalAbandonRequest = new AbandonRequestImpl();
071        internalAbandonRequest.setMessageId( container.getMessageId() );
072        AbandonRequestDecorator abandonRequest = new AbandonRequestDecorator(
073            container.getLdapCodecService(), internalAbandonRequest );
074        container.setMessage( abandonRequest );
075
076        // The current TLV should be a integer
077        // We get it and store it in MessageId
078        TLV tlv = container.getCurrentTLV();
079
080        Value value = tlv.getValue();
081
082        if ( ( value == null ) || ( value.getData() == null ) )
083        {
084            String msg = I18n.err( I18n.ERR_04075 );
085            LOG.error( msg );
086
087            // This will generate a PROTOCOL_ERROR
088            throw new DecoderException( msg );
089        }
090
091        try
092        {
093            int abandonnedMessageId = IntegerDecoder.parse( value, 0, Integer.MAX_VALUE );
094
095            abandonRequest.setAbandoned( abandonnedMessageId );
096
097            if ( IS_DEBUG )
098            {
099                LOG
100                    .debug( "AbandonMessage Id has been decoded : {}", Integer
101                        .valueOf( abandonnedMessageId ) );
102            }
103
104            container.setGrammarEndAllowed( true );
105
106            return;
107        }
108        catch ( IntegerDecoderException ide )
109        {
110            LOG.error( I18n
111                .err( I18n.ERR_04076, Strings.dumpBytes(value.getData()), ide.getMessage() ) );
112
113            // This will generate a PROTOCOL_ERROR
114            throw new DecoderException( ide.getMessage(), ide );
115        }
116    }
117}