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.search;
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.SearchRequest;
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 attribute description
035 * <pre>
036 * SearchRequest ::= [APPLICATION 3] SEQUENCE {
037 *     ...
038 *     attributes  AttributeDescriptionList }
039 *
040 * AttributeDescriptionList ::= SEQUENCE OF
041 *     AttributeDescription
042 * </pre>
043 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
044 */
045public class StoreSearchRequestAttributeDesc extends GrammarAction<LdapMessageContainer<SearchRequest>>
046{
047    /** The logger */
048    private static final Logger LOG = LoggerFactory.getLogger( StoreSearchRequestAttributeDesc.class );
049
050    /**
051     * Instantiates a new attribute desc action.
052     */
053    public StoreSearchRequestAttributeDesc()
054    {
055        super( "Store attribute description" );
056    }
057
058
059    /**
060     * {@inheritDoc}
061     */
062    public void action( LdapMessageContainer<SearchRequest> container )
063    {
064        SearchRequest searchRequest = container.getMessage();
065        TLV tlv = container.getCurrentTLV();
066        String attributeDescription = null;
067
068        if ( tlv.getLength() != 0 )
069        {
070            attributeDescription = Strings.utf8ToString( tlv.getValue().getData() );
071
072            // If the attributeDescription is empty, we won't add it
073            if ( !Strings.isEmpty( attributeDescription.trim() ) )
074            {
075                searchRequest.addAttributes( attributeDescription );
076            }
077        }
078
079        // We can have an END transition
080        container.setGrammarEndAllowed( true );
081
082        if ( LOG.isDebugEnabled() )
083        {
084            LOG.debug( I18n.msg( I18n.MSG_05159_DECODED_ATT_DESC, attributeDescription ) );
085        }
086    }
087}