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.ldap.codec.api.LdapMessageContainer;
027import org.apache.directory.api.ldap.codec.decorators.SearchResultEntryDecorator;
028import org.apache.directory.api.ldap.model.exception.LdapInvalidDnException;
029import org.apache.directory.api.ldap.model.name.Dn;
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 name
037 * <pre>
038 * LdapMessage ::= ... SearchResultEntry ...
039 * SearchResultEntry ::= [APPLICATION 4] SEQUENCE {
040 *         objectName      LDAPDN,
041 *         ...
042 *
043 * </pre>
044 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
045 */
046public class StoreSearchResultEntryObjectName extends GrammarAction<LdapMessageContainer<SearchResultEntryDecorator>>
047{
048    /** The logger */
049    private static final Logger LOG = LoggerFactory.getLogger( StoreSearchResultEntryObjectName.class );
050
051    /** Speedup for logs */
052    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
053
054
055    /**
056     * Instantiates a new action.
057     */
058    public StoreSearchResultEntryObjectName()
059    {
060        super( "Store SearchResultEntry name" );
061    }
062
063
064    /**
065     * {@inheritDoc}
066     */
067    public void action( LdapMessageContainer<SearchResultEntryDecorator> container ) throws DecoderException
068    {
069        SearchResultEntryDecorator searchResultEntry = container.getMessage();
070
071        TLV tlv = container.getCurrentTLV();
072
073        Dn objectName = Dn.EMPTY_DN;
074
075        // Store the value.
076        if ( tlv.getLength() == 0 )
077        {
078            searchResultEntry.setObjectName( objectName );
079        }
080        else
081        {
082            byte[] dnBytes = tlv.getValue().getData();
083            String dnStr = Strings.utf8ToString( dnBytes );
084
085            try
086            {
087                objectName = new Dn( dnStr );
088            }
089            catch ( LdapInvalidDnException ine )
090            {
091                // This is for the client side. We will never decode LdapResult on the server
092                String msg = "The Dn " + Strings.dumpBytes( dnBytes ) + "is invalid : "
093                    + ine.getMessage();
094                LOG.error( "{} : {}", msg, ine.getMessage() );
095                throw new DecoderException( msg, ine );
096            }
097
098            searchResultEntry.setObjectName( objectName );
099        }
100
101        if ( IS_DEBUG )
102        {
103            LOG.debug( "Search Result Entry Dn found : {}", searchResultEntry.getObjectName() );
104        }
105    }
106}