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