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 *    https://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.BooleanDecoder;
027import org.apache.directory.api.asn1.ber.tlv.BooleanDecoderException;
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.apache.directory.api.util.Strings;
033import org.slf4j.Logger;
034import org.slf4j.LoggerFactory;
035
036
037/**
038 * The action used to store the SearchRequest typesOnly flag
039 * <pre>
040 * SearchRequest ::= [APPLICATION 3] SEQUENCE {
041 *     ...
042 *     typesOnly BOOLEAN,
043 *     ...
044 * </pre>
045 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
046 */
047public class StoreSearchRequestTypesOnly extends GrammarAction<LdapMessageContainer<SearchRequest>>
048{
049    /** The logger */
050    private static final Logger LOG = LoggerFactory.getLogger( StoreSearchRequestTypesOnly.class );
051
052    /**
053     * Instantiates a new action.
054     */
055    public StoreSearchRequestTypesOnly()
056    {
057        super( "Store SearchRequest typesOnly flag" );
058    }
059
060
061    /**
062     * {@inheritDoc}
063     */
064    public void action( LdapMessageContainer<SearchRequest> container ) throws DecoderException
065    {
066        SearchRequest searchRequest = container.getMessage();
067
068        TLV tlv = container.getCurrentTLV();
069
070        // We get the value. If it's a 0, it's a FALSE. If it's
071        // a FF, it's a TRUE. Any other value should be an error,
072        // but we could relax this constraint. So if we have
073        // something
074        // which is not 0, it will be interpreted as TRUE, but we
075        // will generate a warning.
076        BerValue value = tlv.getValue();
077
078        try
079        {
080            searchRequest.setTypesOnly( BooleanDecoder.parse( value ) );
081        }
082        catch ( BooleanDecoderException bde )
083        {
084            LOG.error( I18n
085                .err( I18n.ERR_05155_FLAG_TYPE_INVALID, Strings.dumpBytes( value.getData() ), bde.getMessage() ) );
086
087            throw new DecoderException( bde.getMessage(), bde );
088        }
089
090        if ( LOG.isDebugEnabled() )
091        {
092            LOG.debug( I18n.msg( I18n.MSG_05165_SEARCH_RETURN_TYPE_ONLY ) );
093        }
094    }
095}