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.controls.search.persistentSearch;
21  
22  
23  import org.apache.directory.api.asn1.ber.AbstractContainer;
24  import org.apache.directory.api.ldap.codec.api.ControlContainer;
25  import org.apache.directory.api.ldap.model.message.Control;
26  import org.apache.directory.api.ldap.model.message.controls.PersistentSearch;
27  
28  
29  /**
30   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31   */
32  public class PersistentSearchContainer extends AbstractContainer implements ControlContainer
33  {
34      /** PSearchControl */
35      private Control control;
36  
37      /**
38       * Creates a new PSearchControlContainer object pre-populated with a
39       * PersistentSearch control
40       *
41       * @param control The PersistentSearch Control.
42       */
43      public PersistentSearchContainer( Control control )
44      {
45          super();
46          setGrammar( PersistentSearchGrammar.getInstance() );
47          setTransition( PersistentSearchStates.START_STATE );
48          this.control = control;
49      }
50  
51  
52      /**
53       * @return Returns the persistent search decorator.
54       */
55      public PersistentSearch getPersistentSearch()
56      {
57  
58          return ( PersistentSearch ) control;
59      }
60  
61  
62      /**
63       * Set a PSearchControl Object into the container. It will be completed by
64       * the ldapDecoder.
65       * 
66       * @param control the PSearchControl to set.
67       */
68      public void setControl( Control control )
69      {
70          this.control = control;
71      }
72  
73  
74      /**
75       * Clean the container
76       */
77      @Override
78      public void clean()
79      {
80          super.clean();
81          control = null;
82      }
83  }