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.ldap.codec.api.LdapMessageContainer;
027import org.apache.directory.api.ldap.codec.decorators.SearchRequestDecorator;
028import org.apache.directory.api.ldap.codec.search.ExtensibleMatchFilter;
029import org.apache.directory.api.ldap.model.entry.BinaryValue;
030import org.slf4j.Logger;
031import org.slf4j.LoggerFactory;
032
033
034/**
035 * The action used to store a match value
036 * <pre>
037 * Filter ::= CHOICE {
038 *     ...
039 *     extensibleMatch  [9] MatchingRuleAssertion }
040 *
041 * MatchingRuleAssertion ::= SEQUENCE {
042 *     ...
043 *     matchValue [3] AssertionValue,
044 *     ...
045 * </pre>
046 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
047 */
048public class StoreMatchValue extends GrammarAction<LdapMessageContainer<SearchRequestDecorator>>
049{
050    /** The logger */
051    private static final Logger LOG = LoggerFactory.getLogger( StoreMatchValue.class );
052
053    /** Speedup for logs */
054    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
055
056
057    /**
058     * Instantiates a new store match value action.
059     */
060    public StoreMatchValue()
061    {
062        super( "Store match Value" );
063    }
064
065
066    /**
067     * {@inheritDoc}
068     */
069    public void action( LdapMessageContainer<SearchRequestDecorator> container ) throws DecoderException
070    {
071        SearchRequestDecorator decorator = container.getMessage();
072
073        TLV tlv = container.getCurrentTLV();
074
075        // Store the value.
076        ExtensibleMatchFilter extensibleMatchFilter = ( ExtensibleMatchFilter ) decorator.getTerminalFilter();
077
078        byte[] value = tlv.getValue().getData();
079        extensibleMatchFilter.setMatchValue( new BinaryValue( value ) );
080
081        // unstack the filters if needed
082        decorator.unstackFilters( container );
083
084        if ( IS_DEBUG )
085        {
086            LOG.debug( "Stored a match value : {}", value );
087        }
088    }
089}