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.searchResultEntry;
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.decorators.SearchResultEntryDecorator;
029import org.apache.directory.api.ldap.model.exception.LdapException;
030import org.apache.directory.api.util.Strings;
031import org.slf4j.Logger;
032import org.slf4j.LoggerFactory;
033
034
035/**
036 * The action used to store the SearchResultEntry attributes
037 * <pre>
038 * SearchResultEntry ::= [APPLICATION 4] SEQUENCE { ...
039 *     ...
040 *     attributes PartialAttributeList }
041 *
042 * PartialAttributeList ::= SEQUENCE OF SEQUENCE {
043 *     type  AttributeDescription,
044 *     ...
045 * </pre>
046 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
047 */
048public class AddAttributeType extends GrammarAction<LdapMessageContainer<SearchResultEntryDecorator>>
049{
050    /** The logger */
051    private static final Logger LOG = LoggerFactory.getLogger( AddAttributeType.class );
052
053    /** Speedup for logs */
054    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
055
056
057    /**
058     * Instantiates a new action.
059     */
060    public AddAttributeType()
061    {
062        super( "Store the AttributeType" );
063    }
064
065
066    /**
067     * {@inheritDoc}
068     */
069    public void action( LdapMessageContainer<SearchResultEntryDecorator> container ) throws DecoderException
070    {
071        SearchResultEntryDecorator searchResultEntry = container.getMessage();
072
073        TLV tlv = container.getCurrentTLV();
074
075        // Store the type
076        if ( tlv.getLength() == 0 )
077        {
078            // The type can't be null
079            String msg = I18n.err( I18n.ERR_04081 );
080            LOG.error( msg );
081            throw new DecoderException( msg );
082        }
083        else
084        {
085            try
086            {
087                searchResultEntry.addAttribute( tlv.getValue().getData() );
088            }
089            catch ( LdapException ine )
090            {
091                String type = Strings.utf8ToString( tlv.getValue().getData() );
092                // This is for the client side. We will never decode LdapResult on the server
093                String msg = "The Attribute type " + type + "is invalid : " + ine.getMessage();
094                LOG.error( "{} : {}", msg, ine.getMessage() );
095                throw new DecoderException( msg, ine );
096            }
097        }
098
099        if ( IS_DEBUG )
100        {
101            String type = Strings.utf8ToString( tlv.getValue().getData() );
102            LOG.debug( "Attribute type : {}", type );
103        }
104    }
105}