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.BerValue; 027import org.apache.directory.api.asn1.ber.tlv.IntegerDecoder; 028import org.apache.directory.api.asn1.ber.tlv.IntegerDecoderException; 029import org.apache.directory.api.asn1.ber.tlv.TLV; 030import org.apache.directory.api.i18n.I18n; 031import org.apache.directory.api.util.Strings; 032import org.slf4j.Logger; 033import org.slf4j.LoggerFactory; 034 035 036/** 037 * The action used to read an integer value 038 * 039 * @param <E> The container type 040 * 041 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 042 */ 043public abstract class AbstractReadInteger<E extends Asn1Container> extends GrammarAction<E> 044{ 045 /** The logger */ 046 private static final Logger LOG = LoggerFactory.getLogger( AbstractReadInteger.class ); 047 048 /** Speedup for logs */ 049 private static final boolean IS_DEBUG = LOG.isDebugEnabled(); 050 051 /** the acceptable minimum value for the expected value to be parsed */ 052 private int minValue = 0; 053 054 /** the acceptable maximum value for the expected value to be parsed */ 055 private int maxValue = Integer.MAX_VALUE; 056 057 058 /** 059 * Instantiates a new AbstractReadInteger action. 060 * 061 * @param name the action's name 062 */ 063 public AbstractReadInteger( String name ) 064 { 065 super( name ); 066 } 067 068 069 /** 070 * 071 * Creates a new instance of AbstractReadInteger. 072 * 073 * @param name the action's name 074 * @param minValue the acceptable minimum value for the expected value to be read 075 * @param maxValue the acceptable maximum value for the value to be read 076 */ 077 public AbstractReadInteger( String name, int minValue, int maxValue ) 078 { 079 super( name ); 080 081 this.minValue = minValue; 082 this.maxValue = maxValue; 083 } 084 085 086 /** 087 * 088 * set the integer value to the appropriate field of ASN.1 object present in the container 089 * 090 * @param value the integer value 091 * @param container the ASN.1 object's container 092 */ 093 protected abstract void setIntegerValue( int value, E container ); 094 095 096 /** 097 * {@inheritDoc} 098 */ 099 @Override 100 public final void action( E container ) throws DecoderException 101 { 102 TLV tlv = container.getCurrentTLV(); 103 104 // The Length should not be null 105 if ( tlv.getLength() == 0 ) 106 { 107 LOG.error( I18n.err( I18n.ERR_04066 ) ); 108 109 // This will generate a PROTOCOL_ERROR 110 throw new DecoderException( I18n.err( I18n.ERR_04067 ) ); 111 } 112 113 BerValue value = tlv.getValue(); 114 115 try 116 { 117 int number = IntegerDecoder.parse( value, minValue, maxValue ); 118 119 if ( IS_DEBUG ) 120 { 121 LOG.debug( "read integer value : {}", number ); 122 } 123 124 setIntegerValue( number, container ); 125 } 126 catch ( IntegerDecoderException ide ) 127 { 128 LOG.error( I18n.err( I18n.ERR_04070, Strings.dumpBytes( value.getData() ), ide 129 .getLocalizedMessage() ) ); 130 131 // This will generate a PROTOCOL_ERROR 132 throw new DecoderException( ide.getMessage(), ide ); 133 } 134 } 135}