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.ldapResult;
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.BerValue;
26  import org.apache.directory.api.asn1.ber.tlv.IntegerDecoder;
27  import org.apache.directory.api.asn1.ber.tlv.IntegerDecoderException;
28  import org.apache.directory.api.asn1.ber.tlv.TLV;
29  import org.apache.directory.api.i18n.I18n;
30  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
31  import org.apache.directory.api.ldap.codec.api.MessageDecorator;
32  import org.apache.directory.api.ldap.model.message.LdapResult;
33  import org.apache.directory.api.ldap.model.message.Message;
34  import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
35  import org.apache.directory.api.ldap.model.message.ResultResponse;
36  import org.apache.directory.api.util.Strings;
37  import org.slf4j.Logger;
38  import org.slf4j.LoggerFactory;
39  
40  
41  /**
42   * The action used to set the LdapResult result code.
43   * <pre>
44   * LDAPResult ::= SEQUENCE {
45   *     resultCode ENUMERATED {
46   *         ...
47   * </pre>
48   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
49   */
50  public class StoreResultCode extends GrammarAction<LdapMessageContainer<MessageDecorator<? extends Message>>>
51  {
52      /** The logger */
53      private static final Logger LOG = LoggerFactory.getLogger( StoreResultCode.class );
54  
55      /** Speedup for logs */
56      private static final boolean IS_DEBUG = LOG.isDebugEnabled();
57  
58  
59      /**
60       * Instantiates a new result code action.
61       */
62      public StoreResultCode()
63      {
64          super( "Store resultCode" );
65      }
66  
67  
68      /**
69       * {@inheritDoc}
70       */
71      public void action( LdapMessageContainer<MessageDecorator<? extends Message>> container ) throws DecoderException
72      {
73          // The current TLV should be a integer
74          // We get it and store it in MessageId
75          TLV tlv = container.getCurrentTLV();
76  
77          BerValue value = tlv.getValue();
78          ResultCodeEnum resultCode = ResultCodeEnum.SUCCESS;
79  
80          try
81          {
82              resultCode = ResultCodeEnum.getResultCode( IntegerDecoder.parse( value, 0,
83                  ResultCodeEnum.E_SYNC_REFRESH_REQUIRED
84                      .getResultCode() ) );
85          }
86          catch ( IntegerDecoderException ide )
87          {
88              LOG.error( I18n.err( I18n.ERR_04018, Strings.dumpBytes( value.getData() ), ide.getMessage() ) );
89  
90              throw new DecoderException( ide.getMessage() );
91          }
92  
93          if ( IS_DEBUG )
94          {
95              LOG.debug( "The result code is set to " + resultCode );
96          }
97  
98          ResultResponse response = ( ResultResponse ) container.getMessage();
99          LdapResult ldapResult = response.getLdapResult();
100         ldapResult.setResultCode( resultCode );
101     }
102 }