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