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