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.response.search.entry;
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.model.entry.Attribute;
029import org.apache.directory.api.ldap.model.entry.DefaultAttribute;
030import org.apache.directory.api.ldap.model.exception.LdapException;
031import org.apache.directory.api.ldap.model.message.SearchResultEntry;
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 SearchResultEntry attributes
039 * <pre>
040 * SearchResultEntry ::= [APPLICATION 4] SEQUENCE { ...
041 *     ...
042 *     attributes PartialAttributeList }
043 *
044 * PartialAttributeList ::= SEQUENCE OF SEQUENCE {
045 *     type  AttributeDescription,
046 *     ...
047 * </pre>
048 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
049 */
050public class AddAttributeType extends GrammarAction<LdapMessageContainer<SearchResultEntry>>
051{
052    /** The logger */
053    private static final Logger LOG = LoggerFactory.getLogger( AddAttributeType.class );
054
055    /**
056     * Instantiates a new action.
057     */
058    public AddAttributeType()
059    {
060        super( "Store the AttributeType" );
061    }
062
063
064    /**
065     * {@inheritDoc}
066     */
067    public void action( LdapMessageContainer<SearchResultEntry> container ) throws DecoderException
068    {
069        SearchResultEntry searchResultEntry = container.getMessage();
070
071        TLV tlv = container.getCurrentTLV();
072
073        // Store the type
074        if ( tlv.getLength() == 0 )
075        {
076            // The type can't be null
077            String msg = I18n.err( I18n.ERR_05147_NULL_ATTRIBUTE_TYPE );
078            LOG.error( msg );
079            throw new DecoderException( msg );
080        }
081        else
082        {
083            try
084            {
085                Attribute attribute = new DefaultAttribute( tlv.getValue().getData() );
086                container.setCurrentAttribute( attribute );
087                searchResultEntry.getEntry().put( attribute );
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 = I18n.err( I18n.ERR_05156_INVALID_ATTRIBUTE_TYPE, type, ine.getMessage() );
094                LOG.error( I18n.err( I18n.ERR_05114_ERROR_MESSAGE, msg, ine.getMessage() ) );
095                throw new DecoderException( msg, ine );
096            }
097        }
098
099        if ( LOG.isDebugEnabled() )
100        {
101            String type = Strings.utf8ToString( tlv.getValue().getData() );
102            LOG.debug( I18n.msg( I18n.MSG_05179_ATTRIBUTE_TYPE, type ) );
103        }
104    }
105}