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.filter;
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.TLV;
026import org.apache.directory.api.i18n.I18n;
027import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
028import org.apache.directory.api.ldap.codec.decorators.SearchRequestDecorator;
029import org.apache.directory.api.ldap.codec.search.Filter;
030import org.apache.directory.api.ldap.codec.search.SubstringFilter;
031import org.slf4j.Logger;
032import org.slf4j.LoggerFactory;
033
034
035/**
036 * The action used to initialize the Substrings filter
037 * 
038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039 */
040public class InitSubstringsFilter extends GrammarAction<LdapMessageContainer<SearchRequestDecorator>>
041{
042    /** The logger */
043    private static final Logger LOG = LoggerFactory.getLogger( InitSubstringsFilter.class );
044
045    /** Speedup for logs */
046    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
047
048
049    /**
050     * Instantiates a new init substrings filter action.
051     */
052    public InitSubstringsFilter()
053    {
054        super( "Initialize Substrings filter" );
055    }
056
057
058    /**
059     * {@inheritDoc}
060     */
061    public void action( LdapMessageContainer<SearchRequestDecorator> container ) throws DecoderException
062    {
063        SearchRequestDecorator searchRequestDecorator = container.getMessage();
064
065        TLV tlv = container.getCurrentTLV();
066
067        int expectedLength = tlv.getLength();
068
069        if ( expectedLength == 0 )
070        {
071            String msg = I18n.err( I18n.ERR_04012 );
072            LOG.error( msg );
073            throw new DecoderException( msg );
074        }
075
076        // We can allocate the SearchRequest
077        Filter substringFilter = new SubstringFilter( container.getTlvId() );
078
079        searchRequestDecorator.addCurrentFilter( substringFilter );
080        searchRequestDecorator.setTerminalFilter( substringFilter );
081
082        if ( IS_DEBUG )
083        {
084            LOG.debug( "Initialize Substrings filter" );
085        }
086    }
087}