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.asn1.ber.tlv.Value; 028import org.apache.directory.shared.i18n.I18n; 029import org.slf4j.Logger; 030import org.slf4j.LoggerFactory; 031 032 033/** 034 * The action used to read an OCTET STRING value 035 * 036 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 037 */ 038public abstract class AbstractReadOctetString<E extends Asn1Container> extends GrammarAction<E> 039{ 040 /** The logger */ 041 private static final Logger LOG = LoggerFactory.getLogger( AbstractReadOctetString.class ); 042 043 /** the acceptable maximum value for the expected value to be parsed */ 044 private boolean canBeNull = Boolean.FALSE; 045 046 047 /** 048 * Instantiates a new AbstractReadInteger action. 049 */ 050 public AbstractReadOctetString( String name ) 051 { 052 super( name ); 053 } 054 055 056 /** 057 * Instantiates a new AbstractReadInteger action. 058 * 059 * @param name The log message 060 * @param canBeNull Tells if the byte array can be null or not 061 */ 062 public AbstractReadOctetString( String name, boolean canBeNull ) 063 { 064 super( name ); 065 066 this.canBeNull = canBeNull; 067 } 068 069 070 /** 071 * 072 * set the OCTET STRING value to the appropriate field of ASN.1 object present in the container 073 * 074 * @param value the OCTET STRING value 075 * @param container the ASN.1 object's container 076 */ 077 protected abstract void setOctetString( byte[] value, E container ); 078 079 080 /** 081 * {@inheritDoc} 082 */ 083 public final void action( E container ) throws DecoderException 084 { 085 TLV tlv = container.getCurrentTLV(); 086 087 // The Length should not be null 088 if ( ( tlv.getLength() == 0 ) && ( !canBeNull ) ) 089 { 090 LOG.error( I18n.err( I18n.ERR_04066 ) ); 091 092 // This will generate a PROTOCOL_ERROR 093 throw new DecoderException( I18n.err( I18n.ERR_04067 ) ); 094 } 095 096 Value value = tlv.getValue(); 097 098 // The data should not be null 099 if ( ( value.getData() == null ) && ( !canBeNull ) ) 100 { 101 LOG.error( I18n.err( I18n.ERR_04066 ) ); 102 103 // This will generate a PROTOCOL_ERROR 104 throw new DecoderException( I18n.err( I18n.ERR_04067 ) ); 105 } 106 107 setOctetString( value.getData(), container ); 108 } 109}