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.extras.extended.ads_impl.cancel;
21  
22  
23  import org.apache.directory.api.asn1.ber.AbstractContainer;
24  import org.apache.directory.api.ldap.extras.extended.cancel.CancelRequest;
25  
26  
27  /**
28   * A container for the Cancel codec.
29   * 
30   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31   */
32  public class CancelRequestContainer extends AbstractContainer
33  {
34      /** Cancel */
35      private CancelRequest cancelRequest;
36  
37      /**
38       * Creates a new CancelContainer object. We will store one
39       * grammar, it's enough ...
40       */
41      public CancelRequestContainer()
42      {
43          super();
44          setGrammar( CancelRequestGrammar.getInstance() );
45          setTransition( CancelStatesEnum.START_STATE );
46      }
47  
48  
49      /**
50       * @return Returns the Cancel object.
51       */
52      public CancelRequest getCancelRequest()
53      {
54          return cancelRequest;
55      }
56  
57  
58      /**
59       * Set a Cancel Object into the container. It will be completed
60       * by the ldapDecoder.
61       * 
62       * @param cancelRequest the Cancel to set.
63       */
64      public void setCancelRequest( CancelRequest cancelRequest )
65      {
66          this.cancelRequest = cancelRequest;
67      }
68  
69  
70      /**
71       * Clean the container for the next decoding.
72       */
73      @Override
74      public void clean()
75      {
76          super.clean();
77          cancelRequest = null;
78      }
79  }