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.searchRequest.filter;
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.decorators.SearchRequestDecorator;
32  import org.apache.directory.api.ldap.codec.search.ExtensibleMatchFilter;
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 store a matchingRuleAssertion dnAttributes
40   * <pre>
41   * Filter ::= CHOICE {
42   *     ...
43   *     extensibleMatch  [9] MatchingRuleAssertion }
44   *
45   * MatchingRuleAssertion ::= SEQUENCE {
46   *     ...
47   *     dnAttributes [4] BOOLEAN DEFAULT FALSE }
48   * </pre>
49   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
50   */
51  public class StoreMatchingRuleDnAttributes extends GrammarAction<LdapMessageContainer<SearchRequestDecorator>>
52  {
53      /** The logger */
54      private static final Logger LOG = LoggerFactory.getLogger( StoreMatchingRuleDnAttributes.class );
55  
56      /** Speedup for logs */
57      private static final boolean IS_DEBUG = LOG.isDebugEnabled();
58  
59  
60      /**
61       * Instantiates a new StoreMatchingRuleDnAttributes.
62       */
63      public StoreMatchingRuleDnAttributes()
64      {
65          super( "Store matchingRuleAssertion dnAttributes" );
66      }
67  
68  
69      public void action( LdapMessageContainer<SearchRequestDecorator> container ) throws DecoderException
70      {
71          SearchRequestDecorator searchRequest = container.getMessage();
72  
73          TLV tlv = container.getCurrentTLV();
74  
75          // Store the value.
76          ExtensibleMatchFilter extensibleMatchFilter = ( ExtensibleMatchFilter ) searchRequest.getTerminalFilter();
77  
78          // We get the value. If it's a 0, it's a FALSE. If it's
79          // a FF, it's a TRUE. Any other value should be an error,
80          // but we could relax this constraint. So if we have
81          // something
82          // which is not 0, it will be interpreted as TRUE, but we
83          // will generate a warning.
84          BerValue value = tlv.getValue();
85  
86          try
87          {
88              extensibleMatchFilter.setDnAttributes( BooleanDecoder.parse( value ) );
89          }
90          catch ( BooleanDecoderException bde )
91          {
92              LOG.error( I18n
93                  .err( I18n.ERR_04110, Strings.dumpBytes( value.getData() ), bde.getMessage() ) );
94  
95              throw new DecoderException( bde.getMessage() );
96          }
97  
98          if ( IS_DEBUG )
99          {
100             LOG.debug( "Dn Attributes : {}", Boolean.valueOf( extensibleMatchFilter.isDnAttributes() ) );
101         }
102 
103         // unstack the filters if needed
104         searchRequest.unstackFilters( container );
105     }
106 }