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