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 *
39 * Controls ::= SEQUENCE OF control Control
40 * </pre>
41 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
42 */
43 public class InitControls extends GrammarAction<LdapMessageContainer<MessageDecorator<? extends Message>>>
44 {
45 /** The logger */
46 private static final Logger LOG = LoggerFactory.getLogger( InitControls.class );
47
48 /** Speedup for logs */
49 private static final boolean IS_DEBUG = LOG.isDebugEnabled();
50
51
52 /**
53 * Instantiates a new controls init action.
54 */
55 public InitControls()
56 {
57 super( "Initialize a control" );
58 }
59
60
61 /**
62 * {@inheritDoc}
63 */
64 public void action( LdapMessageContainer<MessageDecorator<? extends Message>> container ) throws DecoderException
65 {
66 TLV tlv = container.getCurrentTLV();
67 int expectedLength = tlv.getLength();
68
69 // The Length can be null
70 if ( expectedLength != 0 )
71 {
72 if ( IS_DEBUG )
73 {
74 LOG.debug( "A new list of controls has been initialized" );
75 }
76 }
77 else
78 {
79 if ( IS_DEBUG )
80 {
81 LOG.debug( "An empty list of controls has been initialized" );
82 }
83 }
84
85 // We can have an END transition
86 container.setGrammarEndAllowed( true );
87 }
88 }