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
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.LdapApiService;
26 import org.apache.directory.api.ldap.extras.controls.vlv.VirtualListViewResponse;
27
28
29 /**
30 * A container for the VLV response control.
31 *
32 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33 */
34 public class VirtualListViewResponseContainer extends AbstractContainer
35 {
36 private VirtualListViewResponseDecorator control;
37
38 private LdapApiService codec;
39
40
41 /**
42 * Creates a new VirtualListViewResponseContainer object.
43 *
44 * @param codec The LDAP Service to use
45 */
46 public VirtualListViewResponseContainer( LdapApiService codec )
47 {
48 super();
49 this.codec = codec;
50 setGrammar( VirtualListViewResponseGrammar.getInstance() );
51 setTransition( VirtualListViewResponseStates.START_STATE );
52 }
53
54
55 /**
56 * Creates a new VirtualListViewResponseContainer object.
57 *
58 * @param control The VLV control to decorate
59 * @param codec The LDAP Service to use
60 */
61 public VirtualListViewResponseContainer( VirtualListViewResponseDecorator control, LdapApiService codec )
62 {
63 this( codec );
64 decorate( control );
65 }
66
67
68 /**
69 * @return The decorated VLV control
70 */
71 public VirtualListViewResponseDecorator getDecorator()
72 {
73 return control;
74 }
75
76
77 /**
78 * Decorate a VLV control
79 *
80 * @param control The VLV control to decorate
81 */
82 public void decorate( VirtualListViewResponse control )
83 {
84 if ( control instanceof VirtualListViewResponseDecorator )
85 {
86 this.control = ( VirtualListViewResponseDecorator ) control;
87 }
88 else
89 {
90 this.control = new VirtualListViewResponseDecorator( codec, control );
91 }
92 }
93
94
95 /**
96 * Set the VLV control
97 *
98 * @param control The VLV control
99 */
100 public void setVirtualListViewResponseControl( VirtualListViewResponseDecorator control )
101 {
102 this.control = control;
103 }
104
105
106 /**
107 * {@inheritDoc}
108 */
109 @Override
110 public void clean()
111 {
112 super.clean();
113 control = null;
114 }
115 }