1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.ldap.codec.actions.controls;
21
22
23 import org.apache.directory.api.asn1.DecoderException;
24 import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
25 import org.apache.directory.api.asn1.ber.tlv.TLV;
26 import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
27 import org.apache.directory.api.ldap.codec.api.MessageDecorator;
28 import org.apache.directory.api.ldap.model.message.Message;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
31
32
33 /**
34 * The action used to initialize a control.
35 * <pre>
36 * ... },
37 * controls [0] Controls OPTIONAL }
38 * </pre>
39 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
40 */
41 public class InitControls extends GrammarAction<LdapMessageContainer<MessageDecorator<? extends Message>>>
42 {
43 /** The logger */
44 private static final Logger LOG = LoggerFactory.getLogger( InitControls.class );
45
46 /** Speedup for logs */
47 private static final boolean IS_DEBUG = LOG.isDebugEnabled();
48
49
50 /**
51 * Instantiates a new controls init action.
52 */
53 public InitControls()
54 {
55 super( "Initialize a control" );
56 }
57
58
59 /**
60 * {@inheritDoc}
61 */
62 public void action( LdapMessageContainer<MessageDecorator<? extends Message>> container ) throws DecoderException
63 {
64 TLV tlv = container.getCurrentTLV();
65 int expectedLength = tlv.getLength();
66
67 // The Length should be null
68 if ( expectedLength == 0 )
69 {
70 LOG.error( "The length of controls must not be null" );
71
72 // This will generate a PROTOCOL_ERROR
73 throw new DecoderException( "The length of controls must not be null" );
74 }
75
76 if ( IS_DEBUG )
77 {
78 LOG.debug( "A new list of controls has been initialized" );
79 }
80 }
81 }