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.bindRequest;
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.BindRequestDecorator;
032import org.apache.directory.api.ldap.model.message.BindRequest;
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 BindRequest version.
040 * <pre>
041 * BindRequest ::= [APPLICATION 0] SEQUENCE {
042 *     version                 INTEGER (1 ..  127),
043 *     ....
044 * </pre>
045 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
046 */
047public class StoreVersion extends GrammarAction<LdapMessageContainer<BindRequestDecorator>>
048{
049    /** The logger */
050    private static final Logger LOG = LoggerFactory.getLogger( StoreVersion.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 StoreVersion()
060    {
061        super( "Store BindRequest Version" );
062    }
063
064
065    /**
066     * {@inheritDoc}
067     */
068    public void action( LdapMessageContainer<BindRequestDecorator> container ) throws DecoderException
069    {
070        BindRequest bindRequestMessage = container.getMessage();
071
072        // The current TLV should be a integer between 1 and 127
073        // We get it and store it in Version
074        TLV tlv = container.getCurrentTLV();
075
076        BerValue value = tlv.getValue();
077
078        try
079        {
080            int version = IntegerDecoder.parse( value, 1, 127 );
081
082            if ( IS_DEBUG )
083            {
084                LOG.debug( "Ldap version ", Integer.valueOf( version ) );
085            }
086
087            bindRequestMessage.setVersion3( version == 3 );
088        }
089        catch ( IntegerDecoderException ide )
090        {
091            LOG.error( I18n
092                .err( I18n.ERR_04078, Strings.dumpBytes( value.getData() ), ide.getMessage() ) );
093
094            // This will generate a PROTOCOL_ERROR
095            throw new DecoderException( ide.getMessage(), ide );
096        }
097    }
098}