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.asn1.actions;
021
022
023import org.apache.directory.api.asn1.DecoderException;
024import org.apache.directory.api.asn1.ber.Asn1Container;
025import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
026import org.apache.directory.api.asn1.ber.tlv.TLV;
027import org.apache.directory.api.i18n.I18n;
028import org.apache.directory.api.util.Strings;
029import org.slf4j.Logger;
030import org.slf4j.LoggerFactory;
031
032
033/**
034 * The action used read a BITSTRING from a TLV
035 * 
036 * @param <C> The container type
037 *
038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039 */
040public abstract class AbstractReadBitString<C extends Asn1Container> extends GrammarAction<C>
041{
042    /** The logger */
043    private static final Logger LOG = LoggerFactory.getLogger( AbstractReadBitString.class );
044
045    /** Speedup for logs */
046    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
047
048
049    /**
050     * Instantiates a new AbstractReadByteArray action.
051     * 
052     * @param name the action's name
053     */
054    public AbstractReadBitString( String name )
055    {
056        super( name );
057    }
058
059
060    /**
061     * Gives a byte array to be set to the appropriate field of the ASN.1 object
062     * present in the container
063     *
064     * @param data the data of the read TLV present in byte array format
065     * @param container the container holding the ASN.1 object
066     */
067    protected abstract void setBitString( byte[] data, C container );
068
069
070    /**
071     * {@inheritDoc}
072     */
073    @Override
074    public final void action( C container ) throws DecoderException
075    {
076        TLV tlv = container.getCurrentTLV();
077
078        // The Length should not be null, and should be 5
079        if ( tlv.getLength() != 5 )
080        {
081            LOG.error( I18n.err( I18n.ERR_04066 ) );
082
083            // This will generate a PROTOCOL_ERROR
084            throw new DecoderException( I18n.err( I18n.ERR_04067 ) );
085        }
086
087        byte[] data = tlv.getValue().getData();
088        setBitString( data, container );
089
090        if ( IS_DEBUG )
091        {
092            LOG.debug( "BITSTRING value : {}", Strings.dumpBytes( data ) );
093        }
094    }
095}