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     */
020    package org.apache.directory.shared.ldap.codec.actions;
021    
022    
023    import org.apache.directory.shared.asn1.ber.IAsn1Container;
024    import org.apache.directory.shared.asn1.ber.grammar.GrammarAction;
025    import org.apache.directory.shared.asn1.ber.tlv.TLV;
026    import org.apache.directory.shared.asn1.codec.DecoderException;
027    import org.apache.directory.shared.ldap.codec.LdapMessageCodec;
028    import org.apache.directory.shared.ldap.codec.LdapMessageContainer;
029    
030    import org.slf4j.Logger;
031    import org.slf4j.LoggerFactory;
032    
033    
034    /**
035     * The action used to initialize a control.
036     * 
037     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
038     * @version $Rev$, $Date$, 
039     */
040    public class ControlsInitAction extends GrammarAction
041    {
042        /** The logger */
043        private static final Logger log = LoggerFactory.getLogger( ControlsInitAction.class );
044    
045        /** Speedup for logs */
046        private static final boolean IS_DEBUG = log.isDebugEnabled();
047    
048        public ControlsInitAction()
049        {
050            super( "Initialize a control" );
051        }
052    
053        /**
054         * The initialization action
055         */
056        public void action( IAsn1Container container ) throws DecoderException
057        {
058    
059            LdapMessageContainer ldapMessageContainer = ( LdapMessageContainer ) container;
060            LdapMessageCodec message = ldapMessageContainer.getLdapMessage();
061    
062            TLV tlv = ldapMessageContainer.getCurrentTLV();
063            int expectedLength = tlv.getLength();
064    
065            // The Length should be null
066            if ( expectedLength == 0 )
067            {
068                log.error( "The length of controls must not be null" );
069                
070                // This will generate a PROTOCOL_ERROR
071                throw new DecoderException( "The length of controls must not be null" );
072            }
073            
074            if ( IS_DEBUG )
075            {
076                log.debug( "A new list of controls has been initialized" );
077            }
078            
079            // We can initialize the controls array
080            message.initControls();
081        }
082    }