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.request.search; 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.api.ResponseCarryingException; 029import org.apache.directory.api.ldap.model.exception.LdapInvalidDnException; 030import org.apache.directory.api.ldap.model.message.ResultCodeEnum; 031import org.apache.directory.api.ldap.model.message.SearchRequest; 032import org.apache.directory.api.ldap.model.message.SearchResultDoneImpl; 033import org.apache.directory.api.ldap.model.name.Dn; 034import org.apache.directory.api.util.Strings; 035import org.slf4j.Logger; 036import org.slf4j.LoggerFactory; 037 038 039/** 040 * The action used to store the SearchRequest base object 041 * <pre> 042 * SearchRequest ::= [APPLICATION 3] SEQUENCE { 043 * baseObject LDAPDN, 044 * ... 045 * </pre> 046 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 047 */ 048public class StoreSearchRequestBaseObject extends GrammarAction<LdapMessageContainer<SearchRequest>> 049{ 050 /** The logger */ 051 private static final Logger LOG = LoggerFactory.getLogger( StoreSearchRequestBaseObject.class ); 052 053 054 /** 055 * Instantiates a new action. 056 */ 057 public StoreSearchRequestBaseObject() 058 { 059 super( "Store SearchRequest object Name" ); 060 } 061 062 063 /** 064 * {@inheritDoc} 065 */ 066 public void action( LdapMessageContainer<SearchRequest> container ) throws DecoderException 067 { 068 SearchRequest searchRequest = container.getMessage(); 069 070 TLV tlv = container.getCurrentTLV(); 071 072 // We have to check that this is a correct Dn 073 // We have to handle the special case of a 0 length base 074 // object, 075 // which means that the search is done from the default 076 // root. 077 if ( tlv.getLength() != 0 ) 078 { 079 byte[] dnBytes = tlv.getValue().getData(); 080 String dnStr = Strings.utf8ToString( dnBytes ); 081 082 try 083 { 084 Dn baseObject = new Dn( dnStr ); 085 searchRequest.setBase( baseObject ); 086 } 087 catch ( LdapInvalidDnException ine ) 088 { 089 String msg = I18n.err( I18n.ERR_05132_INVALID_ROOT_DN, dnStr, Strings.dumpBytes( dnBytes ) ); 090 LOG.error( I18n.err( I18n.ERR_05114_ERROR_MESSAGE, msg, ine.getMessage() ) ); 091 092 SearchResultDoneImpl response = new SearchResultDoneImpl( searchRequest.getMessageId() ); 093 throw new ResponseCarryingException( msg, response, ResultCodeEnum.INVALID_DN_SYNTAX, 094 Dn.EMPTY_DN, ine ); 095 } 096 } 097 else 098 { 099 searchRequest.setBase( Dn.EMPTY_DN ); 100 } 101 102 if ( LOG.isDebugEnabled() ) 103 { 104 LOG.debug( I18n.msg( I18n.MSG_05160_SEARCHING_WITH_ROOT_DN, searchRequest.getBase() ) ); 105 } 106 } 107}