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.TLV;
027import org.apache.directory.api.ldap.codec.api.CodecControl;
028import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
029import org.apache.directory.api.ldap.codec.api.MessageDecorator;
030import org.apache.directory.api.ldap.model.message.Control;
031import org.apache.directory.api.ldap.model.message.Message;
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 value of a control. This is an extension point
039 * where different controls can be plugged in (at least eventually). For now we
040 * hard code controls.
041 * <pre>
042 * Control ::= SEQUENCE {
043 *     ...
044 *     controlValue OCTET STRING OPTIONAL }
045 * </pre>
046 *
047 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
048 */
049public class StoreControlValue extends GrammarAction<LdapMessageContainer<MessageDecorator<? extends Message>>>
050{
051    /** The logger */
052    private static final Logger LOG = LoggerFactory.getLogger( StoreControlValue.class );
053
054    /** Speedup for logs */
055    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
056
057
058    /**
059     * Instantiates a new StoreControlValue action.
060     */
061    public StoreControlValue()
062    {
063        super( "Store the control value" );
064    }
065
066
067    /**
068     * {@inheritDoc}
069     */
070    public void action( LdapMessageContainer<MessageDecorator<? extends Message>> container ) throws DecoderException
071    {
072        TLV tlv = container.getCurrentTLV();
073
074        MessageDecorator<?> message = container.getMessage();
075        CodecControl<? extends Control> control = message.getCurrentControl();
076
077        // Get the current control
078        BerValue value = tlv.getValue();
079
080        // Store the value - have to handle the special case of a 0 length value
081        if ( tlv.getLength() == 0 )
082        {
083            control.setValue( Strings.EMPTY_BYTES );
084        }
085        else
086        {
087            control.setValue( value.getData() );
088            control.decode( value.getData() );
089        }
090
091        // We can have an END transition
092        container.setGrammarEndAllowed( true );
093
094        if ( IS_DEBUG )
095        {
096            LOG.debug( "Control value : " + Strings.dumpBytes( control.getValue() ) );
097        }
098    }
099}