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.extendedResponse;
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.ExtendedResponseDecorator;
27  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
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 Response to an ExtendedResponse
35   * <pre>
36   * ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
37   *     ...
38   *     response       [11] OCTET STRING OPTIONAL}
39   * </pre>
40   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
41   */
42  public class StoreExtendedResponseValue extends GrammarAction<LdapMessageContainer<ExtendedResponseDecorator<?>>>
43  {
44      /** The logger */
45      private static final Logger LOG = LoggerFactory.getLogger( StoreExtendedResponseValue.class );
46  
47      /** Speedup for logs */
48      private static final boolean IS_DEBUG = LOG.isDebugEnabled();
49  
50  
51      /**
52       * Instantiates a new response action.
53       */
54      public StoreExtendedResponseValue()
55      {
56          super( "Store response value" );
57      }
58  
59  
60      /**
61       * {@inheritDoc}
62       */
63      public void action( LdapMessageContainer<ExtendedResponseDecorator<?>> container ) throws DecoderException
64      {
65          // We can allocate the ExtendedResponse Object
66          ExtendedResponseDecorator<?> extendedResponse = container.getMessage();
67  
68          // Get the Value and store it in the ExtendedResponse
69          TLV tlv = container.getCurrentTLV();
70  
71          // We have to handle the special case of a 0 length matched
72          // OID
73          if ( tlv.getLength() == 0 )
74          {
75              extendedResponse.setResponseValue( Strings.EMPTY_BYTES );
76          }
77          else
78          {
79              extendedResponse.setResponseValue( tlv.getValue().getData() );
80          }
81  
82          // We can have an END transition
83          container.setGrammarEndAllowed( true );
84  
85          if ( IS_DEBUG )
86          {
87              LOG.debug( "Extended value : {}", extendedResponse.getResponseValue() );
88          }
89      }
90  }