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