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.compareRequest;
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.api.ResponseCarryingException;
029import org.apache.directory.api.ldap.codec.decorators.CompareRequestDecorator;
030import org.apache.directory.api.ldap.model.message.CompareRequest;
031import org.apache.directory.api.ldap.model.message.CompareResponseImpl;
032import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
033import org.apache.directory.api.util.Strings;
034import org.slf4j.Logger;
035import org.slf4j.LoggerFactory;
036
037
038/**
039 * The action used to store the AssertionValue attributeDescription in a Compare Request
040 * <pre>
041 * CompareRequest ::= [APPLICATION 14] SEQUENCE {
042 *     ...
043 *     ava AttributeValueAssertion }
044 *
045 * AttributeValueAssertion ::= SEQUENCE {
046 *     attributeDesc   AttributeDescription,
047 *     ...
048 * </pre>
049 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
050 */
051public class StoreCompareRequestAttributeDesc extends GrammarAction<LdapMessageContainer<CompareRequestDecorator>>
052{
053    /** The logger */
054    private static final Logger LOG = LoggerFactory.getLogger( StoreCompareRequestAttributeDesc.class );
055
056    /** Speedup for logs */
057    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
058
059
060    /**
061     * Instantiates a new action.
062     */
063    public StoreCompareRequestAttributeDesc()
064    {
065        super( "Store CompareRequest assertion description" );
066    }
067
068
069    /**
070     * {@inheritDoc}
071     */
072    public void action( LdapMessageContainer<CompareRequestDecorator> container ) throws DecoderException
073    {
074        // Get the CompareRequest Object
075        CompareRequest compareRequest = container.getMessage();
076
077        // Get the Value and store it in the CompareRequest
078        TLV tlv = container.getCurrentTLV();
079
080        // We have to handle the special case of a 0 length matched
081        // Dn
082        if ( tlv.getLength() == 0 )
083        {
084            String msg = I18n.err( I18n.ERR_04093 );
085            LOG.error( msg );
086            CompareResponseImpl response = new CompareResponseImpl( compareRequest.getMessageId() );
087
088            throw new ResponseCarryingException( msg, response, ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX,
089                compareRequest.getName(), null );
090        }
091
092        String type = Strings.utf8ToString( tlv.getValue().getData() );
093        compareRequest.setAttributeId( type );
094
095        if ( IS_DEBUG )
096        {
097            LOG.debug( "Comparing attribute description {}", compareRequest.getAttributeId() );
098        }
099    }
100}