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   *    https://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.request.unbind;
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.i18n.I18n;
27  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
28  import org.apache.directory.api.ldap.model.message.UnbindRequest;
29  import org.apache.directory.api.ldap.model.message.UnbindRequestImpl;
30  import org.slf4j.Logger;
31  import org.slf4j.LoggerFactory;
32  
33  
34  /**
35   * The action used to initialize the UnbindRequest :
36   * <pre>
37   * LdapMessage ::= ... UnBindRequest ...
38   * unbindRequest ::= [APPLICATION 2] NULL
39   * </pre>
40   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
41   */
42  public class InitUnbindRequest extends GrammarAction<LdapMessageContainer<UnbindRequest>>
43  {
44      /** The logger */
45      private static final Logger LOG = LoggerFactory.getLogger( InitUnbindRequest.class );
46  
47  
48      /**
49       * Instantiates a new action.
50       */
51      public InitUnbindRequest()
52      {
53          super( "Unbind Request initialization" );
54      }
55  
56  
57      /**
58       * {@inheritDoc}
59       */
60      public void action( LdapMessageContainer<UnbindRequest> container ) throws DecoderException
61      {
62          // Create the UnbindRequest LdapMessage instance and store it in the container
63          UnbindRequest unbindRequest = new UnbindRequestImpl();
64          unbindRequest.setMessageId( container.getMessageId() );
65          container.setMessage( unbindRequest );
66  
67          TLV tlv = container.getCurrentTLV();
68          int expectedLength = tlv.getLength();
69  
70          // The Length should be null
71          if ( expectedLength != 0 )
72          {
73              LOG.error( I18n.err( I18n.ERR_05130_NON_NULL_UNBIND_LENGTH, Integer.valueOf( expectedLength ) ) );
74  
75              // This will generate a PROTOCOL_ERROR
76              throw new DecoderException( I18n.err( I18n.ERR_05131_UNBIND_REQUEST_LENGTH_MUST_BE_NULL ) );
77          }
78  
79          // We can quit now
80          container.setGrammarEndAllowed( true );
81      }
82  }