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 * https://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.ldap.codec.actions.controls; 021 022 023import org.apache.directory.api.asn1.DecoderException; 024import org.apache.directory.api.asn1.ber.grammar.GrammarAction; 025import org.apache.directory.api.asn1.ber.tlv.BerValue; 026import org.apache.directory.api.asn1.ber.tlv.BooleanDecoder; 027import org.apache.directory.api.asn1.ber.tlv.BooleanDecoderException; 028import org.apache.directory.api.asn1.ber.tlv.TLV; 029import org.apache.directory.api.i18n.I18n; 030import org.apache.directory.api.ldap.codec.api.LdapMessageContainer; 031import org.apache.directory.api.ldap.model.message.Control; 032import org.apache.directory.api.ldap.model.message.Message; 033import org.apache.directory.api.util.Strings; 034import org.slf4j.Logger; 035import org.slf4j.LoggerFactory; 036 037 038/** 039 * The action used to set the control criticality flag 040 * <pre> 041 * Control ::= SEQUENCE { 042 * ... 043 * criticality BOOLEAN DEFAULT FALSE, 044 * ... 045 * </pre> 046 * 047 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 048 */ 049public class StoreControlCriticality extends GrammarAction<LdapMessageContainer<Message>> 050{ 051 /** The logger */ 052 private static final Logger LOG = LoggerFactory.getLogger( StoreControlCriticality.class ); 053 054 /** 055 * Instantiates a new StoreControlCriticality action. 056 */ 057 public StoreControlCriticality() 058 { 059 super( "Store the control criticality" ); 060 } 061 062 063 /** 064 * {@inheritDoc} 065 */ 066 @Override 067 public void action( LdapMessageContainer<Message> container ) throws DecoderException 068 { 069 TLV tlv = container.getCurrentTLV(); 070 071 // Get the current control 072 Control control = container.getCurrentControl(); 073 074 // Store the criticality 075 // We get the value. If it's a 0, it's a FALSE. If it's 076 // a FF, it's a TRUE. Any other value should be an error, 077 // but we could relax this constraint. So if we have 078 // something 079 // which is not 0, it will be interpreted as TRUE, but we 080 // will generate a warning. 081 BerValue value = tlv.getValue(); 082 083 try 084 { 085 control.setCritical( BooleanDecoder.parse( value ) ); 086 } 087 catch ( BooleanDecoderException bde ) 088 { 089 LOG.error( I18n 090 .err( I18n.ERR_08103_BAD_CONTROL_CRITICALITY, Strings.dumpBytes( value.getData() ), bde.getMessage() ) ); 091 092 // This will generate a PROTOCOL_ERROR 093 throw new DecoderException( bde.getMessage(), bde ); 094 } 095 096 // We can have an END transition 097 container.setGrammarEndAllowed( true ); 098 099 if ( LOG.isDebugEnabled() ) 100 { 101 LOG.debug( I18n.msg( I18n.MSG_08202_CONTROL_CRITICALITY, control.isCritical() ) ); 102 } 103 } 104}