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.ldap.codec.api.LdapMessageContainer;
026import org.apache.directory.shared.ldap.codec.decorators.SearchRequestDecorator;
027import org.apache.directory.shared.ldap.model.message.SearchRequest;
028import org.slf4j.Logger;
029import org.slf4j.LoggerFactory;
030
031
032/**
033 * The action used to initialize the AttributeDesc list
034 * <pre>
035 * SearchRequest ::= [APPLICATION 3] SEQUENCE {
036 *     ...
037 *     filter      Filter,
038 *     attributes  AttributeDescriptionList }
039 *
040 * AttributeDescriptionList ::= SEQUENCE OF
041 *     AttributeDescription
042 * </pre>
043 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
044 */
045public class InitSearchRequestAttributeDescList extends GrammarAction<LdapMessageContainer<SearchRequestDecorator>>
046{
047    /** The logger */
048    private static final Logger LOG = LoggerFactory.getLogger( InitSearchRequestAttributeDescList.class );
049
050    /** Speedup for logs */
051    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
052
053    /**
054     * Instantiates a new init attribute desc list action.
055     */
056    public InitSearchRequestAttributeDescList()
057    {
058        super( "Initialize AttributeDesc list" );
059    }
060
061    /**
062     * {@inheritDoc}
063     */
064    public void action( LdapMessageContainer<SearchRequestDecorator> container ) throws DecoderException
065    {
066        // Here, we have to inject the decoded filter into the SearchRequest
067        SearchRequestDecorator searchRequestDecorator = container.getMessage();
068        SearchRequest searchRequest = searchRequestDecorator.getDecorated();
069
070        searchRequest.setFilter( searchRequestDecorator.getFilterNode() );
071
072        // We can have an END transition
073        container.setGrammarEndAllowed( true );
074
075        if ( IS_DEBUG )
076        {
077            LOG.debug( "Initialize AttributeDesc list" );
078        }
079    }
080}