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.BerValue;
026import org.apache.directory.api.asn1.ber.tlv.BooleanDecoder;
027import org.apache.directory.api.asn1.ber.tlv.BooleanDecoderException;
028import org.apache.directory.api.asn1.ber.tlv.TLV;
029import org.apache.directory.api.i18n.I18n;
030import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
031import org.apache.directory.api.ldap.codec.decorators.SearchRequestDecorator;
032import org.apache.directory.api.ldap.codec.search.ExtensibleMatchFilter;
033import org.apache.directory.api.util.Strings;
034import org.slf4j.Logger;
035import org.slf4j.LoggerFactory;
036
037
038/**
039 * The action used to store a matchingRuleAssertion dnAttributes
040 * <pre>
041 * Filter ::= CHOICE {
042 *     ...
043 *     extensibleMatch  [9] MatchingRuleAssertion }
044 *
045 * MatchingRuleAssertion ::= SEQUENCE {
046 *     ...
047 *     dnAttributes [4] BOOLEAN DEFAULT FALSE }
048 * </pre>
049 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
050 */
051public class StoreMatchingRuleDnAttributes extends GrammarAction<LdapMessageContainer<SearchRequestDecorator>>
052{
053    /** The logger */
054    private static final Logger LOG = LoggerFactory.getLogger( StoreMatchingRuleDnAttributes.class );
055
056    /** Speedup for logs */
057    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
058
059
060    /**
061     * Instantiates a new StoreMatchingRuleDnAttributes.
062     */
063    public StoreMatchingRuleDnAttributes()
064    {
065        super( "Store matchingRuleAssertion dnAttributes" );
066    }
067
068
069    public void action( LdapMessageContainer<SearchRequestDecorator> container ) throws DecoderException
070    {
071        SearchRequestDecorator searchRequest = container.getMessage();
072
073        TLV tlv = container.getCurrentTLV();
074
075        // Store the value.
076        ExtensibleMatchFilter extensibleMatchFilter = ( ExtensibleMatchFilter ) searchRequest.getTerminalFilter();
077
078        // We get the value. If it's a 0, it's a FALSE. If it's
079        // a FF, it's a TRUE. Any other value should be an error,
080        // but we could relax this constraint. So if we have
081        // something
082        // which is not 0, it will be interpreted as TRUE, but we
083        // will generate a warning.
084        BerValue value = tlv.getValue();
085
086        try
087        {
088            extensibleMatchFilter.setDnAttributes( BooleanDecoder.parse( value ) );
089        }
090        catch ( BooleanDecoderException bde )
091        {
092            LOG.error( I18n
093                .err( I18n.ERR_04110, Strings.dumpBytes( value.getData() ), bde.getMessage() ) );
094
095            throw new DecoderException( bde.getMessage(), bde );
096        }
097
098        if ( IS_DEBUG )
099        {
100            LOG.debug( "Dn Attributes : {}", Boolean.valueOf( extensibleMatchFilter.isDnAttributes() ) );
101        }
102
103        // unstack the filters if needed
104        searchRequest.unstackFilters( container );
105    }
106}