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.ldapMessage;
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.api.MessageDecorator;
032import org.apache.directory.api.ldap.model.message.Message;
033import org.apache.directory.api.util.Strings;
034import org.slf4j.Logger;
035import org.slf4j.LoggerFactory;
036
037
038/**
039 * The action used to store the LdapMessage MessageID.
040 * <pre>
041 * LDAPMessage --> ... MessageId ...
042 *
043 * Checks that MessageId is in [0 .. 2147483647] and store the value in
044 * the LdapMessage Object
045 *
046 * (2147483647 = Integer.MAX_VALUE)
047 * The next state will be MESSAGE_ID_STATE
048 *
049 * The message ID will be temporarily stored in the container, because we can't store it
050 * into an object.
051 * </pre>
052 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
053 */
054public class StoreMessageId extends GrammarAction<LdapMessageContainer<MessageDecorator<? extends Message>>>
055{
056    /** The logger */
057    private static final Logger LOG = LoggerFactory.getLogger( StoreMessageId.class );
058
059    /** Speedup for logs */
060    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
061
062
063    /**
064     * Instantiates a new action.
065     */
066    public StoreMessageId()
067    {
068        super( "Store MessageID" );
069    }
070
071
072    /**
073     * {@inheritDoc}
074     */
075    public void action( LdapMessageContainer<MessageDecorator<? extends Message>> container ) throws DecoderException
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        // The Length should not be null
082        if ( tlv.getLength() == 0 )
083        {
084            LOG.error( I18n.err( I18n.ERR_04068 ) );
085
086            // This will generate a PROTOCOL_ERROR
087            throw new DecoderException( I18n.err( I18n.ERR_04069 ) );
088        }
089
090        BerValue value = tlv.getValue();
091
092        try
093        {
094            int messageId = IntegerDecoder.parse( value, 0, Integer.MAX_VALUE );
095
096            container.setMessageId( messageId );
097
098            if ( IS_DEBUG )
099            {
100                LOG.debug( "Ldap Message Id has been decoded : " + messageId );
101            }
102        }
103        catch ( IntegerDecoderException ide )
104        {
105            LOG.error( I18n.err( I18n.ERR_04070, Strings.dumpBytes( value.getData() ), ide
106                .getLocalizedMessage() ) );
107
108            // This will generate a PROTOCOL_ERROR
109            throw new DecoderException( ide.getMessage(), ide );
110        }
111    }
112}