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.i18n.I18n;
028import org.apache.directory.api.ldap.codec.api.ControlFactory;
029import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
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<Message>>
050{
051    /** The logger */
052    private static final Logger LOG = LoggerFactory.getLogger( StoreControlValue.class );
053
054
055    /**
056     * Instantiates a new StoreControlValue action.
057     */
058    public StoreControlValue()
059    {
060        super( "Store the control value" );
061    }
062
063
064    /**
065     * {@inheritDoc}
066     */
067    @Override
068    public void action( LdapMessageContainer<Message> container ) throws DecoderException
069    {
070        TLV tlv = container.getCurrentTLV();
071
072        Control control = container.getCurrentControl();
073
074        // Get the current control
075        BerValue value = tlv.getValue();
076
077        // Store the value - have to handle the special case of a 0 length value
078        if ( tlv.getLength() >= 0 )
079        {
080            ControlFactory<?> factory = container.getControlFactory();
081            factory.decodeValue( control, value.getData() );
082        }
083
084        // We can have an END transition
085        container.setGrammarEndAllowed( true );
086
087        if ( LOG.isDebugEnabled() )
088        {
089            LOG.debug( I18n.msg( I18n.MSG_08203_CONTROL_VALUE, Strings.dumpBytes( value.getData() ) ) );
090        }
091    }
092}