View Javadoc
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   *    https://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.ber.grammar.GrammarAction;
24  import org.apache.directory.api.asn1.ber.tlv.TLV;
25  import org.apache.directory.api.i18n.I18n;
26  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
27  import org.apache.directory.api.ldap.model.message.Message;
28  import org.slf4j.Logger;
29  import org.slf4j.LoggerFactory;
30  
31  
32  /**
33   * The action used to initialise the controls.
34   * <pre>
35   *         ... },
36   *     controls       [0] Controls OPTIONAL }
37   *     
38   * Controls ::= SEQUENCE OF control Control
39  
40   * </pre>
41   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
42   */
43  public class InitControls extends GrammarAction<LdapMessageContainer<Message>>
44  {
45      /** The logger */
46      private static final Logger LOG = LoggerFactory.getLogger( InitControls.class );
47  
48      /**
49       * Instantiates a new controls init action.
50       */
51      public InitControls()
52      {
53          super( "Initialize a control" );
54      }
55  
56  
57      /**
58       * {@inheritDoc}
59       */
60      @Override
61      public void action( LdapMessageContainer<Message> container )
62      {
63          TLV tlv = container.getCurrentTLV();
64          int expectedLength = tlv.getLength();
65  
66          // The Length can be null
67          if ( expectedLength != 0 )
68          {
69              if ( LOG.isDebugEnabled() )
70              {
71                  LOG.debug( I18n.msg( I18n.MSG_05100_NEW_LIST_CONTROLS_INITIALIZED ) );
72              }
73          }
74          else
75          {
76              if ( LOG.isDebugEnabled() )
77              {
78                  LOG.debug( I18n.msg( I18n.MSG_05101_NEW_EMPTY_CONTROLS_INITIALIZED ) );
79              }
80          }
81  
82          // We can have an END transition
83          container.setGrammarEndAllowed( true );
84      }
85  }