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.api.ldap.codec.actions.request.search;
021
022
023import org.apache.directory.api.asn1.DecoderException;
024import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
025import org.apache.directory.api.asn1.ber.tlv.BerValue;
026import org.apache.directory.api.asn1.ber.tlv.IntegerDecoder;
027import org.apache.directory.api.asn1.ber.tlv.IntegerDecoderException;
028import org.apache.directory.api.asn1.ber.tlv.TLV;
029import org.apache.directory.api.i18n.I18n;
030import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
031import org.apache.directory.api.ldap.model.message.SearchRequest;
032import org.slf4j.Logger;
033import org.slf4j.LoggerFactory;
034
035
036/**
037 * The action used to store the SearchRequest timeLimit
038 * <pre>
039 * SearchRequest ::= [APPLICATION 3] SEQUENCE {
040 *     ...
041 *     timeLimit INTEGER (0 .. maxInt),
042 *     ...
043 * </pre>
044 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
045 */
046public class StoreSearchRequestTimeLimit extends GrammarAction<LdapMessageContainer<SearchRequest>>
047{
048    /** The logger */
049    private static final Logger LOG = LoggerFactory.getLogger( StoreSearchRequestTimeLimit.class );
050
051    /**
052     * Instantiates a new action.
053     */
054    public StoreSearchRequestTimeLimit()
055    {
056        super( "Store SearchRequest timeLimit" );
057    }
058
059
060    /**
061     * {@inheritDoc}
062     */
063    public void action( LdapMessageContainer<SearchRequest> container ) throws DecoderException
064    {
065        SearchRequest searchRequest = container.getMessage();
066
067        TLV tlv = container.getCurrentTLV();
068
069        // The current TLV should be a integer
070        // We get it and store it in timeLimit
071        BerValue value = tlv.getValue();
072
073        try
074        {
075            int timeLimit = IntegerDecoder.parse( value, 0, Integer.MAX_VALUE );
076            searchRequest.setTimeLimit( timeLimit );
077        }
078        catch ( IntegerDecoderException ide )
079        {
080            String msg = I18n.err( I18n.ERR_05152_BAD_TIME_LIMIT, value.toString() );
081            LOG.error( msg );
082            throw new DecoderException( msg, ide );
083        }
084
085        if ( LOG.isDebugEnabled() )
086        {
087            LOG.debug( I18n.msg( I18n.MSG_05164_TIME_LIMIT_SET_TO, searchRequest.getTimeLimit() ) );
088        }
089    }
090}