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.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.ldap.model.message.controls.OpaqueControl;
033import org.apache.directory.api.util.Strings;
034import org.slf4j.Logger;
035import org.slf4j.LoggerFactory;
036
037
038/**
039 * The action used to set the value of a control. This is an extension point
040 * where different controls can be plugged in (at least eventually). For now we
041 * hard code controls.
042 * <pre>
043 * Control ::= SEQUENCE {
044 *     ...
045 *     controlValue OCTET STRING OPTIONAL }
046 * </pre>
047 *
048 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
049 */
050public class StoreControlValue extends GrammarAction<LdapMessageContainer<Message>>
051{
052    /** The logger */
053    private static final Logger LOG = LoggerFactory.getLogger( StoreControlValue.class );
054
055
056    /**
057     * Instantiates a new StoreControlValue action.
058     */
059    public StoreControlValue()
060    {
061        super( "Store the control value" );
062    }
063
064
065    /**
066     * {@inheritDoc}
067     */
068    @Override
069    public void action( LdapMessageContainer<Message> container ) throws DecoderException
070    {
071        TLV tlv = container.getCurrentTLV();
072
073        Control control = container.getCurrentControl();
074
075        // Get the current control
076        BerValue value = tlv.getValue();
077
078        // Store the value - have to handle the special case of a 0 length value
079        if ( tlv.getLength() >= 0 )
080        {
081            ControlFactory<?> factory = container.getControlFactory();
082           
083            if ( factory == null )
084            {
085                // We don't know about this control, so it's an opaque control 
086                ( ( OpaqueControl ) control ).setEncodedValue( value.getData() );
087            }
088            else
089            {
090                factory.decodeValue( control, value.getData() );
091            }
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_08203_CONTROL_VALUE, Strings.dumpBytes( value.getData() ) ) );
100        }
101    }
102}