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