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.ber.grammar.GrammarAction;
24  import org.apache.directory.api.asn1.ber.tlv.TLV;
25  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
26  import org.apache.directory.api.ldap.codec.decorators.SearchResultEntryDecorator;
27  import org.apache.directory.api.ldap.model.exception.LdapException;
28  import org.apache.directory.api.util.Strings;
29  import org.slf4j.Logger;
30  import org.slf4j.LoggerFactory;
31  
32  
33  /**
34   * The action used to store a Value to an search result entry
35   * <pre>
36   * PartialAttributeList ::= SEQUENCE OF SEQUENCE {
37   *     ...
38   *     vals SET OF AttributeValue }
39   *
40   * AttributeValue ::= OCTET STRING
41   * </pre>
42   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
43   */
44  public class StoreSearchResultAttributeValue extends GrammarAction<LdapMessageContainer<SearchResultEntryDecorator>>
45  {
46      /** The logger */
47      private static final Logger LOG = LoggerFactory.getLogger( StoreSearchResultAttributeValue.class );
48  
49      /** Speedup for logs */
50      private static final boolean IS_DEBUG = LOG.isDebugEnabled();
51  
52  
53      /**
54       * Instantiates a new search result attribute value action.
55       */
56      public StoreSearchResultAttributeValue()
57      {
58          super( "Stores AttributeValue" );
59      }
60  
61  
62      /**
63       * {@inheritDoc}
64       */
65      public void action( LdapMessageContainer<SearchResultEntryDecorator> container )
66      {
67          SearchResultEntryDecorator searchResultEntry = container.getMessage();
68  
69          TLV tlv = container.getCurrentTLV();
70  
71          // Store the value
72          Object value = null;
73  
74          try
75          {
76              if ( tlv.getLength() == 0 )
77              {
78                  searchResultEntry.addAttributeValue( "" );
79  
80                  LOG.debug( "The attribute value is null" );
81              }
82              else
83              {
84                  if ( container.isBinary( searchResultEntry.getCurrentAttribute().getId() ) )
85                  {
86                      value = tlv.getValue().getData();
87  
88                      if ( IS_DEBUG )
89                      {
90                          LOG.debug( "Attribute value {}", Strings.dumpBytes( ( byte[] ) value ) );
91                      }
92                  }
93                  else
94                  {
95                      value = Strings.utf8ToString( tlv.getValue().getData() );
96  
97                      LOG.debug( "Attribute value {}", value );
98                  }
99  
100                 searchResultEntry.addAttributeValue( value );
101             }
102         }
103         catch ( LdapException le )
104         {
105             // Just swallow the exception, it can't occur here
106         }
107 
108         // We can have an END transition
109         container.setGrammarEndAllowed( true );
110     }
111 }