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.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.search.SubstringFilter;
29  import org.apache.directory.api.ldap.model.message.SearchRequest;
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 final value into a substring filter
37   * <pre>
38   * SubstringFilter ::= SEQUENCE {
39   *     ...
40   *     substrings SEQUENCE OF CHOICE {
41   *         ...
42   *         final  [2] LDAPSTRING }
43   * </pre>
44  
45   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
46   */
47  public class StoreFinal extends GrammarAction<LdapMessageContainer<SearchRequest>>
48  {
49      /** The logger */
50      private static final Logger LOG = LoggerFactory.getLogger( StoreFinal.class );
51  
52      /**
53       * Instantiates a new store final action.
54       */
55      public StoreFinal()
56      {
57          super( "Store a final value" );
58      }
59  
60  
61      /**
62       * {@inheritDoc}
63       */
64      public void action( LdapMessageContainer<SearchRequest> container ) throws DecoderException
65      {
66          TLV tlv = container.getCurrentTLV();
67  
68          // Store the value.
69          SubstringFilter substringFilter = ( SubstringFilter ) container.getTerminalFilter();
70  
71          if ( tlv.getLength() == 0 )
72          {
73              String msg = I18n.err( I18n.ERR_05140_EMPTY_SUBSTRING_FINAL_FILTER_PDU );
74              LOG.error( msg );
75              throw new DecoderException( msg );
76          }
77  
78          String finalValue = Strings.utf8ToString( tlv.getValue().getData() );
79          substringFilter.setFinalSubstrings( finalValue );
80  
81          // We now have to get back to the nearest filter which is
82          // not terminal.
83          container.unstackFilters();
84  
85          if ( LOG.isDebugEnabled() )
86          {
87              LOG.debug( I18n.msg( I18n.MSG_05154_STORED_FINAL_SUBSTRING, finalValue ) );
88          }
89      }
90  }