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.filter;
021
022
023import org.apache.directory.shared.asn1.DecoderException;
024import org.apache.directory.shared.asn1.ber.grammar.GrammarAction;
025import org.apache.directory.shared.asn1.ber.tlv.TLV;
026import org.apache.directory.shared.i18n.I18n;
027import org.apache.directory.shared.ldap.codec.api.LdapMessageContainer;
028import org.apache.directory.shared.ldap.codec.decorators.SearchRequestDecorator;
029import org.apache.directory.shared.ldap.codec.search.SubstringFilter;
030import org.apache.directory.shared.util.Strings;
031import org.slf4j.Logger;
032import org.slf4j.LoggerFactory;
033
034
035/**
036 * The action used to store the Substring Filter type
037 * <pre>
038 * Filter ::= CHOICE {
039 *     ...
040 *     substrings  [4] SubstringFilter,
041 *     ...
042 *
043 * SubstringFilter ::= SEQUENCE {
044 *     type   AttributeDescription,
045 *     ...
046 * </pre>
047 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
048 */
049public class StoreSubstringFilterType extends GrammarAction<LdapMessageContainer<SearchRequestDecorator>>
050{
051    /** The logger */
052    private static final Logger LOG = LoggerFactory.getLogger( StoreSubstringFilterType.class );
053
054    /**
055     * Instantiates a new action.
056     */
057    public StoreSubstringFilterType()
058    {
059        super( "Store Substring filter type" );
060    }
061
062
063    /**
064     * {@inheritDoc}
065     */
066    public void action( LdapMessageContainer<SearchRequestDecorator> container ) throws DecoderException
067    {
068        SearchRequestDecorator searchRequestDecorator = container.getMessage();
069
070        TLV tlv = container.getCurrentTLV();
071
072        // Store the value.
073        SubstringFilter substringFilter = ( SubstringFilter ) searchRequestDecorator.getTerminalFilter();
074
075        if ( tlv.getLength() == 0 )
076        {
077            String msg = I18n.err( I18n.ERR_04106 );
078            LOG.error( msg );
079            throw new DecoderException( msg );
080        }
081        else
082        {
083            String type = Strings.utf8ToString( tlv.getValue().getData() );
084            substringFilter.setType( type );
085
086            // We now have to get back to the nearest filter which
087            // is not terminal.
088            searchRequestDecorator.setTerminalFilter( substringFilter );
089        }
090    }
091}