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