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.ber.grammar.GrammarAction;
024import org.apache.directory.api.asn1.ber.tlv.TLV;
025import org.apache.directory.api.i18n.I18n;
026import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
027import org.apache.directory.api.ldap.model.message.Message;
028import org.slf4j.Logger;
029import org.slf4j.LoggerFactory;
030
031
032/**
033 * The action used to initialise the controls.
034 * <pre>
035 *         ... },
036 *     controls       [0] Controls OPTIONAL }
037 *     
038 * Controls ::= SEQUENCE OF control Control
039
040 * </pre>
041 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
042 */
043public class InitControls extends GrammarAction<LdapMessageContainer<Message>>
044{
045    /** The logger */
046    private static final Logger LOG = LoggerFactory.getLogger( InitControls.class );
047
048    /**
049     * Instantiates a new controls init action.
050     */
051    public InitControls()
052    {
053        super( "Initialize a control" );
054    }
055
056
057    /**
058     * {@inheritDoc}
059     */
060    @Override
061    public void action( LdapMessageContainer<Message> container )
062    {
063        TLV tlv = container.getCurrentTLV();
064        int expectedLength = tlv.getLength();
065
066        // The Length can be null
067        if ( expectedLength != 0 )
068        {
069            if ( LOG.isDebugEnabled() )
070            {
071                LOG.debug( I18n.msg( I18n.MSG_05100_NEW_LIST_CONTROLS_INITIALIZED ) );
072            }
073        }
074        else
075        {
076            if ( LOG.isDebugEnabled() )
077            {
078                LOG.debug( I18n.msg( I18n.MSG_05101_NEW_EMPTY_CONTROLS_INITIALIZED ) );
079            }
080        }
081
082        // We can have an END transition
083        container.setGrammarEndAllowed( true );
084    }
085}