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 * https://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.BerValue;
27 import org.apache.directory.api.asn1.ber.tlv.IntegerDecoder;
28 import org.apache.directory.api.asn1.ber.tlv.IntegerDecoderException;
29 import org.apache.directory.api.asn1.ber.tlv.TLV;
30 import org.apache.directory.api.i18n.I18n;
31 import org.apache.directory.api.util.Strings;
32 import org.slf4j.Logger;
33 import org.slf4j.LoggerFactory;
34
35
36 /**
37 * The action used to read an integer value
38 *
39 * @param <E> The container type
40 *
41 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
42 */
43 public abstract class AbstractReadInteger<E extends Asn1Container> extends GrammarAction<E>
44 {
45 /** The logger */
46 private static final Logger LOG = LoggerFactory.getLogger( AbstractReadInteger.class );
47
48 /** the acceptable minimum value for the expected value to be parsed */
49 private int minValue = 0;
50
51 /** the acceptable maximum value for the expected value to be parsed */
52 private int maxValue = Integer.MAX_VALUE;
53
54
55 /**
56 * Instantiates a new AbstractReadInteger action.
57 *
58 * @param name the action's name
59 */
60 public AbstractReadInteger( String name )
61 {
62 super( name );
63 }
64
65
66 /**
67 *
68 * Creates a new instance of AbstractReadInteger.
69 *
70 * @param name the action's name
71 * @param minValue the acceptable minimum value for the expected value to be read
72 * @param maxValue the acceptable maximum value for the value to be read
73 */
74 public AbstractReadInteger( String name, int minValue, int maxValue )
75 {
76 super( name );
77
78 this.minValue = minValue;
79 this.maxValue = maxValue;
80 }
81
82
83 /**
84 *
85 * set the integer value to the appropriate field of ASN.1 object present in the container
86 *
87 * @param value the integer value
88 * @param container the ASN.1 object's container
89 */
90 protected abstract void setIntegerValue( int value, E container );
91
92
93 /**
94 * {@inheritDoc}
95 */
96 @Override
97 public final void action( E container ) throws DecoderException
98 {
99 TLV tlv = container.getCurrentTLV();
100
101 // The Length should not be null
102 if ( tlv.getLength() == 0 )
103 {
104 String msg = I18n.err( I18n.ERR_01101_NULL_LENGTH );
105
106 LOG.error( msg );
107
108 // This will generate a PROTOCOL_ERROR
109 throw new DecoderException( msg );
110 }
111
112 BerValue value = tlv.getValue();
113
114 try
115 {
116 int number = IntegerDecoder.parse( value, minValue, maxValue );
117
118 if ( LOG.isDebugEnabled() )
119 {
120 LOG.debug( I18n.msg( I18n.MSG_01100_INTEGER_VALUE, number ) );
121 }
122
123 setIntegerValue( number, container );
124 }
125 catch ( IntegerDecoderException ide )
126 {
127 LOG.error( I18n.err( I18n.ERR_01102_INVALID_INTEGER, Strings.dumpBytes( value.getData() ), ide
128 .getLocalizedMessage() ) );
129
130 // This will generate a PROTOCOL_ERROR
131 throw new DecoderException( ide.getMessage(), ide );
132 }
133 }
134 }