001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 *
019 */
020package org.apache.directory.shared.ldap.codec.actions.searchRequest;
021
022
023import org.apache.directory.shared.asn1.DecoderException;
024import org.apache.directory.shared.asn1.ber.grammar.GrammarAction;
025import org.apache.directory.shared.asn1.ber.tlv.LongDecoder;
026import org.apache.directory.shared.asn1.ber.tlv.LongDecoderException;
027import org.apache.directory.shared.asn1.ber.tlv.TLV;
028import org.apache.directory.shared.asn1.ber.tlv.Value;
029import org.apache.directory.shared.i18n.I18n;
030import org.apache.directory.shared.ldap.codec.api.LdapMessageContainer;
031import org.apache.directory.shared.ldap.codec.decorators.SearchRequestDecorator;
032import org.apache.directory.shared.ldap.model.message.SearchRequest;
033import org.slf4j.Logger;
034import org.slf4j.LoggerFactory;
035
036
037/**
038 * The action used to store the SearchRequest sizeLimit
039 * <pre>
040 * SearchRequest ::= [APPLICATION 3] SEQUENCE {
041 *     ...
042 *     sizeLimit INTEGER (0 .. maxInt),
043 *     ...
044 * </pre>
045 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
046 */
047public class StoreSearchRequestSizeLimit extends GrammarAction<LdapMessageContainer<SearchRequestDecorator>>
048{
049    /** The logger */
050    private static final Logger LOG = LoggerFactory.getLogger( StoreSearchRequestSizeLimit.class );
051
052    /** Speedup for logs */
053    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
054
055    /**
056     * Instantiates a new action.
057     */
058    public StoreSearchRequestSizeLimit()
059    {
060        super( "Store SearchRequest sizeLimit" );
061    }
062
063
064    /**
065     * {@inheritDoc}
066     */
067    public void action( LdapMessageContainer<SearchRequestDecorator> container ) throws DecoderException
068    {
069        SearchRequest searchRequest = container.getMessage().getDecorated();
070
071        TLV tlv = container.getCurrentTLV();
072
073        // The current TLV should be a integer
074        // We get it and store it in sizeLimit
075        Value value = tlv.getValue();
076        long sizeLimit = 0;
077
078        try
079        {
080            sizeLimit = LongDecoder.parse( value, 0, Integer.MAX_VALUE );
081        }
082        catch ( LongDecoderException lde )
083        {
084            String msg = I18n.err( I18n.ERR_04103, value.toString() );
085            LOG.error( msg );
086            throw new DecoderException( msg );
087        }
088
089        searchRequest.setSizeLimit( sizeLimit );
090
091        if ( IS_DEBUG )
092        {
093            LOG.debug( "The sizeLimit value is set to {} objects", Long.valueOf( sizeLimit ) );
094        }
095    }
096}