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