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