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   *    http://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.searchResultEntry;
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.ldap.codec.api.LdapMessageContainer;
27  import org.apache.directory.api.ldap.codec.decorators.SearchResultEntryDecorator;
28  import org.apache.directory.api.ldap.model.exception.LdapInvalidDnException;
29  import org.apache.directory.api.ldap.model.name.Dn;
30  import org.apache.directory.api.util.Strings;
31  import org.slf4j.Logger;
32  import org.slf4j.LoggerFactory;
33  
34  
35  /**
36   * The action used to store the SearchResultEntry name
37   * <pre>
38   * LdapMessage ::= ... SearchResultEntry ...
39   * SearchResultEntry ::= [APPLICATION 4] SEQUENCE {
40   *         objectName      LDAPDN,
41   *         ...
42   *
43   * </pre>
44   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
45   */
46  public class StoreSearchResultEntryObjectName extends GrammarAction<LdapMessageContainer<SearchResultEntryDecorator>>
47  {
48      /** The logger */
49      private static final Logger LOG = LoggerFactory.getLogger( StoreSearchResultEntryObjectName.class );
50  
51      /** Speedup for logs */
52      private static final boolean IS_DEBUG = LOG.isDebugEnabled();
53  
54  
55      /**
56       * Instantiates a new action.
57       */
58      public StoreSearchResultEntryObjectName()
59      {
60          super( "Store SearchResultEntry name" );
61      }
62  
63  
64      /**
65       * {@inheritDoc}
66       */
67      public void action( LdapMessageContainer<SearchResultEntryDecorator> container ) throws DecoderException
68      {
69          SearchResultEntryDecorator searchResultEntry = container.getMessage();
70  
71          TLV tlv = container.getCurrentTLV();
72  
73          Dn objectName = Dn.EMPTY_DN;
74  
75          // Store the value.
76          if ( tlv.getLength() == 0 )
77          {
78              searchResultEntry.setObjectName( objectName );
79          }
80          else
81          {
82              byte[] dnBytes = tlv.getValue().getData();
83              String dnStr = Strings.utf8ToString( dnBytes );
84  
85              try
86              {
87                  objectName = new Dn( dnStr );
88              }
89              catch ( LdapInvalidDnException ine )
90              {
91                  // This is for the client side. We will never decode LdapResult on the server
92                  String msg = "The Dn " + Strings.dumpBytes( dnBytes ) + "is invalid : "
93                      + ine.getMessage();
94                  LOG.error( "{} : {}", msg, ine.getMessage() );
95                  throw new DecoderException( msg, ine );
96              }
97  
98              searchResultEntry.setObjectName( objectName );
99          }
100 
101         if ( IS_DEBUG )
102         {
103             LOG.debug( "Search Result Entry Dn found : {}", searchResultEntry.getObjectName() );
104         }
105     }
106 }