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.abandonRequest;
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.decorators.AbandonRequestDecorator;
32  import org.apache.directory.api.ldap.model.message.AbandonRequest;
33  import org.apache.directory.api.ldap.model.message.AbandonRequestImpl;
34  import org.apache.directory.api.util.Strings;
35  import org.slf4j.Logger;
36  import org.slf4j.LoggerFactory;
37  
38  
39  /**
40   * The action used to initialize the AbandonRequest
41   * <pre>
42   * LdapMessage ::= ... AbandonRequest ...
43   * AbandonRequest ::= [APPLICATION 16] MessageID
44   * </pre>
45   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
46   */
47  public class InitAbandonRequest extends GrammarAction<LdapMessageContainer<AbandonRequestDecorator>>
48  {
49      /** The logger */
50      private static final Logger LOG = LoggerFactory.getLogger( InitAbandonRequest.class );
51  
52      /** Speedup for logs */
53      private static final boolean IS_DEBUG = LOG.isDebugEnabled();
54  
55  
56      /**
57       * Instantiates a new action.
58       */
59      public InitAbandonRequest()
60      {
61          super( "Init Abandon Request" );
62      }
63  
64  
65      /**
66       * {@inheritDoc}
67       */
68      public void action( LdapMessageContainer<AbandonRequestDecorator> container ) throws DecoderException
69      {
70          // Create the AbandonRequest LdapMessage instance and store it in the container
71          AbandonRequest internalAbandonRequest = new AbandonRequestImpl();
72          internalAbandonRequest.setMessageId( container.getMessageId() );
73          AbandonRequestDecorator abandonRequest = new AbandonRequestDecorator(
74              container.getLdapCodecService(), internalAbandonRequest );
75          container.setMessage( abandonRequest );
76  
77          // The current TLV should be a integer
78          // We get it and store it in MessageId
79          TLV tlv = container.getCurrentTLV();
80  
81          BerValue value = tlv.getValue();
82  
83          if ( ( value == null ) || ( value.getData() == null ) )
84          {
85              String msg = I18n.err( I18n.ERR_04075 );
86              LOG.error( msg );
87  
88              // This will generate a PROTOCOL_ERROR
89              throw new DecoderException( msg );
90          }
91  
92          try
93          {
94              int abandonnedMessageId = IntegerDecoder.parse( value, 0, Integer.MAX_VALUE );
95  
96              abandonRequest.setAbandoned( abandonnedMessageId );
97  
98              if ( IS_DEBUG )
99              {
100                 LOG
101                     .debug( "AbandonMessage Id has been decoded : {}", Integer
102                         .valueOf( abandonnedMessageId ) );
103             }
104 
105             container.setGrammarEndAllowed( true );
106 
107             return;
108         }
109         catch ( IntegerDecoderException ide )
110         {
111             LOG.error( I18n
112                 .err( I18n.ERR_04076, Strings.dumpBytes( value.getData() ), ide.getMessage() ) );
113 
114             // This will generate a PROTOCOL_ERROR
115             throw new DecoderException( ide.getMessage(), ide );
116         }
117     }
118 }