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.DecoderException;
24  import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
25  import org.apache.directory.api.asn1.ber.tlv.BerValue;
26  import org.apache.directory.api.asn1.ber.tlv.BooleanDecoder;
27  import org.apache.directory.api.asn1.ber.tlv.BooleanDecoderException;
28  import org.apache.directory.api.asn1.ber.tlv.TLV;
29  import org.apache.directory.api.i18n.I18n;
30  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
31  import org.apache.directory.api.ldap.model.message.Control;
32  import org.apache.directory.api.ldap.model.message.Message;
33  import org.apache.directory.api.util.Strings;
34  import org.slf4j.Logger;
35  import org.slf4j.LoggerFactory;
36  
37  
38  /**
39   * The action used to set the control criticality flag
40   * <pre>
41   * Control ::= SEQUENCE {
42   *     ...
43   *     criticality BOOLEAN DEFAULT FALSE,
44   *     ...
45   * </pre>
46   *
47   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
48   */
49  public class StoreControlCriticality extends GrammarAction<LdapMessageContainer<Message>>
50  {
51      /** The logger */
52      private static final Logger LOG = LoggerFactory.getLogger( StoreControlCriticality.class );
53  
54      /**
55       * Instantiates a new StoreControlCriticality action.
56       */
57      public StoreControlCriticality()
58      {
59          super( "Store the control criticality" );
60      }
61  
62  
63      /**
64       * {@inheritDoc}
65       */
66      @Override
67      public void action( LdapMessageContainer<Message> container ) throws DecoderException
68      {
69          TLV tlv = container.getCurrentTLV();
70  
71          // Get the current control
72          Control control = container.getCurrentControl();
73  
74          // Store the criticality
75          // We get the value. If it's a 0, it's a FALSE. If it's
76          // a FF, it's a TRUE. Any other value should be an error,
77          // but we could relax this constraint. So if we have
78          // something
79          // which is not 0, it will be interpreted as TRUE, but we
80          // will generate a warning.
81          BerValue value = tlv.getValue();
82  
83          try
84          {
85              control.setCritical( BooleanDecoder.parse( value ) );
86          }
87          catch ( BooleanDecoderException bde )
88          {
89              LOG.error( I18n
90                  .err( I18n.ERR_08103_BAD_CONTROL_CRITICALITY, Strings.dumpBytes( value.getData() ), bde.getMessage() ) );
91  
92              // This will generate a PROTOCOL_ERROR
93              throw new DecoderException( bde.getMessage(), bde );
94          }
95  
96          // We can have an END transition
97          container.setGrammarEndAllowed( true );
98  
99          if ( LOG.isDebugEnabled() )
100         {
101             LOG.debug( I18n.msg( I18n.MSG_08202_CONTROL_CRITICALITY, control.isCritical() ) );
102         }
103     }
104 }