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.request.search.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.search.ExtensibleMatchFilter;
32  import org.apache.directory.api.ldap.model.message.SearchRequest;
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<SearchRequest>>
52  {
53      /** The logger */
54      private static final Logger LOG = LoggerFactory.getLogger( StoreMatchingRuleDnAttributes.class );
55  
56      /**
57       * Instantiates a new StoreMatchingRuleDnAttributes.
58       */
59      public StoreMatchingRuleDnAttributes()
60      {
61          super( "Store matchingRuleAssertion dnAttributes" );
62      }
63  
64  
65      public void action( LdapMessageContainer<SearchRequest> container ) throws DecoderException
66      {
67          TLV tlv = container.getCurrentTLV();
68  
69          // Store the value.
70          ExtensibleMatchFilter extensibleMatchFilter = ( ExtensibleMatchFilter ) container.getTerminalFilter();
71  
72          // We get the value. If it's a 0, it's a FALSE. If it's
73          // a FF, it's a TRUE. Any other value should be an error,
74          // but we could relax this constraint. So if we have
75          // something
76          // which is not 0, it will be interpreted as TRUE, but we
77          // will generate a warning.
78          BerValue value = tlv.getValue();
79  
80          try
81          {
82              extensibleMatchFilter.setDnAttributes( BooleanDecoder.parse( value ) );
83          }
84          catch ( BooleanDecoderException bde )
85          {
86              LOG.error( I18n
87                  .err( I18n.ERR_13014_DN_ATTR_FLAG_INVALID, Strings.dumpBytes( value.getData() ), bde.getMessage() ) );
88  
89              throw new DecoderException( bde.getMessage(), bde );
90          }
91  
92          if ( LOG.isDebugEnabled() )
93          {
94              LOG.debug( I18n.msg( I18n.MSG_05155_DN_ATTRIBUTES, Boolean.valueOf( extensibleMatchFilter.isDnAttributes() ) ) );
95          }
96  
97          // unstack the filters if needed
98          container.unstackFilters();
99      }
100 }