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