View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    https://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.directory.api.ldap.codec.actions.request.search;
21  
22  
23  import org.apache.directory.api.asn1.DecoderException;
24  import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
25  import org.apache.directory.api.asn1.ber.tlv.TLV;
26  import org.apache.directory.api.i18n.I18n;
27  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
28  import org.apache.directory.api.ldap.codec.api.ResponseCarryingException;
29  import org.apache.directory.api.ldap.model.exception.LdapInvalidDnException;
30  import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
31  import org.apache.directory.api.ldap.model.message.SearchRequest;
32  import org.apache.directory.api.ldap.model.message.SearchResultDoneImpl;
33  import org.apache.directory.api.ldap.model.name.Dn;
34  import org.apache.directory.api.ldap.model.name.DnFactory;
35  import org.apache.directory.api.util.Strings;
36  import org.slf4j.Logger;
37  import org.slf4j.LoggerFactory;
38  
39  
40  /**
41   * The action used to store the SearchRequest base object
42   * <pre>
43   * SearchRequest ::= [APPLICATION 3] SEQUENCE {
44   *     baseObject LDAPDN,
45   *     ...
46   * </pre>
47   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
48   */
49  public class StoreSearchRequestBaseObject extends GrammarAction<LdapMessageContainer<SearchRequest>>
50  {
51      /** The logger */
52      private static final Logger LOG = LoggerFactory.getLogger( StoreSearchRequestBaseObject.class );
53  
54  
55      /**
56       * Instantiates a new action.
57       */
58      public StoreSearchRequestBaseObject()
59      {
60          super( "Store SearchRequest object Name" );
61      }
62  
63  
64      /**
65       * {@inheritDoc}
66       */
67      public void action( LdapMessageContainer<SearchRequest> container ) throws DecoderException
68      {
69          SearchRequest searchRequest = container.getMessage();
70  
71          TLV tlv = container.getCurrentTLV();
72  
73          // We have to check that this is a correct Dn
74          // We have to handle the special case of a 0 length base
75          // object,
76          // which means that the search is done from the default
77          // root.
78          if ( tlv.getLength() != 0 )
79          {
80              byte[] dnBytes = tlv.getValue().getData();
81              String dnStr = Strings.utf8ToString( dnBytes );
82  
83              try
84              {
85                  DnFactory dnFactory = container.getDnFactory();
86                  Dn baseObject;
87  
88                  if ( dnFactory == null )
89                  {
90                      baseObject = new Dn( dnStr );
91                  }
92                  else
93                  {
94                      baseObject = new Dn( dnStr ); //dnFactory.create( dnStr );
95                  }
96                  
97                  searchRequest.setBase( baseObject );
98              }
99              catch ( LdapInvalidDnException ine )
100             {
101                 String msg = I18n.err( I18n.ERR_05132_INVALID_ROOT_DN, dnStr, Strings.dumpBytes( dnBytes ) );
102                 LOG.error( I18n.err( I18n.ERR_05114_ERROR_MESSAGE, msg, ine.getMessage() ) );
103 
104                 SearchResultDoneImpl response = new SearchResultDoneImpl( searchRequest.getMessageId() );
105                 throw new ResponseCarryingException( msg, response, ResultCodeEnum.INVALID_DN_SYNTAX,
106                     Dn.EMPTY_DN, ine );
107             }
108         }
109         else
110         {
111             searchRequest.setBase( Dn.EMPTY_DN );
112         }
113 
114         if ( LOG.isDebugEnabled() )
115         {
116             LOG.debug( I18n.msg( I18n.MSG_05160_SEARCHING_WITH_ROOT_DN, searchRequest.getBase() ) );
117         }
118     }
119 }