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
21 package org.apache.directory.api.ldap.extras.controls.vlv_impl;
22
23
24 import org.apache.directory.api.asn1.ber.AbstractContainer;
25 import org.apache.directory.api.ldap.codec.api.ControlContainer;
26 import org.apache.directory.api.ldap.extras.controls.vlv.VirtualListViewResponse;
27 import org.apache.directory.api.ldap.model.message.Control;
28
29
30 /**
31 * A container for the VLV response control.
32 *
33 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34 */
35 public class VirtualListViewResponseContainer extends AbstractContainer implements ControlContainer
36 {
37 /** The VLV response control */
38 private Control control;
39
40 /**
41 * Creates a new VirtualListViewResponseContainer object.
42 *
43 * @param control The VLV control to store
44 */
45 public VirtualListViewResponseContainer( Control control )
46 {
47 super();
48 setGrammar( VirtualListViewResponseGrammar.getInstance() );
49 setTransition( VirtualListViewResponseStates.START_STATE );
50 this.control = control;
51 }
52
53
54 /**
55 * @return The decorated VLV control
56 */
57 public VirtualListViewResponse getVirtualListViewResponse()
58 {
59 return ( VirtualListViewResponse ) control;
60 }
61
62
63 /**
64 * Set the VLV control
65 *
66 * @param control The VLV control
67 */
68 public void setControl( Control control )
69 {
70 this.control = control;
71 }
72
73
74 /**
75 * {@inheritDoc}
76 */
77 @Override
78 public void clean()
79 {
80 super.clean();
81 control = null;
82 }
83 }