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.SubstringFilter;
030import org.apache.directory.api.util.Strings;
031import org.slf4j.Logger;
032import org.slf4j.LoggerFactory;
033
034
035/**
036 * The action used to store a final value into a substring filter
037 * <pre>
038 * SubstringFilter ::= SEQUENCE {
039 *     ...
040 *     substrings SEQUENCE OF CHOICE {
041 *         ...
042 *         final  [2] LDAPSTRING }
043 * </pre>
044
045 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
046 */
047public class StoreFinal extends GrammarAction<LdapMessageContainer<SearchRequestDecorator>>
048{
049    /** The logger */
050    private static final Logger LOG = LoggerFactory.getLogger( StoreFinal.class );
051
052    /** Speedup for logs */
053    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
054
055
056    /**
057     * Instantiates a new store final action.
058     */
059    public StoreFinal()
060    {
061        super( "Store a final value" );
062    }
063
064
065    /**
066     * {@inheritDoc}
067     */
068    public void action( LdapMessageContainer<SearchRequestDecorator> container ) throws DecoderException
069    {
070        SearchRequestDecorator searchRequest = container.getMessage();
071
072        TLV tlv = container.getCurrentTLV();
073
074        // Store the value.
075        SubstringFilter substringFilter = ( SubstringFilter ) searchRequest.getTerminalFilter();
076
077        if ( tlv.getLength() == 0 )
078        {
079            String msg = I18n.err( I18n.ERR_04020 );
080            LOG.error( msg );
081            throw new DecoderException( msg );
082        }
083
084        String finalValue = Strings.utf8ToString( tlv.getValue().getData() );
085        substringFilter.setFinalSubstrings( finalValue );
086
087        // We now have to get back to the nearest filter which is
088        // not terminal.
089        searchRequest.unstackFilters( container );
090
091        if ( IS_DEBUG )
092        {
093            LOG.debug( "Stored a any substring : {}", finalValue );
094        }
095    }
096}