1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.asn1.actions;
21
22
23 import org.apache.directory.api.asn1.DecoderException;
24 import org.apache.directory.api.asn1.ber.Asn1Container;
25 import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
26 import org.apache.directory.api.asn1.ber.tlv.TLV;
27 import org.apache.directory.api.i18n.I18n;
28 import org.apache.directory.api.util.Strings;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
31
32
33 /**
34 * The action used read a BITSTRING from a TLV
35 *
36 * @param <C> The container type
37 *
38 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
39 */
40 public abstract class AbstractReadBitString<C extends Asn1Container> extends GrammarAction<C>
41 {
42 /** The logger */
43 private static final Logger LOG = LoggerFactory.getLogger( AbstractReadBitString.class );
44
45 /** Speedup for logs */
46 private static final boolean IS_DEBUG = LOG.isDebugEnabled();
47
48
49 /**
50 * Instantiates a new AbstractReadByteArray action.
51 *
52 * @param name the action's name
53 */
54 public AbstractReadBitString( String name )
55 {
56 super( name );
57 }
58
59
60 /**
61 * Gives a byte array to be set to the appropriate field of the ASN.1 object
62 * present in the container
63 *
64 * @param data the data of the read TLV present in byte array format
65 * @param container the container holding the ASN.1 object
66 */
67 protected abstract void setBitString( byte[] data, C container );
68
69
70 /**
71 * {@inheritDoc}
72 */
73 @Override
74 public final void action( C container ) throws DecoderException
75 {
76 TLV tlv = container.getCurrentTLV();
77
78 // The Length should not be null, and should be 5
79 if ( tlv.getLength() != 5 )
80 {
81 LOG.error( I18n.err( I18n.ERR_04066 ) );
82
83 // This will generate a PROTOCOL_ERROR
84 throw new DecoderException( I18n.err( I18n.ERR_04067 ) );
85 }
86
87 byte[] data = tlv.getValue().getData();
88 setBitString( data, container );
89
90 if ( IS_DEBUG )
91 {
92 LOG.debug( "BITSTRING value : {}", Strings.dumpBytes( data ) );
93 }
94 }
95 }