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 *    https://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.request.compare;
021
022
023import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
024import org.apache.directory.api.asn1.ber.tlv.TLV;
025import org.apache.directory.api.i18n.I18n;
026import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
027import org.apache.directory.api.ldap.model.message.CompareRequest;
028import org.apache.directory.api.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<CompareRequest>>
049{
050    /** The logger */
051    private static final Logger LOG = LoggerFactory.getLogger( StoreCompareRequestAssertionValue.class );
052
053    /**
054     * Instantiates a new action.
055     */
056    public StoreCompareRequestAssertionValue()
057    {
058        super( "Store CompareRequest assertion value" );
059    }
060
061
062    /**
063     * {@inheritDoc}
064     */
065    @Override
066    public void action( LdapMessageContainer<CompareRequest> container )
067    {
068        // Get the CompareRequest Object
069        CompareRequest compareRequest = container.getMessage();
070
071        // Get the Value and store it in the CompareRequest
072        TLV tlv = container.getCurrentTLV();
073
074        // We have to handle the special case of a 0 length value
075        if ( tlv.getLength() == 0 )
076        {
077            compareRequest.setAssertionValue( "" );
078        }
079        else
080        {
081            if ( container.isBinary( compareRequest.getAttributeId() ) )
082            {
083                compareRequest.setAssertionValue( tlv.getValue().getData() );
084
085                if ( LOG.isDebugEnabled() )
086                {
087                    LOG.debug( I18n.msg( I18n.MSG_05121_COMPARING_ATTRIBUTE_VALUE, 
088                        Strings.dumpBytes( compareRequest.getAssertionValue().getBytes() ) ) );
089                }
090            }
091            else
092            {
093                compareRequest.setAssertionValue( Strings.utf8ToString( tlv.getValue().getData() ) );
094
095                if ( LOG.isDebugEnabled() )
096                {
097                    LOG.debug( I18n.msg( I18n.MSG_05121_COMPARING_ATTRIBUTE_VALUE, compareRequest.getAssertionValue() ) );
098                }
099            }
100        }
101
102        // We can have an END transition
103        container.setGrammarEndAllowed( true );
104    }
105}