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.request.compare;
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.model.message.CompareRequest;
030import org.apache.directory.api.ldap.model.message.CompareResponseImpl;
031import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
032import org.apache.directory.api.util.Strings;
033import org.slf4j.Logger;
034import org.slf4j.LoggerFactory;
035
036
037/**
038 * The action used to store the AssertionValue attributeDescription in a Compare Request
039 * <pre>
040 * CompareRequest ::= [APPLICATION 14] SEQUENCE {
041 *     ...
042 *     ava AttributeValueAssertion }
043 *
044 * AttributeValueAssertion ::= SEQUENCE {
045 *     attributeDesc   AttributeDescription,
046 *     ...
047 * </pre>
048 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
049 */
050public class StoreCompareRequestAttributeDesc extends GrammarAction<LdapMessageContainer<CompareRequest>>
051{
052    /** The logger */
053    private static final Logger LOG = LoggerFactory.getLogger( StoreCompareRequestAttributeDesc.class );
054
055    /**
056     * Instantiates a new action.
057     */
058    public StoreCompareRequestAttributeDesc()
059    {
060        super( "Store CompareRequest assertion description" );
061    }
062
063
064    /**
065     * {@inheritDoc}
066     */
067    @Override
068    public void action( LdapMessageContainer<CompareRequest> container ) throws DecoderException
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 matched
077        // Dn
078        if ( tlv.getLength() == 0 )
079        {
080            String msg = I18n.err( I18n.ERR_05118_NULL_ATTRIBUTE_DESC );
081            LOG.error( msg );
082            CompareResponseImpl response = new CompareResponseImpl( compareRequest.getMessageId() );
083
084            throw new ResponseCarryingException( msg, response, ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX,
085                compareRequest.getName(), null );
086        }
087
088        String type = Strings.utf8ToString( tlv.getValue().getData() );
089        compareRequest.setAttributeId( type );
090
091        if ( LOG.isDebugEnabled() )
092        {
093            LOG.debug( I18n.msg( I18n.MSG_05122_COMPARING_ATTRIBUTE_DESCRIPTION, compareRequest.getAttributeId() ) );
094        }
095    }
096}