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.pagedSearch;
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.PagedResults;
27
28
29 /**
30 * A container for the Paged Search Control.
31 *
32 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33 */
34 public class PagedResultsContainer extends AbstractContainer implements ControlContainer
35 {
36 /** PagedSearchControl */
37 private Control control;
38
39 /**
40 * Creates a new PagedSearchControl container object to contain a PagedResults
41 * Control.
42 *
43 * @param control A PagedResults Control to store
44 */
45 public PagedResultsContainer( Control control )
46 {
47 super();
48 setGrammar( PagedResultsGrammar.getInstance() );
49 setTransition( PagedResultsStates.START_STATE );
50 this.control = control;
51 }
52
53
54 /**
55 * Set a PagedSearchControl Object into the container. It will be completed by
56 * the ldapDecoder.
57 *
58 * @param control the PagedSearchControl to set.
59 */
60 @Override
61 public void setControl( Control control )
62 {
63 this.control = control;
64 }
65
66
67 /**
68 * @return the control
69 */
70 public PagedResults getPagedResults()
71 {
72 return ( PagedResults ) control;
73 }
74
75
76 /**
77 * Clean the container
78 */
79 @Override
80 public void clean()
81 {
82 super.clean();
83 control = null;
84 }
85 }