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.compareRequest;
021
022
023import org.apache.directory.shared.asn1.ber.grammar.GrammarAction;
024import org.apache.directory.shared.asn1.ber.tlv.TLV;
025import org.apache.directory.shared.ldap.codec.api.LdapMessageContainer;
026import org.apache.directory.shared.ldap.codec.decorators.CompareRequestDecorator;
027import org.apache.directory.shared.ldap.model.message.CompareRequest;
028import org.apache.directory.shared.util.Strings;
029import org.slf4j.Logger;
030import org.slf4j.LoggerFactory;
031
032
033/**
034 * The action used to store the AssertionValue in a Compare Request
035 * <pre>
036 * CompareRequest ::= [APPLICATION 14] SEQUENCE {
037 *     ...
038 *     ava AttributeValueAssertion }
039 *
040 * AttributeValueAssertion ::= SEQUENCE {
041 *     ...
042 *     assertionValue AssertionValue }
043 *
044 * AssertionValue OCTET STRING
045 * </pre>
046 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
047 */
048public class StoreCompareRequestAssertionValue extends GrammarAction<LdapMessageContainer<CompareRequestDecorator>>
049{
050    /** The logger */
051    private static final Logger LOG = LoggerFactory.getLogger( StoreCompareRequestAssertionValue.class );
052
053    /** Speedup for logs */
054    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
055
056    /**
057     * Instantiates a new action.
058     */
059    public StoreCompareRequestAssertionValue()
060    {
061        super( "Store CompareRequest assertion value" );
062    }
063
064
065    /**
066     * {@inheritDoc}
067     */
068    public void action( LdapMessageContainer<CompareRequestDecorator> container )
069    {
070        // Get the CompareRequest Object
071        CompareRequest compareRequest = container.getMessage();
072
073        // Get the Value and store it in the CompareRequest
074        TLV tlv = container.getCurrentTLV();
075
076        // We have to handle the special case of a 0 length value
077        if ( tlv.getLength() == 0 )
078        {
079            compareRequest.setAssertionValue( "" );
080        }
081        else
082        {
083            if ( container.isBinary( compareRequest.getAttributeId() ) )
084            {
085                compareRequest.setAssertionValue( tlv.getValue().getData() );
086
087                if ( IS_DEBUG )
088                {
089                    LOG.debug( "Comparing attribute value {}", Strings.dumpBytes(compareRequest
090                            .getAssertionValue().getBytes()) );
091                }
092            }
093            else
094            {
095                compareRequest.setAssertionValue( Strings.utf8ToString(tlv.getValue().getData()) );
096
097                if ( LOG.isDebugEnabled() )
098                {
099                    LOG.debug( "Comparing attribute value {}", compareRequest.getAssertionValue() );
100                }
101            }
102        }
103
104        // We can have an END transition
105        container.setGrammarEndAllowed( true );
106    }
107}