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.TLV; 026import org.apache.directory.api.ldap.codec.api.LdapMessageContainer; 027import org.apache.directory.api.ldap.codec.api.MessageDecorator; 028import org.apache.directory.api.ldap.model.message.Message; 029import org.slf4j.Logger; 030import org.slf4j.LoggerFactory; 031 032 033/** 034 * The action used to initialize a control. 035 * <pre> 036 * ... }, 037 * controls [0] Controls OPTIONAL } 038 * </pre> 039 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 040 */ 041public class InitControls extends GrammarAction<LdapMessageContainer<MessageDecorator<? extends Message>>> 042{ 043 /** The logger */ 044 private static final Logger LOG = LoggerFactory.getLogger( InitControls.class ); 045 046 /** Speedup for logs */ 047 private static final boolean IS_DEBUG = LOG.isDebugEnabled(); 048 049 050 /** 051 * Instantiates a new controls init action. 052 */ 053 public InitControls() 054 { 055 super( "Initialize a control" ); 056 } 057 058 059 /** 060 * {@inheritDoc} 061 */ 062 public void action( LdapMessageContainer<MessageDecorator<? extends Message>> container ) throws DecoderException 063 { 064 TLV tlv = container.getCurrentTLV(); 065 int expectedLength = tlv.getLength(); 066 067 // The Length should be null 068 if ( expectedLength == 0 ) 069 { 070 LOG.error( "The length of controls must not be null" ); 071 072 // This will generate a PROTOCOL_ERROR 073 throw new DecoderException( "The length of controls must not be null" ); 074 } 075 076 if ( IS_DEBUG ) 077 { 078 LOG.debug( "A new list of controls has been initialized" ); 079 } 080 } 081}