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.asn1.ber.tlv.BerValue;
26  import org.apache.directory.api.asn1.ber.tlv.IntegerDecoder;
27  import org.apache.directory.api.asn1.ber.tlv.IntegerDecoderException;
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.model.message.SearchRequest;
33  import org.slf4j.Logger;
34  import org.slf4j.LoggerFactory;
35  
36  
37  /**
38   * The action used to store the SearchRequest timeLimit
39   * <pre>
40   * SearchRequest ::= [APPLICATION 3] SEQUENCE {
41   *     ...
42   *     timeLimit INTEGER (0 .. maxInt),
43   *     ...
44   * </pre>
45   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
46   */
47  public class StoreSearchRequestTimeLimit extends GrammarAction<LdapMessageContainer<SearchRequestDecorator>>
48  {
49      /** The logger */
50      private static final Logger LOG = LoggerFactory.getLogger( StoreSearchRequestTimeLimit.class );
51  
52      /** Speedup for logs */
53      private static final boolean IS_DEBUG = LOG.isDebugEnabled();
54  
55  
56      /**
57       * Instantiates a new action.
58       */
59      public StoreSearchRequestTimeLimit()
60      {
61          super( "Store SearchRequest timeLimit" );
62      }
63  
64  
65      /**
66       * {@inheritDoc}
67       */
68      public void action( LdapMessageContainer<SearchRequestDecorator> container ) throws DecoderException
69      {
70          SearchRequest searchRequest = container.getMessage().getDecorated();
71  
72          TLV tlv = container.getCurrentTLV();
73  
74          // The current TLV should be a integer
75          // We get it and store it in timeLimit
76          BerValue value = tlv.getValue();
77  
78          int timeLimit = 0;
79  
80          try
81          {
82              timeLimit = IntegerDecoder.parse( value, 0, Integer.MAX_VALUE );
83          }
84          catch ( IntegerDecoderException ide )
85          {
86              String msg = I18n.err( I18n.ERR_04104, value.toString() );
87              LOG.error( msg );
88              throw new DecoderException( msg );
89          }
90  
91          searchRequest.setTimeLimit( timeLimit );
92  
93          if ( IS_DEBUG )
94          {
95              LOG.debug( "The timeLimit value is set to {} seconds", Integer.valueOf( timeLimit ) );
96          }
97      }
98  }