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.TLV;
26  import org.apache.directory.api.i18n.I18n;
27  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
28  import org.apache.directory.api.ldap.codec.decorators.SearchRequestDecorator;
29  import org.apache.directory.api.ldap.codec.search.SubstringFilter;
30  import org.apache.directory.api.util.Strings;
31  import org.slf4j.Logger;
32  import org.slf4j.LoggerFactory;
33  
34  
35  /**
36   * The action used to store a any value into a substring filter
37   * <pre>
38   * SubstringFilter ::= SEQUENCE {
39   *     ...
40   *     substrings SEQUENCE OF CHOICE {
41   *         ...
42   *         any  [1] LDAPSTRING,
43   *         ...
44   * </pre>
45   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
46   */
47  public class StoreAny extends GrammarAction<LdapMessageContainer<SearchRequestDecorator>>
48  {
49      /** The logger */
50      private static final Logger LOG = LoggerFactory.getLogger( StoreAny.class );
51  
52      /** Speedup for logs */
53      private static final boolean IS_DEBUG = LOG.isDebugEnabled();
54  
55  
56      /**
57       * Instantiates a new store any action.
58       */
59      public StoreAny()
60      {
61          super( "Store a any value" );
62      }
63  
64  
65      /**
66       * {@inheritDoc}
67       */
68      public void action( LdapMessageContainer<SearchRequestDecorator> container ) throws DecoderException
69      {
70          SearchRequestDecorator decorator = container.getMessage();
71  
72          TLV tlv = container.getCurrentTLV();
73  
74          // Store the value.
75          SubstringFilter substringFilter = ( SubstringFilter ) decorator.getTerminalFilter();
76  
77          if ( tlv.getLength() == 0 )
78          {
79              String msg = I18n.err( I18n.ERR_04019 );
80              LOG.error( msg );
81              throw new DecoderException( msg );
82          }
83  
84          String any = Strings.utf8ToString( tlv.getValue().getData() );
85          substringFilter.addAnySubstrings( any );
86  
87          // We now have to get back to the nearest filter which is
88          // not terminal.
89          decorator.unstackFilters( container );
90  
91          if ( IS_DEBUG )
92          {
93              LOG.debug( "Stored a any substring : {}", any );
94          }
95      }
96  }