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.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.TLV;
027import org.apache.directory.api.i18n.I18n;
028import org.apache.directory.api.ldap.codec.api.ControlFactory;
029import org.apache.directory.api.ldap.extras.extended.ads_impl.endTransaction.controls.ControlsContainer;
030import org.apache.directory.api.ldap.model.message.Control;
031import org.apache.directory.api.util.Strings;
032import org.slf4j.Logger;
033import org.slf4j.LoggerFactory;
034
035
036/**
037 * The action used to set the value of a control. This is an extension point
038 * where different controls can be plugged in (at least eventually). For now we
039 * hard code controls.
040 * <pre>
041 * Control ::= SEQUENCE {
042 *     ...
043 *     controlValue OCTET STRING OPTIONAL }
044 * </pre>
045 *
046 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
047 */
048public class StoreControlValue extends GrammarAction<ControlsContainer>
049{
050    /** The logger */
051    private static final Logger LOG = LoggerFactory.getLogger( StoreControlValue.class );
052
053    /**
054     * Instantiates a new StoreControlValue action.
055     */
056    public StoreControlValue()
057    {
058        super( "Store the control value" );
059    }
060
061
062    /**
063     * {@inheritDoc}
064     */
065    @Override
066    public void action( ControlsContainer container ) throws DecoderException
067    {
068        TLV tlv = container.getCurrentTLV();
069
070        Control control = container.getCurrentControl();
071        ControlFactory<?> controlFactory = container.getFactory();
072
073        // Get the current control
074        BerValue value = tlv.getValue();
075
076        // Store the value - have to handle the special case of a 0 length value
077        try
078        {
079            if ( tlv.getLength() == 0 )
080            {
081                controlFactory.decodeValue( control, Strings.EMPTY_BYTES );
082            }
083            else
084            {
085                controlFactory.decodeValue( control, value.getData() );
086            }
087        }
088        catch ( DecoderException de )
089        {
090            String message = I18n.err( I18n.ERR_08109_BAD_CONTROL_VALUE, 
091                Strings.dumpBytes( value.getData() ) );
092            LOG.error( message );
093
094            // This will generate a PROTOCOL_ERROR
095            throw new DecoderException( message, de );
096            
097        }
098
099        // We can have an END transition
100        container.setGrammarEndAllowed( true );
101
102        if ( LOG.isDebugEnabled() )
103        {
104            LOG.debug( I18n.msg( I18n.MSG_08203_CONTROL_VALUE, Strings.dumpBytes( value.getData() ) ) );
105        }
106    }
107}