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;
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.ldap.codec.api.LdapMessageContainer;
26  import org.apache.directory.api.ldap.codec.decorators.SearchRequestDecorator;
27  import org.apache.directory.api.ldap.model.message.SearchRequest;
28  import org.slf4j.Logger;
29  import org.slf4j.LoggerFactory;
30  
31  
32  /**
33   * The action used to initialize the AttributeDesc list
34   * <pre>
35   * SearchRequest ::= [APPLICATION 3] SEQUENCE {
36   *     ...
37   *     filter      Filter,
38   *     attributes  AttributeDescriptionList }
39   *
40   * AttributeDescriptionList ::= SEQUENCE OF
41   *     AttributeDescription
42   * </pre>
43   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
44   */
45  public class InitSearchRequestAttributeDescList extends GrammarAction<LdapMessageContainer<SearchRequestDecorator>>
46  {
47      /** The logger */
48      private static final Logger LOG = LoggerFactory.getLogger( InitSearchRequestAttributeDescList.class );
49  
50      /** Speedup for logs */
51      private static final boolean IS_DEBUG = LOG.isDebugEnabled();
52  
53  
54      /**
55       * Instantiates a new init attribute desc list action.
56       */
57      public InitSearchRequestAttributeDescList()
58      {
59          super( "Initialize AttributeDesc list" );
60      }
61  
62  
63      /**
64       * {@inheritDoc}
65       */
66      public void action( LdapMessageContainer<SearchRequestDecorator> container ) throws DecoderException
67      {
68          // Here, we have to inject the decoded filter into the SearchRequest
69          SearchRequestDecorator searchRequestDecorator = container.getMessage();
70          SearchRequest searchRequest = searchRequestDecorator.getDecorated();
71  
72          searchRequest.setFilter( searchRequestDecorator.getFilterNode() );
73  
74          // We can have an END transition
75          container.setGrammarEndAllowed( true );
76  
77          if ( IS_DEBUG )
78          {
79              LOG.debug( "Initialize AttributeDesc list" );
80          }
81      }
82  }